AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cloudfront.getOriginAccessControl

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. This makes it possible to block public access to the origin, allowing viewers (users) to access the origin’s content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an origin in the Amazon CloudFront Developer Guide.

Using getOriginAccessControl

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOriginAccessControl(args: GetOriginAccessControlArgs, opts?: InvokeOptions): Promise<GetOriginAccessControlResult>
function getOriginAccessControlOutput(args: GetOriginAccessControlOutputArgs, opts?: InvokeOptions): Output<GetOriginAccessControlResult>

def get_origin_access_control(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetOriginAccessControlResult
def get_origin_access_control_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetOriginAccessControlResult]

func LookupOriginAccessControl(ctx *Context, args *LookupOriginAccessControlArgs, opts ...InvokeOption) (*LookupOriginAccessControlResult, error)
func LookupOriginAccessControlOutput(ctx *Context, args *LookupOriginAccessControlOutputArgs, opts ...InvokeOption) LookupOriginAccessControlResultOutput

> Note: This function is named LookupOriginAccessControl in the Go SDK.

public static class GetOriginAccessControl 
{
    public static Task<GetOriginAccessControlResult> InvokeAsync(GetOriginAccessControlArgs args, InvokeOptions? opts = null)
    public static Output<GetOriginAccessControlResult> Invoke(GetOriginAccessControlInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOriginAccessControlResult> getOriginAccessControl(GetOriginAccessControlArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:cloudfront:getOriginAccessControl
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The unique identifier of the origin access control.

Id string: The unique identifier of the origin access control.

id String: The unique identifier of the origin access control.

id string: The unique identifier of the origin access control.

id str: The unique identifier of the origin access control.

id String: The unique identifier of the origin access control.

getOriginAccessControl Result

The following output properties are available:

Id string: The unique identifier of the origin access control.
OriginAccessControlConfig Pulumi.AwsNative.CloudFront.Outputs.OriginAccessControlConfig: The origin access control.

Id string: The unique identifier of the origin access control.
OriginAccessControlConfig OriginAccessControlConfig: The origin access control.

id String: The unique identifier of the origin access control.
originAccessControlConfig OriginAccessControlConfig: The origin access control.

id string: The unique identifier of the origin access control.
originAccessControlConfig OriginAccessControlConfig: The origin access control.

id str: The unique identifier of the origin access control.
origin_access_control_config OriginAccessControlConfig: The origin access control.

id String: The unique identifier of the origin access control.
originAccessControlConfig Property Map: The origin access control.

Supporting Types

OriginAccessControlConfig

Name string

A name to identify the origin access control. You can specify up to 64 characters.

OriginAccessControlOriginType string

The type of origin that this origin access control is for.

SigningBehavior string

Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide. This field can have one of the following values:

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

SigningProtocol string

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

Description string

A description of the origin access control.

Name string

A name to identify the origin access control. You can specify up to 64 characters.

OriginAccessControlOriginType string

The type of origin that this origin access control is for.

SigningBehavior string

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

SigningProtocol string

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

Description string

A description of the origin access control.

name String

A name to identify the origin access control. You can specify up to 64 characters.

originAccessControlOriginType String

The type of origin that this origin access control is for.

signingBehavior String

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

signingProtocol String

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

description String

A description of the origin access control.

name string

A name to identify the origin access control. You can specify up to 64 characters.

originAccessControlOriginType string

The type of origin that this origin access control is for.

signingBehavior string

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

signingProtocol string

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

description string

A description of the origin access control.

name str

A name to identify the origin access control. You can specify up to 64 characters.

origin_access_control_origin_type str

The type of origin that this origin access control is for.

signing_behavior str

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

signing_protocol str

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

description str

A description of the origin access control.

name String

A name to identify the origin access control. You can specify up to 64 characters.

originAccessControlOriginType String

The type of origin that this origin access control is for.

signingBehavior String

always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

signingProtocol String