1. Packages
  2. AWS Classic
  3. API Docs
  4. cur
  5. getReportDefinition

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.23.0 published on Thursday, Feb 22, 2024 by Pulumi

aws.cur.getReportDefinition

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.23.0 published on Thursday, Feb 22, 2024 by Pulumi

    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-1 currently.

    NOTE: If AWS Organizations is enabled, only the master account can use this resource.

    Example Usage

    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 main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    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());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    report_definition = aws.cur.get_report_definition(report_name="example")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const reportDefinition = aws.cur.getReportDefinition({
        reportName: "example",
    });
    
    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,
                              opts: Optional[InvokeOptions] = None) -> GetReportDefinitionResult
    def get_report_definition_output(report_name: Optional[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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:cur/getReportDefinition:getReportDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ReportName string
    Name of the report definition to match.
    ReportName string
    Name of the report definition to match.
    reportName String
    Name of the report definition to match.
    reportName string
    Name of the report definition to match.
    report_name str
    Name of the report definition to match.
    reportName String
    Name of the report definition to match.

    getReportDefinition Result

    The following output properties are available:

    AdditionalArtifacts List<string>
    A list of additional artifacts.
    AdditionalSchemaElements List<string>
    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.
    RefreshClosedReports bool
    If true reports are updated after they have been finalized.
    ReportName string
    ReportVersioning 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.
    TimeUnit string
    Frequency on which report data are measured and displayed.
    AdditionalArtifacts []string
    A list of additional artifacts.
    AdditionalSchemaElements []string
    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.
    RefreshClosedReports bool
    If true reports are updated after they have been finalized.
    ReportName string
    ReportVersioning 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.
    TimeUnit string
    Frequency on which report data are measured and displayed.
    additionalArtifacts List<String>
    A list of additional artifacts.
    additionalSchemaElements List<String>
    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.
    refreshClosedReports Boolean
    If true reports are updated after they have been finalized.
    reportName String
    reportVersioning 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.
    timeUnit String
    Frequency on which report data are measured and displayed.
    additionalArtifacts string[]
    A list of additional artifacts.
    additionalSchemaElements string[]
    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.
    refreshClosedReports boolean
    If true reports are updated after they have been finalized.
    reportName string
    reportVersioning 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.
    timeUnit string
    Frequency on which report data are measured and displayed.
    additional_artifacts Sequence[str]
    A list of additional artifacts.
    additional_schema_elements Sequence[str]
    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_reports bool
    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.
    time_unit str
    Frequency on which report data are measured and displayed.
    additionalArtifacts List<String>
    A list of additional artifacts.
    additionalSchemaElements List<String>
    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.
    refreshClosedReports Boolean
    If true reports are updated after they have been finalized.
    reportName String
    reportVersioning 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.
    timeUnit 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 aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.23.0 published on Thursday, Feb 22, 2024 by Pulumi