Package software.amazon.awssdk.services.cloudfront.model

Class CustomOriginConfig

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

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

See Also:

  • Method Details

    • httpPort

      public final Integer httpPort()

      The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

      Returns:
      The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

    • httpsPort

      public final Integer httpsPort()

      The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

      Returns:
      The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

    • originProtocolPolicy

      public final OriginProtocolPolicy originProtocolPolicy()

      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

      • http-only – CloudFront always uses HTTP to connect to the origin.

      • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.

      • https-only – CloudFront always uses HTTPS to connect to the origin.

      If the service returns an enum value that is not available in the current SDK version, originProtocolPolicy will return OriginProtocolPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originProtocolPolicyAsString().

      Returns:
      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

      • http-only – CloudFront always uses HTTP to connect to the origin.

      • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.

      • https-only – CloudFront always uses HTTPS to connect to the origin.

      See Also:

    • originProtocolPolicyAsString

      public final String originProtocolPolicyAsString()

      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

      • http-only – CloudFront always uses HTTP to connect to the origin.

      • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.

      • https-only – CloudFront always uses HTTPS to connect to the origin.

      If the service returns an enum value that is not available in the current SDK version, originProtocolPolicy will return OriginProtocolPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originProtocolPolicyAsString().

      Returns:
      Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

      • http-only – CloudFront always uses HTTP to connect to the origin.

      • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.

      • https-only – CloudFront always uses HTTPS to connect to the origin.

      See Also:

    • originSslProtocols

      public final OriginSslProtocols originSslProtocols()

      Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

      For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.

      Returns:
      Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

      For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.

    • originReadTimeout

      public final Integer originReadTimeout()

      Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

      For more information, see Response timeout in the Amazon CloudFront Developer Guide.

      Returns:
      Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

      For more information, see Response timeout in the Amazon CloudFront Developer Guide.

    • originKeepaliveTimeout

      public final Integer originKeepaliveTimeout()

      Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

      For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

      Returns:
      Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

      For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

    • ipAddressType

      public final IpAddressType ipAddressType()

      Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.
      See Also:

    • originMtlsConfig

      public final OriginMtlsConfig originMtlsConfig()

      Configures mutual TLS authentication between CloudFront and your origin server.

      Returns:
      Configures mutual TLS authentication between CloudFront and your origin server.

    • toBuilder

      public CustomOriginConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CustomOriginConfig.Builder,CustomOriginConfig>

    • builder

      public static CustomOriginConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo