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

Class OriginGroup

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.OriginGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OriginGroup.Builder,OriginGroup>

@Generated("software.amazon.awssdk:codegen")
public final class OriginGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OriginGroup.Builder,OriginGroup>

An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.

Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginGroup.Builder

Method Summary

Modifier and Type	Method	Description
static OriginGroup.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final OriginGroupFailoverCriteria	failoverCriteria()	A complex type that contains information about the failover criteria for an origin group.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	id()	The origin group's ID.
final OriginGroupMembers	members()	A complex type that contains information about the origins in an origin group.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
final OriginGroupSelectionCriteria	selectionCriteria()	The selection criteria for the origin group.
final String	selectionCriteriaAsString()	The selection criteria for the origin group.
static Class<? extends OriginGroup.Builder>	serializableBuilderClass()
OriginGroup.Builder	toBuilder()
final 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 Details

id

public final String id()

The origin group's ID.

Returns:

The origin group's ID.

failoverCriteria

public final OriginGroupFailoverCriteria failoverCriteria()

A complex type that contains information about the failover criteria for an origin group.

Returns:

A complex type that contains information about the failover criteria for an origin group.

members

public final OriginGroupMembers members()

A complex type that contains information about the origins in an origin group.

Returns:

A complex type that contains information about the origins in an origin group.

selectionCriteria

public final OriginGroupSelectionCriteria selectionCriteria()

The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront Developer Guide.

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

Returns:

The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront Developer Guide.

See Also:

• OriginGroupSelectionCriteria

selectionCriteriaAsString

public final String selectionCriteriaAsString()

The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront Developer Guide.

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

Returns:

The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront Developer Guide.

See Also:

• OriginGroupSelectionCriteria

toBuilder

public OriginGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OriginGroup.Builder,OriginGroup>

builder

public static OriginGroup.Builder builder()

serializableBuilderClass

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