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

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

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

A CloudFront origin access control.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface OriginAccessControlSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OriginAccessControlSummary.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`	`id()`	The unique identifier of the origin access control.
`String`	`name()`	A unique name that identifies 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 OriginAccessControlSummary.Builder>`	`serializableBuilderClass()`
`OriginAccessControlSigningBehaviors`	`signingBehavior()`	A value that specifies which requests CloudFront signs (adds authentication information to).
`String`	`signingBehaviorAsString()`	A value that specifies which requests CloudFront signs (adds authentication information to).
`OriginAccessControlSigningProtocols`	`signingProtocol()`	The signing protocol of the origin access control.
`String`	`signingProtocolAsString()`	The signing protocol of the origin access control.
`OriginAccessControlSummary.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
  - id
```
public final String id()
```
    The unique identifier of the origin access control.
    
    Returns:
    
    The unique identifier of the origin access control.
  - description
```
public final String description()
```
    A description of the origin access control.
    
    Returns:
    
    A description of the origin access control.
  - name
```
public final String name()
```
    A unique name that identifies the origin access control.
    
    Returns:
    
    A unique name that identifies the origin access control.
  - signingProtocol
```
public final OriginAccessControlSigningProtocols signingProtocol()
```
    The signing protocol of the origin access control. The signing protocol 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. The signing protocol 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. The signing protocol 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. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
    
    See Also:
    
    OriginAccessControlSigningProtocols
  - signingBehavior
```
public final OriginAccessControlSigningBehaviors signingBehavior()
```
    A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
    
    never – CloudFront doesn't sign any origin requests.
    
    always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.
    
    no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.
    
    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:
    
    A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
    
    never – CloudFront doesn't sign any origin requests.
    
    always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.
    
    no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.
    
    See Also:
    
    OriginAccessControlSigningBehaviors
  - signingBehaviorAsString
```
public final String signingBehaviorAsString()
```
    A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
    
    never – CloudFront doesn't sign any origin requests.
    
    always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.
    
    no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.
    
    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:
    
    A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
    
    never – CloudFront doesn't sign any origin requests.
    
    always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.
    
    no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.
    
    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 OriginAccessControlSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OriginAccessControlSummary.Builder,OriginAccessControlSummary>
  - builder
```
public static OriginAccessControlSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OriginAccessControlSummary.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 OriginAccessControlSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

description

name

signingProtocol

signingProtocolAsString

signingBehavior

signingBehaviorAsString

originAccessControlOriginType

originAccessControlOriginTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields