Class Subscription

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

Information about the Shield Advanced subscription for an account.

See Also:

  • Method Details

    • startTime

      public final Instant startTime()

      The start time of the subscription, in Unix time in seconds.

      Returns:
      The start time of the subscription, in Unix time in seconds.

    • endTime

      public final Instant endTime()

      The date and time your subscription will end.

      Returns:
      The date and time your subscription will end.

    • timeCommitmentInSeconds

      public final Long timeCommitmentInSeconds()

      The length, in seconds, of the Shield Advanced subscription for the account.

      Returns:
      The length, in seconds, of the Shield Advanced subscription for the account.

    • autoRenew

      public final AutoRenew autoRenew()

      If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

      When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

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

      Returns:
      If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

      When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

      See Also:

    • autoRenewAsString

      public final String autoRenewAsString()

      If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

      When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

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

      Returns:
      If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

      When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

      See Also:

    • hasLimits

      public final boolean hasLimits()
      For responses, this returns true if the service returned a value for the Limits property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • limits

      public final List<Limit> limits()

      Specifies how many protections of a given type you can create.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLimits() method.

      Returns:
      Specifies how many protections of a given type you can create.

    • proactiveEngagementStatus

      public final ProactiveEngagementStatus proactiveEngagementStatus()

      If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

      If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

      If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

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

      Returns:
      If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

      If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

      If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

      See Also:

    • proactiveEngagementStatusAsString

      public final String proactiveEngagementStatusAsString()

      If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

      If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

      If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

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

      Returns:
      If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

      If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

      If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

      See Also:

    • subscriptionLimits

      public final SubscriptionLimits subscriptionLimits()

      Limits settings for your subscription.

      Returns:
      Limits settings for your subscription.

    • subscriptionArn

      public final String subscriptionArn()

      The ARN (Amazon Resource Name) of the subscription.

      Returns:
      The ARN (Amazon Resource Name) of the subscription.

    • toBuilder

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

    • builder

      public static Subscription.Builder builder()

    • serializableBuilderClass

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