Class CreateSubscriptionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pricingplanmanager.model.PricingPlanManagerRequest
software.amazon.awssdk.services.pricingplanmanager.model.CreateSubscriptionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSubscriptionRequest extends PricingPlanManagerRequest implements ToCopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>

  • Method Details

    • planFamily

      public final String planFamily()

      The pricing plan family to subscribe to, such as CloudFront.

      Returns:
      The pricing plan family to subscribe to, such as CloudFront.

    • planTier

      public final String planTier()

      The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.

      Returns:
      The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.

    • usageLevel

      public final String usageLevel()

      The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.

      Returns:
      The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.

    • hasResourceArns

      public final boolean hasResourceArns()
      For responses, this returns true if the service returned a value for the ResourceArns 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.

    • resourceArns

      public final List<String> resourceArns()

      The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.

      For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

      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 hasResourceArns() method.

      Returns:
      The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.

      For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

    • approvalMode

      public final ApprovalMode approvalMode()

      Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.

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

      Returns:
      Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.
      See Also:

    • approvalModeAsString

      public final String approvalModeAsString()

      Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.

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

      Returns:
      Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.
      See Also:

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.

    • toBuilder

      public CreateSubscriptionRequest.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<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>
      Specified by:
      toBuilder in class PricingPlanManagerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateSubscriptionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateSubscriptionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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