Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data OriginAccessControlConfig = OriginAccessControlConfig' {}
- newOriginAccessControlConfig :: Text -> OriginAccessControlSigningProtocols -> OriginAccessControlSigningBehaviors -> OriginAccessControlOriginTypes -> OriginAccessControlConfig
- originAccessControlConfig_description :: Lens' OriginAccessControlConfig (Maybe Text)
- originAccessControlConfig_name :: Lens' OriginAccessControlConfig Text
- originAccessControlConfig_signingProtocol :: Lens' OriginAccessControlConfig OriginAccessControlSigningProtocols
- originAccessControlConfig_signingBehavior :: Lens' OriginAccessControlConfig OriginAccessControlSigningBehaviors
- originAccessControlConfig_originAccessControlOriginType :: Lens' OriginAccessControlConfig OriginAccessControlOriginTypes
Documentation
data OriginAccessControlConfig Source #
A CloudFront origin access control configuration.
See: newOriginAccessControlConfig
smart constructor.
OriginAccessControlConfig' | |
|
Instances
newOriginAccessControlConfig Source #
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 theAuthorization
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 theAuthorization
header, then CloudFront signs the origin request. If the viewer request contains theAuthorization
header, then CloudFront doesn't sign the origin request and instead passes along theAuthorization
header from the viewer request. __WARNING: To pass along theAuthorization
header from the viewer request, you must add theAuthorization
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) Source #
A description of the origin access control.
originAccessControlConfig_name :: Lens' OriginAccessControlConfig Text Source #
A name to identify the origin access control.
originAccessControlConfig_signingProtocol :: Lens' OriginAccessControlConfig OriginAccessControlSigningProtocols Source #
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 Source #
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 theAuthorization
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 theAuthorization
header, then CloudFront signs the origin request. If the viewer request contains theAuthorization
header, then CloudFront doesn't sign the origin request and instead passes along theAuthorization
header from the viewer request. __WARNING: To pass along theAuthorization
header from the viewer request, you must add theAuthorization
header to a cache policy for all cache behaviors that use origins associated with this origin access control.__
originAccessControlConfig_originAccessControlOriginType :: Lens' OriginAccessControlConfig OriginAccessControlOriginTypes Source #
The type of origin that this origin access control is for. The only
valid value is s3
.