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

vantage.KubernetesEfficiencyReport

Explore with Pulumi AI

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

Create KubernetesEfficiencyReport Resource

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

Constructor syntax

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

@overload
def KubernetesEfficiencyReport(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               title: Optional[str] = None,
                               workspace_token: Optional[str] = None,
                               aggregated_by: Optional[str] = None,
                               date_bucket: Optional[str] = None,
                               date_interval: Optional[str] = None,
                               end_date: Optional[str] = None,
                               filter: Optional[str] = None,
                               groupings: Optional[Sequence[str]] = None,
                               start_date: Optional[str] = None)
func NewKubernetesEfficiencyReport(ctx *Context, name string, args KubernetesEfficiencyReportArgs, opts ...ResourceOption) (*KubernetesEfficiencyReport, error)
public KubernetesEfficiencyReport(string name, KubernetesEfficiencyReportArgs args, CustomResourceOptions? opts = null)
public KubernetesEfficiencyReport(String name, KubernetesEfficiencyReportArgs args)
public KubernetesEfficiencyReport(String name, KubernetesEfficiencyReportArgs args, CustomResourceOptions options)

type: vantage:KubernetesEfficiencyReport
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. KubernetesEfficiencyReportArgs
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. KubernetesEfficiencyReportArgs
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. KubernetesEfficiencyReportArgs
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. KubernetesEfficiencyReportArgs
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. KubernetesEfficiencyReportArgs
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 kubernetesEfficiencyReportResource = new Vantage.KubernetesEfficiencyReport("kubernetesEfficiencyReportResource", new()
{
    Title = "string",
    WorkspaceToken = "string",
    AggregatedBy = "string",
    DateBucket = "string",
    DateInterval = "string",
    EndDate = "string",
    Filter = "string",
    Groupings = new[]
    {
        "string",
    },
    StartDate = "string",
});
Copy
example, err := vantage.NewKubernetesEfficiencyReport(ctx, "kubernetesEfficiencyReportResource", &vantage.KubernetesEfficiencyReportArgs{
Title: pulumi.String("string"),
WorkspaceToken: pulumi.String("string"),
AggregatedBy: pulumi.String("string"),
DateBucket: pulumi.String("string"),
DateInterval: pulumi.String("string"),
EndDate: pulumi.String("string"),
Filter: pulumi.String("string"),
Groupings: pulumi.StringArray{
pulumi.String("string"),
},
StartDate: pulumi.String("string"),
})
Copy
var kubernetesEfficiencyReportResource = new KubernetesEfficiencyReport("kubernetesEfficiencyReportResource", KubernetesEfficiencyReportArgs.builder()
    .title("string")
    .workspaceToken("string")
    .aggregatedBy("string")
    .dateBucket("string")
    .dateInterval("string")
    .endDate("string")
    .filter("string")
    .groupings("string")
    .startDate("string")
    .build());
Copy
kubernetes_efficiency_report_resource = vantage.KubernetesEfficiencyReport("kubernetesEfficiencyReportResource",
    title="string",
    workspace_token="string",
    aggregated_by="string",
    date_bucket="string",
    date_interval="string",
    end_date="string",
    filter="string",
    groupings=["string"],
    start_date="string")
Copy
const kubernetesEfficiencyReportResource = new vantage.KubernetesEfficiencyReport("kubernetesEfficiencyReportResource", {
    title: "string",
    workspaceToken: "string",
    aggregatedBy: "string",
    dateBucket: "string",
    dateInterval: "string",
    endDate: "string",
    filter: "string",
    groupings: ["string"],
    startDate: "string",
});
Copy
type: vantage:KubernetesEfficiencyReport
properties:
    aggregatedBy: string
    dateBucket: string
    dateInterval: string
    endDate: string
    filter: string
    groupings:
        - string
    startDate: string
    title: string
    workspaceToken: string
Copy

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

Title This property is required. string
The title of the KubernetesEfficiencyReport.
WorkspaceToken This property is required. string
The Workspace in which the KubernetesEfficiencyReport will be created.
AggregatedBy string
The column by which the costs are aggregated.
DateBucket string
The date bucket of the KubernetesEfficiencyReport.
DateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
EndDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
Groupings List<string>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
StartDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Title This property is required. string
The title of the KubernetesEfficiencyReport.
WorkspaceToken This property is required. string
The Workspace in which the KubernetesEfficiencyReport will be created.
AggregatedBy string
The column by which the costs are aggregated.
DateBucket string
The date bucket of the KubernetesEfficiencyReport.
DateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
EndDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
Groupings []string
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
StartDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title This property is required. String
The title of the KubernetesEfficiencyReport.
workspaceToken This property is required. String
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy String
The column by which the costs are aggregated.
dateBucket String
The date bucket of the KubernetesEfficiencyReport.
dateInterval String
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
endDate String
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter String
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings List<String>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate String
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title This property is required. string
The title of the KubernetesEfficiencyReport.
workspaceToken This property is required. string
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy string
The column by which the costs are aggregated.
dateBucket string
The date bucket of the KubernetesEfficiencyReport.
dateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
endDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings string[]
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title This property is required. str
The title of the KubernetesEfficiencyReport.
workspace_token This property is required. str
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregated_by str
The column by which the costs are aggregated.
date_bucket str
The date bucket of the KubernetesEfficiencyReport.
date_interval str
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
end_date str
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter str
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings Sequence[str]
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
start_date str
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title This property is required. String
The title of the KubernetesEfficiencyReport.
workspaceToken This property is required. String
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy String
The column by which the costs are aggregated.
dateBucket String
The date bucket of the KubernetesEfficiencyReport.
dateInterval String
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
endDate String
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter String
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings List<String>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate String
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.

