Class S3OriginConfig

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.S3OriginConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3OriginConfig.Builder,S3OriginConfig>
@Generated("software.amazon.awssdk:codegen") public final class S3OriginConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3OriginConfig.Builder,S3OriginConfig>

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.

See Also:

  • Method Details

    • originAccessIdentity

      public final String originAccessIdentity()

      If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.

      The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

      origin-access-identity/cloudfront/ID-of-origin-access-identity

      The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

      If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

      To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

      To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

      For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

      Returns:

      If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.

      The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

      origin-access-identity/cloudfront/ID-of-origin-access-identity

      The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

      If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

      To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

      To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

      For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

    • toBuilder

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

    • builder

      public static S3OriginConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3OriginConfig.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.