1. Packages
  2. Packages
  3. Thoth
  4. API Docs
  5. billing
  6. OverageCap
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security
thoth logo
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security

    Create OverageCap Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OverageCap(name: string, args: OverageCapArgs, opts?: CustomResourceOptions);
    @overload
    def OverageCap(resource_name: str,
                   args: OverageCapArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def OverageCap(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   overage_cap_usd: Optional[float] = None)
    func NewOverageCap(ctx *Context, name string, args OverageCapArgs, opts ...ResourceOption) (*OverageCap, error)
    public OverageCap(string name, OverageCapArgs args, CustomResourceOptions? opts = null)
    public OverageCap(String name, OverageCapArgs args)
    public OverageCap(String name, OverageCapArgs args, CustomResourceOptions options)
    
    type: thoth:billing:OverageCap
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "thoth_billing_overage_cap" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OverageCapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OverageCapArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OverageCapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OverageCapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OverageCapArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var overageCapResource = new Thoth.Billing.OverageCap("overageCapResource", new()
    {
        OverageCapUsd = 0,
    });
    
    example, err := billing.NewOverageCap(ctx, "overageCapResource", &billing.OverageCapArgs{
    	OverageCapUsd: pulumi.Float64(0),
    })
    
    resource "thoth_billing_overage_cap" "overageCapResource" {
      lifecycle {
        create_before_destroy = true
      }
      overage_cap_usd = 0
    }
    
    var overageCapResource = new OverageCap("overageCapResource", OverageCapArgs.builder()
        .overageCapUsd(0.0)
        .build());
    
    overage_cap_resource = thoth.billing.OverageCap("overageCapResource", overage_cap_usd=float(0))
    
    const overageCapResource = new thoth.billing.OverageCap("overageCapResource", {overageCapUsd: 0});
    
    type: thoth:billing:OverageCap
    properties:
        overageCapUsd: 0
    

    OverageCap Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OverageCap resource accepts the following input properties:

    OverageCapUsd double
    Monthly variable overage cap in USD.
    OverageCapUsd float64
    Monthly variable overage cap in USD.
    overage_cap_usd number
    Monthly variable overage cap in USD.
    overageCapUsd Double
    Monthly variable overage cap in USD.
    overageCapUsd number
    Monthly variable overage cap in USD.
    overage_cap_usd float
    Monthly variable overage cap in USD.
    overageCapUsd Number
    Monthly variable overage cap in USD.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OverageCap resource produces the following output properties:

    ActiveTier string
    Effective active pricing tier.
    BaseMonthlyPlatformFeeUsd double
    Base monthly platform fee in USD for the active tier.
    GovernedIdentityUsdPerMonth double
    Per-governed-identity overage rate.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludedGovernedIdentities int
    Included governed identities before overage.
    IncludedPolicyChecks int
    Included policy checks before overage.
    PolicyChecksUsdPerMillion double
    Per-million policy checks overage rate.
    ResponseJson string
    Full billing pricing profile response payload as JSON.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Timestamp when the overage cap was last applied via provider.
    ActiveTier string
    Effective active pricing tier.
    BaseMonthlyPlatformFeeUsd float64
    Base monthly platform fee in USD for the active tier.
    GovernedIdentityUsdPerMonth float64
    Per-governed-identity overage rate.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludedGovernedIdentities int
    Included governed identities before overage.
    IncludedPolicyChecks int
    Included policy checks before overage.
    PolicyChecksUsdPerMillion float64
    Per-million policy checks overage rate.
    ResponseJson string
    Full billing pricing profile response payload as JSON.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Timestamp when the overage cap was last applied via provider.
    active_tier string
    Effective active pricing tier.
    base_monthly_platform_fee_usd number
    Base monthly platform fee in USD for the active tier.
    governed_identity_usd_per_month number
    Per-governed-identity overage rate.
    id string
    The provider-assigned unique ID for this managed resource.
    included_governed_identities number
    Included governed identities before overage.
    included_policy_checks number
    Included policy checks before overage.
    policy_checks_usd_per_million number
    Per-million policy checks overage rate.
    response_json string
    Full billing pricing profile response payload as JSON.
    tenant_id string
    Tenant ID resolved from provider configuration.
    updated_at string
    Timestamp when the overage cap was last applied via provider.
    activeTier String
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd Double
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth Double
    Per-governed-identity overage rate.
    id String
    The provider-assigned unique ID for this managed resource.
    includedGovernedIdentities Integer
    Included governed identities before overage.
    includedPolicyChecks Integer
    Included policy checks before overage.
    policyChecksUsdPerMillion Double
    Per-million policy checks overage rate.
    responseJson String
    Full billing pricing profile response payload as JSON.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Timestamp when the overage cap was last applied via provider.
    activeTier string
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd number
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth number
    Per-governed-identity overage rate.
    id string
    The provider-assigned unique ID for this managed resource.
    includedGovernedIdentities number
    Included governed identities before overage.
    includedPolicyChecks number
    Included policy checks before overage.
    policyChecksUsdPerMillion number
    Per-million policy checks overage rate.
    responseJson string
    Full billing pricing profile response payload as JSON.
    tenantId string
    Tenant ID resolved from provider configuration.
    updatedAt string
    Timestamp when the overage cap was last applied via provider.
    active_tier str
    Effective active pricing tier.
    base_monthly_platform_fee_usd float
    Base monthly platform fee in USD for the active tier.
    governed_identity_usd_per_month float
    Per-governed-identity overage rate.
    id str
    The provider-assigned unique ID for this managed resource.
    included_governed_identities int
    Included governed identities before overage.
    included_policy_checks int
    Included policy checks before overage.
    policy_checks_usd_per_million float
    Per-million policy checks overage rate.
    response_json str
    Full billing pricing profile response payload as JSON.
    tenant_id str
    Tenant ID resolved from provider configuration.
    updated_at str
    Timestamp when the overage cap was last applied via provider.
    activeTier String
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd Number
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth Number
    Per-governed-identity overage rate.
    id String
    The provider-assigned unique ID for this managed resource.
    includedGovernedIdentities Number
    Included governed identities before overage.
    includedPolicyChecks Number
    Included policy checks before overage.
    policyChecksUsdPerMillion Number
    Per-million policy checks overage rate.
    responseJson String
    Full billing pricing profile response payload as JSON.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Timestamp when the overage cap was last applied via provider.

    Look up Existing OverageCap Resource

    Get an existing OverageCap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OverageCapState, opts?: CustomResourceOptions): OverageCap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active_tier: Optional[str] = None,
            base_monthly_platform_fee_usd: Optional[float] = None,
            governed_identity_usd_per_month: Optional[float] = None,
            included_governed_identities: Optional[int] = None,
            included_policy_checks: Optional[int] = None,
            overage_cap_usd: Optional[float] = None,
            policy_checks_usd_per_million: Optional[float] = None,
            response_json: Optional[str] = None,
            tenant_id: Optional[str] = None,
            updated_at: Optional[str] = None) -> OverageCap
    func GetOverageCap(ctx *Context, name string, id IDInput, state *OverageCapState, opts ...ResourceOption) (*OverageCap, error)
    public static OverageCap Get(string name, Input<string> id, OverageCapState? state, CustomResourceOptions? opts = null)
    public static OverageCap get(String name, Output<String> id, OverageCapState state, CustomResourceOptions options)
    resources:  _:    type: thoth:billing:OverageCap    get:      id: ${id}
    import {
      to = thoth_billing_overage_cap.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActiveTier string
    Effective active pricing tier.
    BaseMonthlyPlatformFeeUsd double
    Base monthly platform fee in USD for the active tier.
    GovernedIdentityUsdPerMonth double
    Per-governed-identity overage rate.
    IncludedGovernedIdentities int
    Included governed identities before overage.
    IncludedPolicyChecks int
    Included policy checks before overage.
    OverageCapUsd double
    Monthly variable overage cap in USD.
    PolicyChecksUsdPerMillion double
    Per-million policy checks overage rate.
    ResponseJson string
    Full billing pricing profile response payload as JSON.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Timestamp when the overage cap was last applied via provider.
    ActiveTier string
    Effective active pricing tier.
    BaseMonthlyPlatformFeeUsd float64
    Base monthly platform fee in USD for the active tier.
    GovernedIdentityUsdPerMonth float64
    Per-governed-identity overage rate.
    IncludedGovernedIdentities int
    Included governed identities before overage.
    IncludedPolicyChecks int
    Included policy checks before overage.
    OverageCapUsd float64
    Monthly variable overage cap in USD.
    PolicyChecksUsdPerMillion float64
    Per-million policy checks overage rate.
    ResponseJson string
    Full billing pricing profile response payload as JSON.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Timestamp when the overage cap was last applied via provider.
    active_tier string
    Effective active pricing tier.
    base_monthly_platform_fee_usd number
    Base monthly platform fee in USD for the active tier.
    governed_identity_usd_per_month number
    Per-governed-identity overage rate.
    included_governed_identities number
    Included governed identities before overage.
    included_policy_checks number
    Included policy checks before overage.
    overage_cap_usd number
    Monthly variable overage cap in USD.
    policy_checks_usd_per_million number
    Per-million policy checks overage rate.
    response_json string
    Full billing pricing profile response payload as JSON.
    tenant_id string
    Tenant ID resolved from provider configuration.
    updated_at string
    Timestamp when the overage cap was last applied via provider.
    activeTier String
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd Double
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth Double
    Per-governed-identity overage rate.
    includedGovernedIdentities Integer
    Included governed identities before overage.
    includedPolicyChecks Integer
    Included policy checks before overage.
    overageCapUsd Double
    Monthly variable overage cap in USD.
    policyChecksUsdPerMillion Double
    Per-million policy checks overage rate.
    responseJson String
    Full billing pricing profile response payload as JSON.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Timestamp when the overage cap was last applied via provider.
    activeTier string
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd number
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth number
    Per-governed-identity overage rate.
    includedGovernedIdentities number
    Included governed identities before overage.
    includedPolicyChecks number
    Included policy checks before overage.
    overageCapUsd number
    Monthly variable overage cap in USD.
    policyChecksUsdPerMillion number
    Per-million policy checks overage rate.
    responseJson string
    Full billing pricing profile response payload as JSON.
    tenantId string
    Tenant ID resolved from provider configuration.
    updatedAt string
    Timestamp when the overage cap was last applied via provider.
    active_tier str
    Effective active pricing tier.
    base_monthly_platform_fee_usd float
    Base monthly platform fee in USD for the active tier.
    governed_identity_usd_per_month float
    Per-governed-identity overage rate.
    included_governed_identities int
    Included governed identities before overage.
    included_policy_checks int
    Included policy checks before overage.
    overage_cap_usd float
    Monthly variable overage cap in USD.
    policy_checks_usd_per_million float
    Per-million policy checks overage rate.
    response_json str
    Full billing pricing profile response payload as JSON.
    tenant_id str
    Tenant ID resolved from provider configuration.
    updated_at str
    Timestamp when the overage cap was last applied via provider.
    activeTier String
    Effective active pricing tier.
    baseMonthlyPlatformFeeUsd Number
    Base monthly platform fee in USD for the active tier.
    governedIdentityUsdPerMonth Number
    Per-governed-identity overage rate.
    includedGovernedIdentities Number
    Included governed identities before overage.
    includedPolicyChecks Number
    Included policy checks before overage.
    overageCapUsd Number
    Monthly variable overage cap in USD.
    policyChecksUsdPerMillion Number
    Per-million policy checks overage rate.
    responseJson String
    Full billing pricing profile response payload as JSON.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Timestamp when the overage cap was last applied via provider.

    Package Details

    Repository
    thoth atensecurity/pulumi-thoth
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the thoth Terraform Provider.
    thoth logo
    Viewing docs for Thoth v0.1.15
    published on Thursday, Jul 23, 2026 by Aten Security

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial