software.amazon.awssdk.services.cloudfront.model

Interface OriginAccessControlConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>, SdkBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>, SdkPojo

Enclosing class:

OriginAccessControlConfig

public static interface OriginAccessControlConfig.Builder
extends SdkPojo, CopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>

Method Summary

Modifier and Type	Method and Description
OriginAccessControlConfig.Builder	description(String description) A description of the origin access control.
OriginAccessControlConfig.Builder	name(String name) A name to identify the origin access control.
OriginAccessControlConfig.Builder	originAccessControlOriginType(OriginAccessControlOriginTypes originAccessControlOriginType) The type of origin that this origin access control is for.
OriginAccessControlConfig.Builder	originAccessControlOriginType(String originAccessControlOriginType) The type of origin that this origin access control is for.
OriginAccessControlConfig.Builder	signingBehavior(OriginAccessControlSigningBehaviors signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).
OriginAccessControlConfig.Builder	signingBehavior(String signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).
OriginAccessControlConfig.Builder	signingProtocol(OriginAccessControlSigningProtocols signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
OriginAccessControlConfig.Builder	signingProtocol(String signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

OriginAccessControlConfig.Builder name(String name)

A name to identify the origin access control.

Parameters:

name - A name to identify the origin access control.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

OriginAccessControlConfig.Builder description(String 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

OriginAccessControlConfig.Builder signingProtocol(String 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 is sigv4.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OriginAccessControlSigningProtocols, OriginAccessControlSigningProtocols

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 is sigv4.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OriginAccessControlSigningProtocols, OriginAccessControlSigningProtocols

signingBehavior

OriginAccessControlConfig.Builder signingBehavior(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OriginAccessControlSigningBehaviors, OriginAccessControlSigningBehaviors

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OriginAccessControlSigningBehaviors, OriginAccessControlSigningBehaviors

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:

OriginAccessControlOriginTypes, OriginAccessControlOriginTypes

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:

OriginAccessControlOriginTypes, OriginAccessControlOriginTypes