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:

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

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

    • toBuilder

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

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