Class: Aws::CloudFront::Types::OriginAccessControlConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

A CloudFront origin access control configuration.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the origin access control.

Returns:

  • (String) 


8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8916

class OriginAccessControlConfig < Struct.new(
  :name,
  :description,
  :signing_protocol,
  :signing_behavior,
  :origin_access_control_origin_type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8916

class OriginAccessControlConfig < Struct.new(
  :name,
  :description,
  :signing_protocol,
  :signing_behavior,
  :origin_access_control_origin_type)
  SENSITIVE = []
  include Aws::Structure
end

#origin_access_control_origin_type ⇒ String

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

Returns:

  • (String) 


8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8916

class OriginAccessControlConfig < Struct.new(
  :name,
  :description,
  :signing_protocol,
  :signing_behavior,
  :origin_access_control_origin_type)
  SENSITIVE = []
  include Aws::Structure
end

#signing_behavior ⇒ 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][2

    for all cache behaviors that use origins

    associated with this origin access control.**

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html

Returns:

  • (String) 


8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8916

class OriginAccessControlConfig < Struct.new(
  :name,
  :description,
  :signing_protocol,
  :signing_behavior,
  :origin_access_control_origin_type)
  SENSITIVE = []
  include Aws::Structure
end

#signing_protocol ⇒ String

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

Returns:

  • (String) 


8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8916

class OriginAccessControlConfig < Struct.new(
  :name,
  :description,
  :signing_protocol,
  :signing_behavior,
  :origin_access_control_origin_type)
  SENSITIVE = []
  include Aws::Structure
end