awscur

README

AWS::CUR Construct Library

This module is part of the AWS Cloud Development Kit project.

import cur "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for CUR construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::CUR resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::CUR.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

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.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

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
	// A list of manifests that you want AWS to create for this report.
	AdditionalArtifacts() *[]*string
	SetAdditionalArtifacts(val *[]*string)
	// A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
	AdditionalSchemaElements() *[]*string
	SetAdditionalSchemaElements(val *[]*string)
	// The Amazon Resource Name (ARN) of the billing view.
	//
	// You can get this value by using the billing view service public APIs.
	BillingViewArn() *string
	SetBillingViewArn(val *string)
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// The compression format that Amazon Web Services uses for the report.
	Compression() *string
	SetCompression(val *string)
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The format that Amazon Web Services saves the report in.
	Format() *string
	SetFormat(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
	//
	// These charges can include refunds, credits, or support fees.
	RefreshClosedReports() interface{}
	SetRefreshClosedReports(val interface{})
	// 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
	SetReportName(val *string)
	// Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
	ReportVersioning() *string
	SetReportVersioning(val *string)
	// The S3 bucket where Amazon Web Services delivers the report.
	S3Bucket() *string
	SetS3Bucket(val *string)
	// 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
	SetS3Prefix(val *string)
	// The Region of the S3 bucket that Amazon Web Services delivers the report into.
	S3Region() *string
	SetS3Region(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The granularity of the line items in the report.
	TimeUnit() *string
	SetTimeUnit(val *string)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	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.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReportDefinition := awscdk.Aws_cur.NewCfnReportDefinition(this, jsii.String("MyCfnReportDefinition"), &cfnReportDefinitionProps{
	compression: jsii.String("compression"),
	format: jsii.String("format"),
	refreshClosedReports: jsii.Boolean(false),
	reportName: jsii.String("reportName"),
	reportVersioning: jsii.String("reportVersioning"),
	s3Bucket: jsii.String("s3Bucket"),
	s3Prefix: jsii.String("s3Prefix"),
	s3Region: jsii.String("s3Region"),
	timeUnit: jsii.String("timeUnit"),

	// the properties below are optional
	additionalArtifacts: []*string{
		jsii.String("additionalArtifacts"),
	},
	additionalSchemaElements: []*string{
		jsii.String("additionalSchemaElements"),
	},
	billingViewArn: jsii.String("billingViewArn"),
})

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 `field:"required" json:"compression" yaml:"compression"`
	// The format that Amazon Web Services saves the report in.
	Format *string `field:"required" json:"format" yaml:"format"`
	// Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
	//
	// These charges can include refunds, credits, or support fees.
	RefreshClosedReports interface{} `field:"required" 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 `field:"required" json:"reportName" yaml:"reportName"`
	// Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
	ReportVersioning *string `field:"required" json:"reportVersioning" yaml:"reportVersioning"`
	// The S3 bucket where Amazon Web Services delivers the report.
	S3Bucket *string `field:"required" 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 `field:"required" json:"s3Prefix" yaml:"s3Prefix"`
	// The Region of the S3 bucket that Amazon Web Services delivers the report into.
	S3Region *string `field:"required" json:"s3Region" yaml:"s3Region"`
	// The granularity of the line items in the report.
	TimeUnit *string `field:"required" json:"timeUnit" yaml:"timeUnit"`
	// A list of manifests that you want AWS to create for this report.
	AdditionalArtifacts *[]*string `field:"optional" json:"additionalArtifacts" yaml:"additionalArtifacts"`
	// A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
	AdditionalSchemaElements *[]*string `field:"optional" 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 `field:"optional" json:"billingViewArn" yaml:"billingViewArn"`
}

Properties for defining a `CfnReportDefinition`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReportDefinitionProps := &cfnReportDefinitionProps{
	compression: jsii.String("compression"),
	format: jsii.String("format"),
	refreshClosedReports: jsii.Boolean(false),
	reportName: jsii.String("reportName"),
	reportVersioning: jsii.String("reportVersioning"),
	s3Bucket: jsii.String("s3Bucket"),
	s3Prefix: jsii.String("s3Prefix"),
	s3Region: jsii.String("s3Region"),
	timeUnit: jsii.String("timeUnit"),

	// the properties below are optional
	additionalArtifacts: []*string{
		jsii.String("additionalArtifacts"),
	},
	additionalSchemaElements: []*string{
		jsii.String("additionalSchemaElements"),
	},
	billingViewArn: jsii.String("billingViewArn"),
}