Skip to content

CreateSubscriptionInput

Source code in docs_src/capo_pricing_plan_manager/types/create_subscription_input.py
class CreateSubscriptionInput(TypedDict, closed=True):
    plan_family: "str"
    """<p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>"""
    plan_tier: "str"
    """<p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>"""
    usage_level: NotRequired["str"]
    """<p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>"""
    resource_arns: "capo_pricing_plan_manager.types.resource_arns.ResourceArns"
    """<p>The ARNs of the resources to include in the subscription. Specify one or more supported resources.</p> <note> <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p> </note>"""
    approval_mode: NotRequired[
        "capo_pricing_plan_manager.types.approval_mode.ApprovalMode"
    ]
    """<p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. For paid tier plans, this defaults to <code>MANUAL</code> if not specified. For the <code>FREE</code> plan tier, only <code>IMMEDIATE</code> is supported, and it is the default.</p>"""
    client_token: NotRequired[
        "capo_pricing_plan_manager.types.idempotency_token.IdempotencyToken"
    ]
    """<p>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.</p>"""

approval_mode instance-attribute

approval_mode: NotRequired[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. For paid tier plans, this defaults to MANUAL if not specified. For the FREE plan tier, only IMMEDIATE is supported, and it is the default.

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

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.

plan_family instance-attribute

plan_family: str

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

plan_tier instance-attribute

plan_tier: str

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

resource_arns instance-attribute

resource_arns: ResourceArns

The ARNs of the 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 WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

usage_level instance-attribute

usage_level: NotRequired[str]

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