Amazonka.CloudFront.Types.OriginAccessControlConfig

Documentation

data OriginAccessControlConfig

A CloudFront origin access control configuration.

See: newOriginAccessControlConfig smart constructor.

Constructors

OriginAccessControlConfig'

Fields

• description :: Maybe Text

  A description of the origin access control.

• name :: Text

  A name to identify the origin access control.

• signingProtocol :: OriginAccessControlSigningProtocols

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

• signingBehavior :: OriginAccessControlSigningBehaviors

  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.__
• originAccessControlOriginType :: OriginAccessControlOriginTypes

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

Instances

FromXML OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

parseXML :: [Node] -> Either String OriginAccessControlConfig

ToXML OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

toXML :: OriginAccessControlConfig -> XML

Generic OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Associated Types

type Rep OriginAccessControlConfig :: Type -> Type

Methods

from :: OriginAccessControlConfig -> Rep OriginAccessControlConfig x

to :: Rep OriginAccessControlConfig x -> OriginAccessControlConfig

Read OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

readsPrec :: Int -> ReadS OriginAccessControlConfig

readList :: ReadS [OriginAccessControlConfig]

readPrec :: ReadPrec OriginAccessControlConfig

readListPrec :: ReadPrec [OriginAccessControlConfig]

Show OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

showsPrec :: Int -> OriginAccessControlConfig -> ShowS

show :: OriginAccessControlConfig -> String

showList :: [OriginAccessControlConfig] -> ShowS

NFData OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

rnf :: OriginAccessControlConfig -> ()

Eq OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

(==) :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool

(/=) :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool

Hashable OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

Methods

hashWithSalt :: Int -> OriginAccessControlConfig -> Int

hash :: OriginAccessControlConfig -> Int

type Rep OriginAccessControlConfig

Defined in Amazonka.CloudFront.Types.OriginAccessControlConfig

type Rep OriginAccessControlConfig = D1 ('MetaData "OriginAccessControlConfig" "Amazonka.CloudFront.Types.OriginAccessControlConfig" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "OriginAccessControlConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "signingProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OriginAccessControlSigningProtocols) :*: (S1 ('MetaSel ('Just "signingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OriginAccessControlSigningBehaviors) :*: S1 ('MetaSel ('Just "originAccessControlOriginType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OriginAccessControlOriginTypes)))))

newOriginAccessControlConfig

Arguments

:: Text

$sel:name:OriginAccessControlConfig'

-> OriginAccessControlSigningProtocols

$sel:signingProtocol:OriginAccessControlConfig'

-> OriginAccessControlSigningBehaviors

$sel:signingBehavior:OriginAccessControlConfig'

-> OriginAccessControlOriginTypes

$sel:originAccessControlOriginType:OriginAccessControlConfig'

-> OriginAccessControlConfig

Create a value of OriginAccessControlConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:OriginAccessControlConfig', originAccessControlConfig_description - A description of the origin access control.

$sel:name:OriginAccessControlConfig', originAccessControlConfig_name - A name to identify the origin access control.

$sel:signingProtocol:OriginAccessControlConfig', originAccessControlConfig_signingProtocol - The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

$sel:signingBehavior:OriginAccessControlConfig', originAccessControlConfig_signingBehavior - 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.__

$sel:originAccessControlOriginType:OriginAccessControlConfig', originAccessControlConfig_originAccessControlOriginType - The type of origin that this origin access control is for. The only valid value is s3.

originAccessControlConfig_description :: Lens' OriginAccessControlConfig (Maybe Text)

A description of the origin access control.

originAccessControlConfig_name :: Lens' OriginAccessControlConfig Text

A name to identify the origin access control.

originAccessControlConfig_signingProtocol :: Lens' OriginAccessControlConfig OriginAccessControlSigningProtocols

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

originAccessControlConfig_signingBehavior :: Lens' OriginAccessControlConfig OriginAccessControlSigningBehaviors

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.__

originAccessControlConfig_originAccessControlOriginType :: Lens' OriginAccessControlConfig OriginAccessControlOriginTypes

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