Outputs

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

CreatedAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
Default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the report
UserToken string
The token for the User who created this KubernetesEfficiencyReport.
CreatedAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
Default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
Id string
The provider-assigned unique ID for this managed resource.
Token string
The token of the report
UserToken string
The token for the User who created this KubernetesEfficiencyReport.
createdAt String
The date and time, in UTC, the report was created. ISO 8601 Formatted.
default_ Boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the report
userToken String
The token for the User who created this KubernetesEfficiencyReport.
createdAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
default boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
id string
The provider-assigned unique ID for this managed resource.
token string
The token of the report
userToken string
The token for the User who created this KubernetesEfficiencyReport.
created_at str
The date and time, in UTC, the report was created. ISO 8601 Formatted.
default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
id str
The provider-assigned unique ID for this managed resource.
token str
The token of the report
user_token str
The token for the User who created this KubernetesEfficiencyReport.
createdAt String
The date and time, in UTC, the report was created. ISO 8601 Formatted.
default Boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
id String
The provider-assigned unique ID for this managed resource.
token String
The token of the report
userToken String
The token for the User who created this KubernetesEfficiencyReport.

Look up Existing KubernetesEfficiencyReport Resource

Get an existing KubernetesEfficiencyReport 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?: KubernetesEfficiencyReportState, opts?: CustomResourceOptions): KubernetesEfficiencyReport
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregated_by: Optional[str] = None,
        created_at: Optional[str] = None,
        date_bucket: Optional[str] = None,
        date_interval: Optional[str] = None,
        default: Optional[bool] = None,
        end_date: Optional[str] = None,
        filter: Optional[str] = None,
        groupings: Optional[Sequence[str]] = None,
        start_date: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        user_token: Optional[str] = None,
        workspace_token: Optional[str] = None) -> KubernetesEfficiencyReport
func GetKubernetesEfficiencyReport(ctx *Context, name string, id IDInput, state *KubernetesEfficiencyReportState, opts ...ResourceOption) (*KubernetesEfficiencyReport, error)
public static KubernetesEfficiencyReport Get(string name, Input<string> id, KubernetesEfficiencyReportState? state, CustomResourceOptions? opts = null)
public static KubernetesEfficiencyReport get(String name, Output<String> id, KubernetesEfficiencyReportState state, CustomResourceOptions options)
resources:  _:    type: vantage:KubernetesEfficiencyReport    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:
AggregatedBy string
The column by which the costs are aggregated.
CreatedAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
DateBucket string
The date bucket of the KubernetesEfficiencyReport.
DateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
Default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
EndDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
Groupings List<string>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
StartDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Title string
The title of the KubernetesEfficiencyReport.
Token string
The token of the report
UserToken string
The token for the User who created this KubernetesEfficiencyReport.
WorkspaceToken string
The Workspace in which the KubernetesEfficiencyReport will be created.
AggregatedBy string
The column by which the costs are aggregated.
CreatedAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
DateBucket string
The date bucket of the KubernetesEfficiencyReport.
DateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
Default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
EndDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
Groupings []string
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
StartDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
Title string
The title of the KubernetesEfficiencyReport.
Token string
The token of the report
UserToken string
The token for the User who created this KubernetesEfficiencyReport.
WorkspaceToken string
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy String
The column by which the costs are aggregated.
createdAt String
The date and time, in UTC, the report was created. ISO 8601 Formatted.
dateBucket String
The date bucket of the KubernetesEfficiencyReport.
dateInterval String
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
default_ Boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
endDate String
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter String
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings List<String>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate String
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title String
The title of the KubernetesEfficiencyReport.
token String
The token of the report
userToken String
The token for the User who created this KubernetesEfficiencyReport.
workspaceToken String
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy string
The column by which the costs are aggregated.
createdAt string
The date and time, in UTC, the report was created. ISO 8601 Formatted.
dateBucket string
The date bucket of the KubernetesEfficiencyReport.
dateInterval string
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
default boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
endDate string
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter string
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings string[]
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate string
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title string
The title of the KubernetesEfficiencyReport.
token string
The token of the report
userToken string
The token for the User who created this KubernetesEfficiencyReport.
workspaceToken string
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregated_by str
The column by which the costs are aggregated.
created_at str
The date and time, in UTC, the report was created. ISO 8601 Formatted.
date_bucket str
The date bucket of the KubernetesEfficiencyReport.
date_interval str
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
default bool
Indicates whether the KubernetesEfficiencyReport is the default report.
end_date str
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter str
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings Sequence[str]
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
start_date str
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title str
The title of the KubernetesEfficiencyReport.
token str
The token of the report
user_token str
The token for the User who created this KubernetesEfficiencyReport.
workspace_token str
The Workspace in which the KubernetesEfficiencyReport will be created.
aggregatedBy String
The column by which the costs are aggregated.
createdAt String
The date and time, in UTC, the report was created. ISO 8601 Formatted.
dateBucket String
The date bucket of the KubernetesEfficiencyReport.
dateInterval String
The date interval of the KubernetesEfficiencyReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
default Boolean
Indicates whether the KubernetesEfficiencyReport is the default report.
endDate String
The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
filter String
The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.
groupings List<String>
Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: clusterid, namespace, labeled, category, label, label:\n\nname>.
startDate String
The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
title String
The title of the KubernetesEfficiencyReport.
token String
The token of the report
userToken String
The token for the User who created this KubernetesEfficiencyReport.
workspaceToken String
The Workspace in which the KubernetesEfficiencyReport will be created.

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