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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomOriginConfig.Builder

Method Summary

Modifier and Type	Method	Description
static CustomOriginConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	httpPort()	The HTTP port that CloudFront uses to connect to the origin.
Integer	httpsPort()	The HTTPS port that CloudFront uses to connect to the origin.
Integer	originKeepaliveTimeout()	Specifies how long, in seconds, CloudFront persists its connection to the origin.
OriginProtocolPolicy	originProtocolPolicy()	Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
String	originProtocolPolicyAsString()	Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
Integer	originReadTimeout()	Specifies how long, in seconds, CloudFront waits for a response from the origin.
OriginSslProtocols	originSslProtocols()	Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomOriginConfig.Builder>	serializableBuilderClass()
CustomOriginConfig.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

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:

OriginProtocolPolicy

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:

OriginProtocolPolicy

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 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Origin 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 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Origin 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 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Origin Keep-alive Timeout 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 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

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