java.lang.Object
- software.amazon.awssdk.services.cloudfront.model.OriginAccessControlConfig

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>

@Generated("software.amazon.awssdk:codegen")
public final class OriginAccessControlConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>

A CloudFront origin access control configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface OriginAccessControlConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OriginAccessControlConfig.Builder`	`builder()`
`String`	`description()`	A description of the origin access control.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()`	A name to identify the origin access control.
`OriginAccessControlOriginTypes`	`originAccessControlOriginType()`	The type of origin that this origin access control is for.
`String`	`originAccessControlOriginTypeAsString()`	The type of origin that this origin access control is for.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OriginAccessControlConfig.Builder>`	`serializableBuilderClass()`
`OriginAccessControlSigningBehaviors`	`signingBehavior()`	Specifies which requests CloudFront signs (adds authentication information to).
`String`	`signingBehaviorAsString()`	Specifies which requests CloudFront signs (adds authentication information to).
`OriginAccessControlSigningProtocols`	`signingProtocol()`	The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
`String`	`signingProtocolAsString()`	The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
`OriginAccessControlConfig.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    A name to identify the origin access control. You can specify up to 64 characters.
    
    Returns:
    
    A name to identify the origin access control. You can specify up to 64 characters.
  - description
```
public final String description()
```
    A description of the origin access control.
    
    Returns:
    
    A description of the origin access control.
  - signingProtocol
```
public final OriginAccessControlSigningProtocols signingProtocol()
```
    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
    
    If the service returns an enum value that is not available in the current SDK version, signingProtocol will return OriginAccessControlSigningProtocols.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingProtocolAsString().
    
    Returns:
    
    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
    
    See Also:
    
    OriginAccessControlSigningProtocols
  - signingProtocolAsString
```
public final String signingProtocolAsString()
```
    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
    
    If the service returns an enum value that is not available in the current SDK version, signingProtocol will return OriginAccessControlSigningProtocols.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingProtocolAsString().
    
    Returns:
    
    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
    
    See Also:
    
    OriginAccessControlSigningProtocols
  - signingBehavior
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, signingBehavior will return OriginAccessControlSigningBehaviors.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingBehaviorAsString().
    Returns:
    
    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.
    
    See Also:
    
    OriginAccessControlSigningBehaviors
  - signingBehaviorAsString
```
public final String signingBehaviorAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, signingBehavior will return OriginAccessControlSigningBehaviors.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingBehaviorAsString().
    Returns:
    
    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.
    
    See Also:
    
    OriginAccessControlSigningBehaviors
  - originAccessControlOriginType
```
public final OriginAccessControlOriginTypes originAccessControlOriginType()
```
    The type of origin that this origin access control is for.
    
    If the service returns an enum value that is not available in the current SDK version, originAccessControlOriginType will return OriginAccessControlOriginTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAccessControlOriginTypeAsString().
    
    Returns:
    
    The type of origin that this origin access control is for.
    
    See Also:
    
    OriginAccessControlOriginTypes
  - originAccessControlOriginTypeAsString
```
public final String originAccessControlOriginTypeAsString()
```
    The type of origin that this origin access control is for.
    
    If the service returns an enum value that is not available in the current SDK version, originAccessControlOriginType will return OriginAccessControlOriginTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAccessControlOriginTypeAsString().
    
    Returns:
    
    The type of origin that this origin access control is for.
    
    See Also:
    
    OriginAccessControlOriginTypes
  - toBuilder
```
public OriginAccessControlConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>
  - builder
```
public static OriginAccessControlConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OriginAccessControlConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class OriginAccessControlConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

signingProtocol

signingProtocolAsString

signingBehavior

signingBehaviorAsString

originAccessControlOriginType

originAccessControlOriginTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields