1. Packages
  2. Vantage Provider
  3. API Docs
  4. BillingRule
vantage 0.1.48 published on Tuesday, Mar 18, 2025 by vantage-sh

vantage.BillingRule

Explore with Pulumi AI

Create BillingRule Resource

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

Constructor syntax

new BillingRule(name: string, args: BillingRuleArgs, opts?: CustomResourceOptions);
@overload
def BillingRule(resource_name: str,
                args: BillingRuleArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def BillingRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                title: Optional[str] = None,
                type: Optional[str] = None,
                amount: Optional[float] = None,
                category: Optional[str] = None,
                charge_type: Optional[str] = None,
                percentage: Optional[float] = None,
                service: Optional[str] = None,
                start_period: Optional[str] = None,
                sub_category: Optional[str] = None)
func NewBillingRule(ctx *Context, name string, args BillingRuleArgs, opts ...ResourceOption) (*BillingRule, error)
public BillingRule(string name, BillingRuleArgs args, CustomResourceOptions? opts = null)
public BillingRule(String name, BillingRuleArgs args)
public BillingRule(String name, BillingRuleArgs args, CustomResourceOptions options)
type: vantage:BillingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BillingRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BillingRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BillingRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BillingRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BillingRuleArgs
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 billingRuleResource = new Vantage.BillingRule("billingRuleResource", new()
{
    Title = "string",
    Type = "string",
    Amount = 0,
    Category = "string",
    ChargeType = "string",
    Percentage = 0,
    Service = "string",
    StartPeriod = "string",
    SubCategory = "string",
});
Copy
example, err := vantage.NewBillingRule(ctx, "billingRuleResource", &vantage.BillingRuleArgs{
Title: pulumi.String("string"),
Type: pulumi.String("string"),
Amount: pulumi.Float64(0),
Category: pulumi.String("string"),
ChargeType: pulumi.String("string"),
Percentage: pulumi.Float64(0),
Service: pulumi.String("string"),
StartPeriod: pulumi.String("string"),
SubCategory: pulumi.String("string"),
})
Copy
var billingRuleResource = new BillingRule("billingRuleResource", BillingRuleArgs.builder()
    .title("string")
    .type("string")
    .amount(0)
    .category("string")
    .chargeType("string")
    .percentage(0)
    .service("string")
    .startPeriod("string")
    .subCategory("string")
    .build());
Copy
billing_rule_resource = vantage.BillingRule("billingRuleResource",
    title="string",
    type="string",
    amount=0,
    category="string",
    charge_type="string",
    percentage=0,
    service="string",
    start_period="string",
    sub_category="string")
Copy
const billingRuleResource = new vantage.BillingRule("billingRuleResource", {
    title: "string",
    type: "string",
    amount: 0,
    category: "string",
    chargeType: "string",
    percentage: 0,
    service: "string",
    startPeriod: "string",
    subCategory: "string",
});
Copy
type: vantage:BillingRule
properties:
    amount: 0
    category: string
    chargeType: string
    percentage: 0
    service: string
    startPeriod: string
    subCategory: string
    title: string
    type: string
Copy

BillingRule 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 BillingRule resource accepts the following input properties:

Title This property is required. string
The title of the Billing Rule.
Type This property is required. string
The type of the Billing Rule. Note: the values are case insensitive.
Amount double
The credit amount for the Billing Rule. Example value: 300
Category string
The category of the Billing Rule.
ChargeType string
The charge type of the Billing Rule.
Percentage double
The percentage of the cost shown. Example value: 75.0
Service string
The service of the Billing Rule.
StartPeriod string
The start period of the Billing Rule.
SubCategory string
The subcategory of the Billing Rule.
Title This property is required. string
The title of the Billing Rule.
Type This property is required. string
The type of the Billing Rule. Note: the values are case insensitive.
Amount float64
The credit amount for the Billing Rule. Example value: 300
Category string
The category of the Billing Rule.
ChargeType string
The charge type of the Billing Rule.
Percentage float64
The percentage of the cost shown. Example value: 75.0
Service string
The service of the Billing Rule.
StartPeriod string
The start period of the Billing Rule.
SubCategory string
The subcategory of the Billing Rule.
title This property is required. String
The title of the Billing Rule.
type This property is required. String
The type of the Billing Rule. Note: the values are case insensitive.
amount Double
The credit amount for the Billing Rule. Example value: 300
category String
The category of the Billing Rule.
chargeType String
The charge type of the Billing Rule.
percentage Double
The percentage of the cost shown. Example value: 75.0
service String
The service of the Billing Rule.
startPeriod String
The start period of the Billing Rule.
subCategory String
The subcategory of the Billing Rule.
title This property is required. string
The title of the Billing Rule.
type This property is required. string
The type of the Billing Rule. Note: the values are case insensitive.
amount number
The credit amount for the Billing Rule. Example value: 300
category string
The category of the Billing Rule.
chargeType string
The charge type of the Billing Rule.
percentage number
The percentage of the cost shown. Example value: 75.0
service string
The service of the Billing Rule.
startPeriod string
The start period of the Billing Rule.
subCategory string
The subcategory of the Billing Rule.
title This property is required. str
The title of the Billing Rule.
type This property is required. str
The type of the Billing Rule. Note: the values are case insensitive.
amount float
The credit amount for the Billing Rule. Example value: 300
category str
The category of the Billing Rule.
charge_type str
The charge type of the Billing Rule.
percentage float
The percentage of the cost shown. Example value: 75.0
service str
The service of the Billing Rule.
start_period str
The start period of the Billing Rule.
sub_category str
The subcategory of the Billing Rule.
title This property is required. String
The title of the Billing Rule.
type This property is required. String
The type of the Billing Rule. Note: the values are case insensitive.
amount Number
The credit amount for the Billing Rule. Example value: 300
category String
The category of the Billing Rule.
chargeType String
The charge type of the Billing Rule.
percentage Number
The percentage of the cost shown. Example value: 75.0
service String
The service of the Billing Rule.
startPeriod String
The start period of the Billing Rule.
subCategory String
The subcategory of the Billing Rule.

