awscur

Documentation

Index

• func CfnReportDefinition_CFN_RESOURCE_TYPE_NAME() *string
• func CfnReportDefinition_IsCfnElement(x interface{}) *bool
• func CfnReportDefinition_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnReportDefinition_IsConstruct(x interface{}) *bool
• func NewCfnReportDefinition_Override(c CfnReportDefinition, scope constructs.Construct, id *string, ...)
• type CfnReportDefinition
  • func NewCfnReportDefinition(scope constructs.Construct, id *string, props *CfnReportDefinitionProps) CfnReportDefinition
• type CfnReportDefinitionProps

Functions

func CfnReportDefinition_CFN_RESOURCE_TYPE_NAME

func CfnReportDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnReportDefinition_IsCfnElement

func CfnReportDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnReportDefinition_IsCfnResource

func CfnReportDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReportDefinition_IsConstruct

func CfnReportDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnReportDefinition_Override

func NewCfnReportDefinition_Override(c CfnReportDefinition, scope constructs.Construct, id *string, props *CfnReportDefinitionProps)

Create a new `AWS::CUR::ReportDefinition`.

Types

type CfnReportDefinition

type CfnReportDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AdditionalArtifacts() *[]*string
	SetAdditionalArtifacts(val *[]*string)
	AdditionalSchemaElements() *[]*string
	SetAdditionalSchemaElements(val *[]*string)
	BillingViewArn() *string
	SetBillingViewArn(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Compression() *string
	SetCompression(val *string)
	CreationStack() *[]*string
	Format() *string
	SetFormat(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RefreshClosedReports() interface{}
	SetRefreshClosedReports(val interface{})
	ReportName() *string
	SetReportName(val *string)
	ReportVersioning() *string
	SetReportVersioning(val *string)
	S3Bucket() *string
	SetS3Bucket(val *string)
	S3Prefix() *string
	SetS3Prefix(val *string)
	S3Region() *string
	SetS3Region(val *string)
	Stack() awscdk.Stack
	TimeUnit() *string
	SetTimeUnit(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CUR::ReportDefinition`.

The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

TODO: EXAMPLE

func NewCfnReportDefinition

func NewCfnReportDefinition(scope constructs.Construct, id *string, props *CfnReportDefinitionProps) CfnReportDefinition

Create a new `AWS::CUR::ReportDefinition`.

type CfnReportDefinitionProps

type CfnReportDefinitionProps struct {
	// The compression format that Amazon Web Services uses for the report.
	Compression *string `json:"compression" yaml:"compression"`
	// The format that Amazon Web Services saves the report in.
	Format *string `json:"format" yaml:"format"`
	// Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months.
	//
	// These charges can include refunds, credits, or support fees.
	RefreshClosedReports interface{} `json:"refreshClosedReports" yaml:"refreshClosedReports"`
	// The name of the report that you want to create.
	//
	// The name must be unique, is case sensitive, and can't include spaces.
	ReportName *string `json:"reportName" yaml:"reportName"`
	// Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
	ReportVersioning *string `json:"reportVersioning" yaml:"reportVersioning"`
	// The S3 bucket where Amazon Web Services delivers the report.
	S3Bucket *string `json:"s3Bucket" yaml:"s3Bucket"`
	// The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
	//
	// Your prefix can't include spaces.
	S3Prefix *string `json:"s3Prefix" yaml:"s3Prefix"`
	// The Region of the S3 bucket that Amazon Web Services delivers the report into.
	S3Region *string `json:"s3Region" yaml:"s3Region"`
	// The granularity of the line items in the report.
	TimeUnit *string `json:"timeUnit" yaml:"timeUnit"`
	// A list of manifests that you want Amazon Web Services to create for this report.
	AdditionalArtifacts *[]*string `json:"additionalArtifacts" yaml:"additionalArtifacts"`
	// A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
	AdditionalSchemaElements *[]*string `json:"additionalSchemaElements" yaml:"additionalSchemaElements"`
	// The Amazon Resource Name (ARN) of the billing view.
	//
	// You can get this value by using the billing view service public APIs.
	BillingViewArn *string `json:"billingViewArn" yaml:"billingViewArn"`
}

Properties for defining a `CfnReportDefinition`.

TODO: EXAMPLE