Interface OriginAccessControlConfig.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<OriginAccessControlConfig.Builder,
,OriginAccessControlConfig> SdkBuilder<OriginAccessControlConfig.Builder,
,OriginAccessControlConfig> SdkPojo
- Enclosing class:
OriginAccessControlConfig
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) A description of the origin access control.A name to identify the origin access control.originAccessControlOriginType
(String originAccessControlOriginType) The type of origin that this origin access control is for.originAccessControlOriginType
(OriginAccessControlOriginTypes originAccessControlOriginType) The type of origin that this origin access control is for.signingBehavior
(String signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).signingBehavior
(OriginAccessControlSigningBehaviors signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).signingProtocol
(String signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.signingProtocol
(OriginAccessControlSigningProtocols signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
A name to identify the origin access control. You can specify up to 64 characters.
- Parameters:
name
- A name to identify the origin access control. You can specify up to 64 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the origin access control.
- Parameters:
description
- A description of the origin access control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingProtocol
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.- Parameters:
signingProtocol
- The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value issigv4
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
signingProtocol
OriginAccessControlConfig.Builder signingProtocol(OriginAccessControlSigningProtocols signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.- Parameters:
signingProtocol
- The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value issigv4
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
signingBehavior
- Specifies which requests CloudFront signs (adds authentication information to). Specifyalways
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
signingBehavior
OriginAccessControlConfig.Builder signingBehavior(OriginAccessControlSigningBehaviors 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.
- Parameters:
signingBehavior
- Specifies which requests CloudFront signs (adds authentication information to). Specifyalways
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
originAccessControlOriginType
OriginAccessControlConfig.Builder originAccessControlOriginType(String originAccessControlOriginType) The type of origin that this origin access control is for.
- Parameters:
originAccessControlOriginType
- The type of origin that this origin access control is for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
originAccessControlOriginType
OriginAccessControlConfig.Builder originAccessControlOriginType(OriginAccessControlOriginTypes originAccessControlOriginType) The type of origin that this origin access control is for.
- Parameters:
originAccessControlOriginType
- The type of origin that this origin access control is for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-