Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vantage Provider
  3. API Docs
  4. BusinessMetric
vantage 0.1.50 published on Monday, Apr 7, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

vantage.BusinessMetric

Explore with Pulumi AI

vantage 0.1.50 published on Monday, Apr 7, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

Create BusinessMetric Resource

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

Constructor syntax

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

@overload
def BusinessMetric(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   title: Optional[str] = None,
                   cost_report_tokens_with_metadatas: Optional[Sequence[BusinessMetricCostReportTokensWithMetadataArgs]] = None,
                   values: Optional[Sequence[BusinessMetricValueArgs]] = None)
func NewBusinessMetric(ctx *Context, name string, args BusinessMetricArgs, opts ...ResourceOption) (*BusinessMetric, error)
public BusinessMetric(string name, BusinessMetricArgs args, CustomResourceOptions? opts = null)
public BusinessMetric(String name, BusinessMetricArgs args)
public BusinessMetric(String name, BusinessMetricArgs args, CustomResourceOptions options)

type: vantage:BusinessMetric
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. BusinessMetricArgs
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. BusinessMetricArgs
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. BusinessMetricArgs
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. BusinessMetricArgs
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. BusinessMetricArgs
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 businessMetricResource = new Vantage.BusinessMetric("businessMetricResource", new()
{
    Title = "string",
    CostReportTokensWithMetadatas = new[]
    {
        new Vantage.Inputs.BusinessMetricCostReportTokensWithMetadataArgs
        {
            CostReportToken = "string",
            LabelFilters = new[]
            {
                "string",
            },
            UnitScale = "string",
        },
    },
    Values = new[]
    {
        new Vantage.Inputs.BusinessMetricValueArgs
        {
            Amount = 0,
            Date = "string",
            Label = "string",
        },
    },
});
Copy
example, err := vantage.NewBusinessMetric(ctx, "businessMetricResource", &vantage.BusinessMetricArgs{
Title: pulumi.String("string"),
CostReportTokensWithMetadatas: .BusinessMetricCostReportTokensWithMetadataArray{
&.BusinessMetricCostReportTokensWithMetadataArgs{
CostReportToken: pulumi.String("string"),
LabelFilters: pulumi.StringArray{
pulumi.String("string"),
},
UnitScale: pulumi.String("string"),
},
},
Values: .BusinessMetricValueArray{
&.BusinessMetricValueArgs{
Amount: pulumi.Float64(0),
Date: pulumi.String("string"),
Label: pulumi.String("string"),
},
},
})
Copy
var businessMetricResource = new BusinessMetric("businessMetricResource", BusinessMetricArgs.builder()
    .title("string")
    .costReportTokensWithMetadatas(BusinessMetricCostReportTokensWithMetadataArgs.builder()
        .costReportToken("string")
        .labelFilters("string")
        .unitScale("string")
        .build())
    .values(BusinessMetricValueArgs.builder()
        .amount(0)
        .date("string")
        .label("string")
        .build())
    .build());
Copy
business_metric_resource = vantage.BusinessMetric("businessMetricResource",
    title="string",
    cost_report_tokens_with_metadatas=[{
        "cost_report_token": "string",
        "label_filters": ["string"],
        "unit_scale": "string",
    }],
    values=[{
        "amount": 0,
        "date": "string",
        "label": "string",
    }])
Copy
const businessMetricResource = new vantage.BusinessMetric("businessMetricResource", {
    title: "string",
    costReportTokensWithMetadatas: [{
        costReportToken: "string",
        labelFilters: ["string"],
        unitScale: "string",
    }],
    values: [{
        amount: 0,
        date: "string",
        label: "string",
    }],
});
Copy
type: vantage:BusinessMetric
properties:
    costReportTokensWithMetadatas:
        - costReportToken: string
          labelFilters:
            - string
          unitScale: string
    title: string
    values:
        - amount: 0
          date: string
          label: string
Copy

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

Title This property is required. string
The title of the BusinessMetrics.
CostReportTokensWithMetadatas List<BusinessMetricCostReportTokensWithMetadata>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
Values List<BusinessMetricValue>
The dates, amounts, and (optional) labels for the BusinessMetric.
Title This property is required. string
The title of the BusinessMetrics.
CostReportTokensWithMetadatas []BusinessMetricCostReportTokensWithMetadataArgs
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
Values []BusinessMetricValueArgs
The dates, amounts, and (optional) labels for the BusinessMetric.
title This property is required. String
The title of the BusinessMetrics.
costReportTokensWithMetadatas List<BusinessMetricCostReportTokensWithMetadata>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
values List<BusinessMetricValue>
The dates, amounts, and (optional) labels for the BusinessMetric.
title This property is required. string
The title of the BusinessMetrics.
costReportTokensWithMetadatas BusinessMetricCostReportTokensWithMetadata[]
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
values BusinessMetricValue[]
The dates, amounts, and (optional) labels for the BusinessMetric.
title This property is required. str
The title of the BusinessMetrics.
cost_report_tokens_with_metadatas Sequence[BusinessMetricCostReportTokensWithMetadataArgs]
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
values Sequence[BusinessMetricValueArgs]
The dates, amounts, and (optional) labels for the BusinessMetric.
title This property is required. String
The title of the BusinessMetrics.
costReportTokensWithMetadatas List<Property Map>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
values List<Property Map>
The dates, amounts, and (optional) labels for the BusinessMetric.

Outputs

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