Outputs

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

CreatedAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
CreatedByToken string
The token of the User who created the Billing Rule.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the billing rule
CreatedAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
CreatedByToken string
The token of the User who created the Billing Rule.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the billing rule
createdAt String
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken String
The token of the User who created the Billing Rule.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the billing rule
createdAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken string
The token of the User who created the Billing Rule.
id string
The provider-assigned unique ID for this managed resource.
token string
The token of the billing rule
created_at str
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
created_by_token str
The token of the User who created the Billing Rule.
id str
The provider-assigned unique ID for this managed resource.
token str
The token of the billing rule
createdAt String
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken String
The token of the User who created the Billing Rule.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the billing rule

Look up Existing BillingRule Resource

Get an existing BillingRule 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?: BillingRuleState, opts?: CustomResourceOptions): BillingRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        category: Optional[str] = None,
        charge_type: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by_token: Optional[str] = None,
        percentage: Optional[float] = None,
        service: Optional[str] = None,
        start_period: Optional[str] = None,
        sub_category: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        type: Optional[str] = None) -> BillingRule
func GetBillingRule(ctx *Context, name string, id IDInput, state *BillingRuleState, opts ...ResourceOption) (*BillingRule, error)
public static BillingRule Get(string name, Input<string> id, BillingRuleState? state, CustomResourceOptions? opts = null)
public static BillingRule get(String name, Output<String> id, BillingRuleState state, CustomResourceOptions options)
resources:  _:    type: vantage:BillingRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Amount double
The credit amount for the Billing Rule. Example value: 300
Category string
The category of the Billing Rule.
ChargeType string
The charge type of the Billing Rule.
CreatedAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
CreatedByToken string
The token of the User who created the Billing Rule.
Percentage double
The percentage of the cost shown. Example value: 75.0
Service string
The service of the Billing Rule.
StartPeriod string
The start period of the Billing Rule.
SubCategory string
The subcategory of the Billing Rule.
Title string
The title of the Billing Rule.
Token string
The token of the billing rule
Type string
The type of the Billing Rule. Note: the values are case insensitive.
Amount float64
The credit amount for the Billing Rule. Example value: 300
Category string
The category of the Billing Rule.
ChargeType string
The charge type of the Billing Rule.
CreatedAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
CreatedByToken string
The token of the User who created the Billing Rule.
Percentage float64
The percentage of the cost shown. Example value: 75.0
Service string
The service of the Billing Rule.
StartPeriod string
The start period of the Billing Rule.
SubCategory string
The subcategory of the Billing Rule.
Title string
The title of the Billing Rule.
Token string
The token of the billing rule
Type string
The type of the Billing Rule. Note: the values are case insensitive.
amount Double
The credit amount for the Billing Rule. Example value: 300
category String
The category of the Billing Rule.
chargeType String
The charge type of the Billing Rule.
createdAt String
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken String
The token of the User who created the Billing Rule.
percentage Double
The percentage of the cost shown. Example value: 75.0
service String
The service of the Billing Rule.
startPeriod String
The start period of the Billing Rule.
subCategory String
The subcategory of the Billing Rule.
title String
The title of the Billing Rule.
token String
The token of the billing rule
type String
The type of the Billing Rule. Note: the values are case insensitive.
amount number
The credit amount for the Billing Rule. Example value: 300
category string
The category of the Billing Rule.
chargeType string
The charge type of the Billing Rule.
createdAt string
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken string
The token of the User who created the Billing Rule.
percentage number
The percentage of the cost shown. Example value: 75.0
service string
The service of the Billing Rule.
startPeriod string
The start period of the Billing Rule.
subCategory string
The subcategory of the Billing Rule.
title string
The title of the Billing Rule.
token string
The token of the billing rule
type string
The type of the Billing Rule. Note: the values are case insensitive.
amount float
The credit amount for the Billing Rule. Example value: 300
category str
The category of the Billing Rule.
charge_type str
The charge type of the Billing Rule.
created_at str
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
created_by_token str
The token of the User who created the Billing Rule.
percentage float
The percentage of the cost shown. Example value: 75.0
service str
The service of the Billing Rule.
start_period str
The start period of the Billing Rule.
sub_category str
The subcategory of the Billing Rule.
title str
The title of the Billing Rule.
token str
The token of the billing rule
type str
The type of the Billing Rule. Note: the values are case insensitive.
amount Number
The credit amount for the Billing Rule. Example value: 300
category String
The category of the Billing Rule.
chargeType String
The charge type of the Billing Rule.
createdAt String
The date and time, in UTC, the Billing Rule was created. ISO 8601 Formatted.
createdByToken String
The token of the User who created the Billing Rule.
percentage Number
The percentage of the cost shown. Example value: 75.0
service String
The service of the Billing Rule.
startPeriod String
The start period of the Billing Rule.
subCategory String
The subcategory of the Billing Rule.
title String
The title of the Billing Rule.
token String
The token of the billing rule
type String
The type of the Billing Rule. Note: the values are case insensitive.

Package Details

Repository
vantage vantage-sh/terraform-provider-vantage
License
Notes
This Pulumi package is based on the vantage Terraform Provider.