Interface CreateSubscriptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>, PricingPlanManagerRequest.Builder, SdkBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateSubscriptionRequest
@Mutable @NotThreadSafe public static interface CreateSubscriptionRequest.Builder extends PricingPlanManagerRequest.Builder, SdkPojo, CopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>

  • Method Details

    • planFamily

      CreateSubscriptionRequest.Builder planFamily(String planFamily)

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

      Parameters:
      planFamily - The pricing plan family to subscribe to, such as CloudFront.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • planTier

      CreateSubscriptionRequest.Builder planTier(String planTier)

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

      Parameters:
      planTier - The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usageLevel

      CreateSubscriptionRequest.Builder usageLevel(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArns

      CreateSubscriptionRequest.Builder resourceArns(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArns

      CreateSubscriptionRequest.Builder resourceArns(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalMode

      CreateSubscriptionRequest.Builder approvalMode(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvalMode

      CreateSubscriptionRequest.Builder approvalMode(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateSubscriptionRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.