Class OriginAccessControlConfig

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public OriginAccessControlConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OriginAccessControlConfig.Builder,OriginAccessControlConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.