Class OriginAccessControlSummary

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:

  • Method Details

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

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

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

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

    • 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 OriginAccessControlSummary.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<OriginAccessControlSummary.Builder,OriginAccessControlSummary>
      Returns:
      a builder for type T

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