CreatedByToken string
The token of the Creator of the BusinessMetric.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the business metric
CreatedByToken string
The token of the Creator of the BusinessMetric.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the business metric
createdByToken String
The token of the Creator of the BusinessMetric.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the business metric
createdByToken string
The token of the Creator of the BusinessMetric.
id string
The provider-assigned unique ID for this managed resource.
token string
The token of the business metric
created_by_token str
The token of the Creator of the BusinessMetric.
id str
The provider-assigned unique ID for this managed resource.
token str
The token of the business metric
createdByToken String
The token of the Creator of the BusinessMetric.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the business metric

Look up Existing BusinessMetric Resource

Get an existing BusinessMetric 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?: BusinessMetricState, opts?: CustomResourceOptions): BusinessMetric
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cost_report_tokens_with_metadatas: Optional[Sequence[BusinessMetricCostReportTokensWithMetadataArgs]] = None,
        created_by_token: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        values: Optional[Sequence[BusinessMetricValueArgs]] = None) -> BusinessMetric
func GetBusinessMetric(ctx *Context, name string, id IDInput, state *BusinessMetricState, opts ...ResourceOption) (*BusinessMetric, error)
public static BusinessMetric Get(string name, Input<string> id, BusinessMetricState? state, CustomResourceOptions? opts = null)
public static BusinessMetric get(String name, Output<String> id, BusinessMetricState state, CustomResourceOptions options)
resources:  _:    type: vantage:BusinessMetric    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:
CostReportTokensWithMetadatas List<BusinessMetricCostReportTokensWithMetadata>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
CreatedByToken string
The token of the Creator of the BusinessMetric.
Title string
The title of the BusinessMetrics.
Token string
The token of the business metric
Values List<BusinessMetricValue>
The dates, amounts, and (optional) labels for the BusinessMetric.
CostReportTokensWithMetadatas []BusinessMetricCostReportTokensWithMetadataArgs
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
CreatedByToken string
The token of the Creator of the BusinessMetric.
Title string
The title of the BusinessMetrics.
Token string
The token of the business metric
Values []BusinessMetricValueArgs
The dates, amounts, and (optional) labels for the BusinessMetric.
costReportTokensWithMetadatas List<BusinessMetricCostReportTokensWithMetadata>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
createdByToken String
The token of the Creator of the BusinessMetric.
title String
The title of the BusinessMetrics.
token String
The token of the business metric
values List<BusinessMetricValue>
The dates, amounts, and (optional) labels for the BusinessMetric.
costReportTokensWithMetadatas BusinessMetricCostReportTokensWithMetadata[]
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
createdByToken string
The token of the Creator of the BusinessMetric.
title string
The title of the BusinessMetrics.
token string
The token of the business metric
values BusinessMetricValue[]
The dates, amounts, and (optional) labels for the BusinessMetric.
cost_report_tokens_with_metadatas Sequence[BusinessMetricCostReportTokensWithMetadataArgs]
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
created_by_token str
The token of the Creator of the BusinessMetric.
title str
The title of the BusinessMetrics.
token str
The token of the business metric
values Sequence[BusinessMetricValueArgs]
The dates, amounts, and (optional) labels for the BusinessMetric.
costReportTokensWithMetadatas List<Property Map>
The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
createdByToken String
The token of the Creator of the BusinessMetric.
title String
The title of the BusinessMetrics.
token String
The token of the business metric
values List<Property Map>
The dates, amounts, and (optional) labels for the BusinessMetric.

Supporting Types

BusinessMetricCostReportTokensWithMetadata
, BusinessMetricCostReportTokensWithMetadataArgs

CostReportToken This property is required. string
The token of the CostReport the BusinessMetric is attached to.
LabelFilters List<string>
Include only values with these labels in the CostReport.
UnitScale string
Determines the scale of the BusinessMetric's values within the CostReport.
CostReportToken This property is required. string
The token of the CostReport the BusinessMetric is attached to.
LabelFilters []string
Include only values with these labels in the CostReport.
UnitScale string
Determines the scale of the BusinessMetric's values within the CostReport.
costReportToken This property is required. String
The token of the CostReport the BusinessMetric is attached to.
labelFilters List<String>
Include only values with these labels in the CostReport.
unitScale String
Determines the scale of the BusinessMetric's values within the CostReport.
costReportToken This property is required. string
The token of the CostReport the BusinessMetric is attached to.
labelFilters string[]
Include only values with these labels in the CostReport.
unitScale string
Determines the scale of the BusinessMetric's values within the CostReport.
cost_report_token This property is required. str
The token of the CostReport the BusinessMetric is attached to.
label_filters Sequence[str]
Include only values with these labels in the CostReport.
unit_scale str
Determines the scale of the BusinessMetric's values within the CostReport.
costReportToken This property is required. String
The token of the CostReport the BusinessMetric is attached to.
labelFilters List<String>
Include only values with these labels in the CostReport.
unitScale String
Determines the scale of the BusinessMetric's values within the CostReport.

BusinessMetricValue
, BusinessMetricValueArgs

Amount This property is required. double
Date This property is required. string
Label string
Amount This property is required. float64
Date This property is required. string
Label string
amount This property is required. Double
date This property is required. String
label String
amount This property is required. number
date This property is required. string
label string
amount This property is required. float
date This property is required. str
label str
amount This property is required. Number
date This property is required. String
label String

Package Details

Repository
vantage vantage-sh/terraform-provider-vantage
License
Notes
This Pulumi package is based on the vantage Terraform Provider.
vantage 0.1.50 published on Monday, Apr 7, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage