Class CapacityReservationEndpointsAssociation

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.CapacityReservationEndpointsAssociation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityReservationEndpointsAssociation.Builder,CapacityReservationEndpointsAssociation>

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

The association between the SageMaker AI endpoints in your account and a SageMaker Capacity Reservation, through one ML capacity reservation. To use the reserved instances for an endpoint, specify the ML capacity reservation ARN in the MlReservationArn field of ProductionVariantCapacityReservationConfig when you call CreateEndpointConfig.

See Also:
  • Method Details

    • mlReservationId

      public final String mlReservationId()

      The name of the ML capacity reservation. The name is the last part of the ML capacity reservation ARN.

      Returns:
      The name of the ML capacity reservation. The name is the last part of the ML capacity reservation ARN.
    • status

      public final CapacityReservationOptInStatus status()

      The status of the association. Valid values:

      Pending

      SageMaker AI is adding or removing the association.

      Active

      The resources are associated with the SageMaker Capacity Reservation and can use its instances.

      Inactive

      The resources are not associated with the SageMaker Capacity Reservation.

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

      Returns:
      The status of the association. Valid values:

      Pending

      SageMaker AI is adding or removing the association.

      Active

      The resources are associated with the SageMaker Capacity Reservation and can use its instances.

      Inactive

      The resources are not associated with the SageMaker Capacity Reservation.

      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the association. Valid values:

      Pending

      SageMaker AI is adding or removing the association.

      Active

      The resources are associated with the SageMaker Capacity Reservation and can use its instances.

      Inactive

      The resources are not associated with the SageMaker Capacity Reservation.

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

      Returns:
      The status of the association. Valid values:

      Pending

      SageMaker AI is adding or removing the association.

      Active

      The resources are associated with the SageMaker Capacity Reservation and can use its instances.

      Inactive

      The resources are not associated with the SageMaker Capacity Reservation.

      See Also:
    • matchCriteria

      public final CapacityReservationMatchCriteria matchCriteria()

      How endpoints in your account match the ML capacity reservation. Valid values:

      Open

      Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.

      Targeted

      An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.

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

      Returns:
      How endpoints in your account match the ML capacity reservation. Valid values:

      Open

      Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.

      Targeted

      An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.

      See Also:
    • matchCriteriaAsString

      public final String matchCriteriaAsString()

      How endpoints in your account match the ML capacity reservation. Valid values:

      Open

      Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.

      Targeted

      An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.

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

      Returns:
      How endpoints in your account match the ML capacity reservation. Valid values:

      Open

      Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.

      Targeted

      An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.

      See Also:
    • endpointSharing

      public final CapacityReservationEndpointSharing endpointSharing()

      Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:

      SingleEndpoint

      Only one endpoint can use the ML capacity reservation.

      MultipleEndpoints

      Multiple endpoints can use the ML capacity reservation.

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

      Returns:
      Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:

      SingleEndpoint

      Only one endpoint can use the ML capacity reservation.

      MultipleEndpoints

      Multiple endpoints can use the ML capacity reservation.

      See Also:
    • endpointSharingAsString

      public final String endpointSharingAsString()

      Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:

      SingleEndpoint

      Only one endpoint can use the ML capacity reservation.

      MultipleEndpoints

      Multiple endpoints can use the ML capacity reservation.

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

      Returns:
      Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:

      SingleEndpoint

      Only one endpoint can use the ML capacity reservation.

      MultipleEndpoints

      Multiple endpoints can use the ML capacity reservation.

      See Also:
    • mlReservationArn

      public final String mlReservationArn()

      The Amazon Resource Name (ARN) of the ML capacity reservation. Specify this ARN in CreateEndpointConfig to use the reserved instances for an endpoint. For a new ML capacity reservation, this value is returned when the status is Active.

      Returns:
      The Amazon Resource Name (ARN) of the ML capacity reservation. Specify this ARN in CreateEndpointConfig to use the reserved instances for an endpoint. For a new ML capacity reservation, this value is returned when the status is Active.
    • failureReason

      public final String failureReason()

      The reason that the most recent attempt to add or remove the association failed. This value is returned only when the most recent attempt failed. After a failure to add the association, the status is Inactive. After a failure to remove the association, the status is Active.

      Returns:
      The reason that the most recent attempt to add or remove the association failed. This value is returned only when the most recent attempt failed. After a failure to add the association, the status is Inactive. After a failure to remove the association, the status is Active.
    • associatedTime

      public final Instant associatedTime()

      The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.

      Returns:
      The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.
    • 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<CapacityReservationEndpointsAssociation.Builder,CapacityReservationEndpointsAssociation>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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