AWS v7.11.0 published on Wednesday, Nov 5, 2025 by Pulumi
aws.cur.getReportDefinition
Start a Neo task
Explain and create an aws.cur.getReportDefinition resource
Use this data source to get information on an AWS Cost and Usage Report Definition.
NOTE: The AWS Cost and Usage Report service is only available in
us-east-1currently.
NOTE: If AWS Organizations is enabled, only the master account can use this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const reportDefinition = aws.cur.getReportDefinition({
reportName: "example",
});
import pulumi
import pulumi_aws as aws
report_definition = aws.cur.get_report_definition(report_name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cur"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cur.LookupReportDefinition(ctx, &cur.LookupReportDefinitionArgs{
ReportName: "example",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var reportDefinition = Aws.Cur.GetReportDefinition.Invoke(new()
{
ReportName = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cur.CurFunctions;
import com.pulumi.aws.cur.inputs.GetReportDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var reportDefinition = CurFunctions.getReportDefinition(GetReportDefinitionArgs.builder()
.reportName("example")
.build());
}
}
variables:
reportDefinition:
fn::invoke:
function: aws:cur:getReportDefinition
arguments:
reportName: example
Using getReportDefinition
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getReportDefinition(args: GetReportDefinitionArgs, opts?: InvokeOptions): Promise<GetReportDefinitionResult>
function getReportDefinitionOutput(args: GetReportDefinitionOutputArgs, opts?: InvokeOptions): Output<GetReportDefinitionResult>def get_report_definition(report_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetReportDefinitionResult
def get_report_definition_output(report_name: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetReportDefinitionResult]func LookupReportDefinition(ctx *Context, args *LookupReportDefinitionArgs, opts ...InvokeOption) (*LookupReportDefinitionResult, error)
func LookupReportDefinitionOutput(ctx *Context, args *LookupReportDefinitionOutputArgs, opts ...InvokeOption) LookupReportDefinitionResultOutput> Note: This function is named LookupReportDefinition in the Go SDK.
public static class GetReportDefinition
{
public static Task<GetReportDefinitionResult> InvokeAsync(GetReportDefinitionArgs args, InvokeOptions? opts = null)
public static Output<GetReportDefinitionResult> Invoke(GetReportDefinitionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetReportDefinitionResult> getReportDefinition(GetReportDefinitionArgs args, InvokeOptions options)
public static Output<GetReportDefinitionResult> getReportDefinition(GetReportDefinitionArgs args, InvokeOptions options)
fn::invoke:
function: aws:cur/getReportDefinition:getReportDefinition
arguments:
# arguments dictionaryThe following arguments are supported:
- Report
Name string - Name of the report definition to match.
- Dictionary<string, string>
- Map of key-value pairs assigned to the resource.
- Report
Name string - Name of the report definition to match.
- map[string]string
- Map of key-value pairs assigned to the resource.
- report
Name String - Name of the report definition to match.
- Map<String,String>
- Map of key-value pairs assigned to the resource.
- report
Name string - Name of the report definition to match.
- {[key: string]: string}
- Map of key-value pairs assigned to the resource.
- report_
name str - Name of the report definition to match.
- Mapping[str, str]
- Map of key-value pairs assigned to the resource.
- report
Name String - Name of the report definition to match.
- Map<String>
- Map of key-value pairs assigned to the resource.
getReportDefinition Result
The following output properties are available:
- Additional
Artifacts List<string> - A list of additional artifacts.
- Additional
Schema List<string>Elements - A list of schema elements.
- Compression string
- Preferred format for report.
- Format string
- Preferred compression format for report.
- Id string
- The provider-assigned unique ID for this managed resource.
- Refresh
Closed boolReports - If true reports are updated after they have been finalized.
- Report
Name string - Report
Versioning string - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- S3Bucket string
- Name of customer S3 bucket.
- S3Prefix string
- Preferred report path prefix.
- S3Region string
- Region of customer S3 bucket.
- Dictionary<string, string>
- Map of key-value pairs assigned to the resource.
- Time
Unit string - Frequency on which report data are measured and displayed.
- Additional
Artifacts []string - A list of additional artifacts.
- Additional
Schema []stringElements - A list of schema elements.
- Compression string
- Preferred format for report.
- Format string
- Preferred compression format for report.
- Id string
- The provider-assigned unique ID for this managed resource.
- Refresh
Closed boolReports - If true reports are updated after they have been finalized.
- Report
Name string - Report
Versioning string - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- S3Bucket string
- Name of customer S3 bucket.
- S3Prefix string
- Preferred report path prefix.
- S3Region string
- Region of customer S3 bucket.
- map[string]string
- Map of key-value pairs assigned to the resource.
- Time
Unit string - Frequency on which report data are measured and displayed.
- additional
Artifacts List<String> - A list of additional artifacts.
- additional
Schema List<String>Elements - A list of schema elements.
- compression String
- Preferred format for report.
- format String
- Preferred compression format for report.
- id String
- The provider-assigned unique ID for this managed resource.
- refresh
Closed BooleanReports - If true reports are updated after they have been finalized.
- report
Name String - report
Versioning String - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- s3Bucket String
- Name of customer S3 bucket.
- s3Prefix String
- Preferred report path prefix.
- s3Region String
- Region of customer S3 bucket.
- Map<String,String>
- Map of key-value pairs assigned to the resource.
- time
Unit String - Frequency on which report data are measured and displayed.
- additional
Artifacts string[] - A list of additional artifacts.
- additional
Schema string[]Elements - A list of schema elements.
- compression string
- Preferred format for report.
- format string
- Preferred compression format for report.
- id string
- The provider-assigned unique ID for this managed resource.
- refresh
Closed booleanReports - If true reports are updated after they have been finalized.
- report
Name string - report
Versioning string - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- s3Bucket string
- Name of customer S3 bucket.
- s3Prefix string
- Preferred report path prefix.
- s3Region string
- Region of customer S3 bucket.
- {[key: string]: string}
- Map of key-value pairs assigned to the resource.
- time
Unit string - Frequency on which report data are measured and displayed.
- additional_
artifacts Sequence[str] - A list of additional artifacts.
- additional_
schema_ Sequence[str]elements - A list of schema elements.
- compression str
- Preferred format for report.
- format str
- Preferred compression format for report.
- id str
- The provider-assigned unique ID for this managed resource.
- refresh_
closed_ boolreports - If true reports are updated after they have been finalized.
- report_
name str - report_
versioning str - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- s3_
bucket str - Name of customer S3 bucket.
- s3_
prefix str - Preferred report path prefix.
- s3_
region str - Region of customer S3 bucket.
- Mapping[str, str]
- Map of key-value pairs assigned to the resource.
- time_
unit str - Frequency on which report data are measured and displayed.
- additional
Artifacts List<String> - A list of additional artifacts.
- additional
Schema List<String>Elements - A list of schema elements.
- compression String
- Preferred format for report.
- format String
- Preferred compression format for report.
- id String
- The provider-assigned unique ID for this managed resource.
- refresh
Closed BooleanReports - If true reports are updated after they have been finalized.
- report
Name String - report
Versioning String - Overwrite the previous version of each report or to deliver the report in addition to the previous versions.
- s3Bucket String
- Name of customer S3 bucket.
- s3Prefix String
- Preferred report path prefix.
- s3Region String
- Region of customer S3 bucket.
- Map<String>
- Map of key-value pairs assigned to the resource.
- time
Unit String - Frequency on which report data are measured and displayed.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
