Documentation
¶
Index ¶
- func CfnAnomalyMonitor_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAnomalyMonitor_IsCfnElement(x interface{}) *bool
- func CfnAnomalyMonitor_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAnomalyMonitor_IsConstruct(x interface{}) *bool
- func CfnAnomalySubscription_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAnomalySubscription_IsCfnElement(x interface{}) *bool
- func CfnAnomalySubscription_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAnomalySubscription_IsConstruct(x interface{}) *bool
- func CfnCostCategory_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCostCategory_IsCfnElement(x interface{}) *bool
- func CfnCostCategory_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCostCategory_IsConstruct(x interface{}) *bool
- func NewCfnAnomalyMonitor_Override(c CfnAnomalyMonitor, scope awscdk.Construct, id *string, ...)
- func NewCfnAnomalySubscription_Override(c CfnAnomalySubscription, scope awscdk.Construct, id *string, ...)
- func NewCfnCostCategory_Override(c CfnCostCategory, scope awscdk.Construct, id *string, ...)
- type CfnAnomalyMonitor
- type CfnAnomalyMonitorProps
- type CfnAnomalyMonitor_ResourceTagProperty
- type CfnAnomalySubscription
- type CfnAnomalySubscriptionProps
- type CfnAnomalySubscription_ResourceTagProperty
- type CfnAnomalySubscription_SubscriberProperty
- type CfnCostCategory
- type CfnCostCategoryProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAnomalyMonitor_CFN_RESOURCE_TYPE_NAME ¶
func CfnAnomalyMonitor_CFN_RESOURCE_TYPE_NAME() *string
func CfnAnomalyMonitor_IsCfnElement ¶
func CfnAnomalyMonitor_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. Experimental.
func CfnAnomalyMonitor_IsCfnResource ¶
func CfnAnomalyMonitor_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAnomalyMonitor_IsConstruct ¶
func CfnAnomalyMonitor_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnAnomalySubscription_CFN_RESOURCE_TYPE_NAME ¶
func CfnAnomalySubscription_CFN_RESOURCE_TYPE_NAME() *string
func CfnAnomalySubscription_IsCfnElement ¶
func CfnAnomalySubscription_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. Experimental.
func CfnAnomalySubscription_IsCfnResource ¶
func CfnAnomalySubscription_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAnomalySubscription_IsConstruct ¶
func CfnAnomalySubscription_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnCostCategory_CFN_RESOURCE_TYPE_NAME ¶
func CfnCostCategory_CFN_RESOURCE_TYPE_NAME() *string
func CfnCostCategory_IsCfnElement ¶
func CfnCostCategory_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. Experimental.
func CfnCostCategory_IsCfnResource ¶
func CfnCostCategory_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCostCategory_IsConstruct ¶
func CfnCostCategory_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnAnomalyMonitor_Override ¶
func NewCfnAnomalyMonitor_Override(c CfnAnomalyMonitor, scope awscdk.Construct, id *string, props *CfnAnomalyMonitorProps)
Create a new `AWS::CE::AnomalyMonitor`.
func NewCfnAnomalySubscription_Override ¶
func NewCfnAnomalySubscription_Override(c CfnAnomalySubscription, scope awscdk.Construct, id *string, props *CfnAnomalySubscriptionProps)
Create a new `AWS::CE::AnomalySubscription`.
func NewCfnCostCategory_Override ¶
func NewCfnCostCategory_Override(c CfnCostCategory, scope awscdk.Construct, id *string, props *CfnCostCategoryProps)
Create a new `AWS::CE::CostCategory`.
Types ¶
type CfnAnomalyMonitor ¶
type CfnAnomalyMonitor interface {
awscdk.CfnResource
awscdk.IInspectable
// The date when the monitor was created.
AttrCreationDate() *string
// The value for evaluated dimensions.
AttrDimensionalValueCount() *float64
// The date when the monitor last evaluated for anomalies.
AttrLastEvaluatedDate() *string
// The date when the monitor was last updated.
AttrLastUpdatedDate() *string
// The Amazon Resource Name (ARN) value for the monitor.
AttrMonitorArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *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.
// Experimental.
CreationStack() *[]*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.
// Experimental.
LogicalId() *string
// The dimensions to evaluate.
MonitorDimension() *string
SetMonitorDimension(val *string)
// The name of the monitor.
MonitorName() *string
SetMonitorName(val *string)
// The array of `MonitorSpecification` in JSON array format.
//
// For instance, you can use `MonitorSpecification` to specify a tag, Cost Category, or linked account for your custom anomaly monitor. For further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#aws-resource-ce-anomalymonitor--examples) section of this page.
MonitorSpecification() *string
SetMonitorSpecification(val *string)
// The possible type values.
MonitorType() *string
SetMonitorType(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// `AWS::CE::AnomalyMonitor.ResourceTags`.
ResourceTags() interface{}
SetResourceTags(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::CE::AnomalyMonitor`.
The `AWS::CE::AnomalyMonitor` resource is a Cost Explorer resource type that continuously inspects your account's cost data for anomalies, based on `MonitorType` and `MonitorSpecification` . The content consists of detailed metadata and the current status of the monitor object.
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"
cfnAnomalyMonitor := awscdk.Aws_ce.NewCfnAnomalyMonitor(this, jsii.String("MyCfnAnomalyMonitor"), &cfnAnomalyMonitorProps{
monitorName: jsii.String("monitorName"),
monitorType: jsii.String("monitorType"),
// the properties below are optional
monitorDimension: jsii.String("monitorDimension"),
monitorSpecification: jsii.String("monitorSpecification"),
resourceTags: []interface{}{
&resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnAnomalyMonitor ¶
func NewCfnAnomalyMonitor(scope awscdk.Construct, id *string, props *CfnAnomalyMonitorProps) CfnAnomalyMonitor
Create a new `AWS::CE::AnomalyMonitor`.
type CfnAnomalyMonitorProps ¶
type CfnAnomalyMonitorProps struct {
// The name of the monitor.
MonitorName *string `field:"required" json:"monitorName" yaml:"monitorName"`
// The possible type values.
MonitorType *string `field:"required" json:"monitorType" yaml:"monitorType"`
// The dimensions to evaluate.
MonitorDimension *string `field:"optional" json:"monitorDimension" yaml:"monitorDimension"`
// The array of `MonitorSpecification` in JSON array format.
//
// For instance, you can use `MonitorSpecification` to specify a tag, Cost Category, or linked account for your custom anomaly monitor. For further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#aws-resource-ce-anomalymonitor--examples) section of this page.
MonitorSpecification *string `field:"optional" json:"monitorSpecification" yaml:"monitorSpecification"`
// `AWS::CE::AnomalyMonitor.ResourceTags`.
ResourceTags interface{} `field:"optional" json:"resourceTags" yaml:"resourceTags"`
}
Properties for defining a `CfnAnomalyMonitor`.
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"
cfnAnomalyMonitorProps := &cfnAnomalyMonitorProps{
monitorName: jsii.String("monitorName"),
monitorType: jsii.String("monitorType"),
// the properties below are optional
monitorDimension: jsii.String("monitorDimension"),
monitorSpecification: jsii.String("monitorSpecification"),
resourceTags: []interface{}{
&resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnAnomalyMonitor_ResourceTagProperty ¶
type CfnAnomalyMonitor_ResourceTagProperty struct {
// The key that's associated with the tag.
Key *string `field:"required" json:"key" yaml:"key"`
// The value that's associated with the tag.
Value *string `field:"required" json:"value" yaml:"value"`
}
The tag structure that contains a tag key and value.
> Tagging is supported only for the following Cost Explorer resource types: [`AnomalyMonitor`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) , [`AnomalySubscription`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) , [`CostCategory`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html) .
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"
resourceTagProperty := &resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
}
type CfnAnomalySubscription ¶
type CfnAnomalySubscription interface {
awscdk.CfnResource
awscdk.IInspectable
// Your unique account identifier.
AttrAccountId() *string
// The `AnomalySubscription` Amazon Resource Name (ARN).
AttrSubscriptionArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *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.
// Experimental.
CreationStack() *[]*string
// The frequency that anomaly reports are sent over email.
Frequency() *string
SetFrequency(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.
// Experimental.
LogicalId() *string
// A list of cost anomaly monitors.
MonitorArnList() *[]*string
SetMonitorArnList(val *[]*string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// `AWS::CE::AnomalySubscription.ResourceTags`.
ResourceTags() interface{}
SetResourceTags(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// A list of subscribers to notify.
Subscribers() interface{}
SetSubscribers(val interface{})
// The name for the subscription.
SubscriptionName() *string
SetSubscriptionName(val *string)
// The dollar value that triggers a notification if the threshold is exceeded.
Threshold() *float64
SetThreshold(val *float64)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::CE::AnomalySubscription`.
The `AWS::CE::AnomalySubscription` resource is a Cost Explorer resource type that associates a monitor, threshold, and list of subscribers. It delivers notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the `AnomalySubscription` object.
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"
cfnAnomalySubscription := awscdk.Aws_ce.NewCfnAnomalySubscription(this, jsii.String("MyCfnAnomalySubscription"), &cfnAnomalySubscriptionProps{
frequency: jsii.String("frequency"),
monitorArnList: []*string{
jsii.String("monitorArnList"),
},
subscribers: []interface{}{
&subscriberProperty{
address: jsii.String("address"),
type: jsii.String("type"),
// the properties below are optional
status: jsii.String("status"),
},
},
subscriptionName: jsii.String("subscriptionName"),
threshold: jsii.Number(123),
// the properties below are optional
resourceTags: []interface{}{
&resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnAnomalySubscription ¶
func NewCfnAnomalySubscription(scope awscdk.Construct, id *string, props *CfnAnomalySubscriptionProps) CfnAnomalySubscription
Create a new `AWS::CE::AnomalySubscription`.
type CfnAnomalySubscriptionProps ¶
type CfnAnomalySubscriptionProps struct {
// The frequency that anomaly reports are sent over email.
Frequency *string `field:"required" json:"frequency" yaml:"frequency"`
// A list of cost anomaly monitors.
MonitorArnList *[]*string `field:"required" json:"monitorArnList" yaml:"monitorArnList"`
// A list of subscribers to notify.
Subscribers interface{} `field:"required" json:"subscribers" yaml:"subscribers"`
// The name for the subscription.
SubscriptionName *string `field:"required" json:"subscriptionName" yaml:"subscriptionName"`
// The dollar value that triggers a notification if the threshold is exceeded.
Threshold *float64 `field:"required" json:"threshold" yaml:"threshold"`
// `AWS::CE::AnomalySubscription.ResourceTags`.
ResourceTags interface{} `field:"optional" json:"resourceTags" yaml:"resourceTags"`
}
Properties for defining a `CfnAnomalySubscription`.
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"
cfnAnomalySubscriptionProps := &cfnAnomalySubscriptionProps{
frequency: jsii.String("frequency"),
monitorArnList: []*string{
jsii.String("monitorArnList"),
},
subscribers: []interface{}{
&subscriberProperty{
address: jsii.String("address"),
type: jsii.String("type"),
// the properties below are optional
status: jsii.String("status"),
},
},
subscriptionName: jsii.String("subscriptionName"),
threshold: jsii.Number(123),
// the properties below are optional
resourceTags: []interface{}{
&resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnAnomalySubscription_ResourceTagProperty ¶
type CfnAnomalySubscription_ResourceTagProperty struct {
// The key that's associated with the tag.
Key *string `field:"required" json:"key" yaml:"key"`
// The value that's associated with the tag.
Value *string `field:"required" json:"value" yaml:"value"`
}
The tag structure that contains a tag key and value.
> Tagging is supported only for the following Cost Explorer resource types: [`AnomalyMonitor`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) , [`AnomalySubscription`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) , [`CostCategory`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html) .
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"
resourceTagProperty := &resourceTagProperty{
key: jsii.String("key"),
value: jsii.String("value"),
}
type CfnAnomalySubscription_SubscriberProperty ¶
type CfnAnomalySubscription_SubscriberProperty struct {
// The email address or SNS Topic Amazon Resource Name (ARN), depending on the `Type` .
Address *string `field:"required" json:"address" yaml:"address"`
// The notification delivery channel.
Type *string `field:"required" json:"type" yaml:"type"`
// Indicates if the subscriber accepts the notifications.
Status *string `field:"optional" json:"status" yaml:"status"`
}
The recipient of `AnomalySubscription` notifications.
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"
subscriberProperty := &subscriberProperty{
address: jsii.String("address"),
type: jsii.String("type"),
// the properties below are optional
status: jsii.String("status"),
}
type CfnCostCategory ¶
type CfnCostCategory interface {
awscdk.CfnResource
awscdk.IInspectable
// The unique identifier for your Cost Category.
AttrArn() *string
// The Cost Category's effective start date.
AttrEffectiveStart() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *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.
// Experimental.
CreationStack() *[]*string
// The default value for the cost category.
DefaultValue() *string
SetDefaultValue(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.
// Experimental.
LogicalId() *string
// The unique name of the Cost Category.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The array of CostCategoryRule in JSON array format.
//
// > Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
Rules() *string
SetRules(val *string)
// The rule schema version in this particular Cost Category.
RuleVersion() *string
SetRuleVersion(val *string)
// The split charge rules that are used to allocate your charges between your Cost Category values.
SplitChargeRules() *string
SetSplitChargeRules(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::CE::CostCategory`.
The `AWS::CE::CostCategory` resource creates groupings of cost that you can use across products in the AWS Billing and Cost Management console, such as Cost Explorer and AWS Budgets. For more information, see [Managing Your Costs with Cost Categories](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html) in the *AWS Billing and Cost Management User Guide* .
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"
cfnCostCategory := awscdk.Aws_ce.NewCfnCostCategory(this, jsii.String("MyCfnCostCategory"), &cfnCostCategoryProps{
name: jsii.String("name"),
rules: jsii.String("rules"),
ruleVersion: jsii.String("ruleVersion"),
// the properties below are optional
defaultValue: jsii.String("defaultValue"),
splitChargeRules: jsii.String("splitChargeRules"),
})
func NewCfnCostCategory ¶
func NewCfnCostCategory(scope awscdk.Construct, id *string, props *CfnCostCategoryProps) CfnCostCategory
Create a new `AWS::CE::CostCategory`.
type CfnCostCategoryProps ¶
type CfnCostCategoryProps struct {
// The unique name of the Cost Category.
Name *string `field:"required" json:"name" yaml:"name"`
// The array of CostCategoryRule in JSON array format.
//
// > Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
Rules *string `field:"required" json:"rules" yaml:"rules"`
// The rule schema version in this particular Cost Category.
RuleVersion *string `field:"required" json:"ruleVersion" yaml:"ruleVersion"`
// The default value for the cost category.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The split charge rules that are used to allocate your charges between your Cost Category values.
SplitChargeRules *string `field:"optional" json:"splitChargeRules" yaml:"splitChargeRules"`
}
Properties for defining a `CfnCostCategory`.
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"
cfnCostCategoryProps := &cfnCostCategoryProps{
name: jsii.String("name"),
rules: jsii.String("rules"),
ruleVersion: jsii.String("ruleVersion"),
// the properties below are optional
defaultValue: jsii.String("defaultValue"),
splitChargeRules: jsii.String("splitChargeRules"),
}
Source Files
¶
- awsce.go
- awsce_CfnAnomalyMonitor.go
- awsce_CfnAnomalyMonitorProps.go
- awsce_CfnAnomalyMonitor_ResourceTagProperty.go
- awsce_CfnAnomalyMonitor__runtime_type_checks.go
- awsce_CfnAnomalySubscription.go
- awsce_CfnAnomalySubscriptionProps.go
- awsce_CfnAnomalySubscription_ResourceTagProperty.go
- awsce_CfnAnomalySubscription_SubscriberProperty.go
- awsce_CfnAnomalySubscription__runtime_type_checks.go
- awsce_CfnCostCategory.go
- awsce_CfnCostCategoryProps.go
- awsce_CfnCostCategory__runtime_type_checks.go