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

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

Overview

A CloudFront origin access control configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the origin access control.

Returns:

  • (String)


8034
8035
8036
8037
8038
8039
8040
8041
8042
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 8034

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

#nameString

A name to identify the origin access control.

Returns:

  • (String)


8034
8035
8036
8037
8038
8039
8040
8041
8042
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 8034

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

#origin_access_control_origin_typeString

The type of origin that this origin access control is for. The only valid value is s3.

Returns:

  • (String)


8034
8035
8036
8037
8038
8039
8040
8041
8042
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 8034

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

#signing_behaviorString

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.

Returns:

  • (String)


8034
8035
8036
8037
8038
8039
8040
8041
8042
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 8034

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

#signing_protocolString

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

Returns:

  • (String)


8034
8035
8036
8037
8038
8039
8040
8041
8042
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 8034

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