awsce

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 constructs.Construct, id *string, ...)
• func NewCfnAnomalySubscription_Override(c CfnAnomalySubscription, scope constructs.Construct, id *string, ...)
• func NewCfnCostCategory_Override(c CfnCostCategory, scope constructs.Construct, id *string, ...)
• type CfnAnomalyMonitor
  • func NewCfnAnomalyMonitor(scope constructs.Construct, id *string, props *CfnAnomalyMonitorProps) CfnAnomalyMonitor
• type CfnAnomalyMonitorProps
• type CfnAnomalySubscription
  • func NewCfnAnomalySubscription(scope constructs.Construct, id *string, props *CfnAnomalySubscriptionProps) CfnAnomalySubscription
• type CfnAnomalySubscriptionProps
• type CfnAnomalySubscription_SubscriberProperty
• type CfnCostCategory
  • func NewCfnCostCategory(scope constructs.Construct, id *string, props *CfnCostCategoryProps) CfnCostCategory
• type CfnCostCategoryProps

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.

func CfnAnomalyMonitor_IsCfnResource

func CfnAnomalyMonitor_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAnomalyMonitor_IsConstruct

func CfnAnomalyMonitor_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 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.

func CfnAnomalySubscription_IsCfnResource

func CfnAnomalySubscription_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAnomalySubscription_IsConstruct

func CfnAnomalySubscription_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 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.

func CfnCostCategory_IsCfnResource

func CfnCostCategory_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCostCategory_IsConstruct

func CfnCostCategory_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 NewCfnAnomalyMonitor_Override

func NewCfnAnomalyMonitor_Override(c CfnAnomalyMonitor, scope constructs.Construct, id *string, props *CfnAnomalyMonitorProps)

Create a new `AWS::CE::AnomalyMonitor`.

func NewCfnAnomalySubscription_Override

func NewCfnAnomalySubscription_Override(c CfnAnomalySubscription, scope constructs.Construct, id *string, props *CfnAnomalySubscriptionProps)

Create a new `AWS::CE::AnomalySubscription`.

func NewCfnCostCategory_Override

func NewCfnCostCategory_Override(c CfnCostCategory, scope constructs.Construct, id *string, props *CfnCostCategoryProps)

Create a new `AWS::CE::CostCategory`.

Types

type CfnAnomalyMonitor

type CfnAnomalyMonitor interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationDate() *string
	AttrDimensionalValueCount() *float64
	AttrLastEvaluatedDate() *string
	AttrLastUpdatedDate() *string
	AttrMonitorArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	MonitorDimension() *string
	SetMonitorDimension(val *string)
	MonitorName() *string
	SetMonitorName(val *string)
	MonitorSpecification() *string
	SetMonitorSpecification(val *string)
	MonitorType() *string
	SetMonitorType(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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::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.

TODO: EXAMPLE

func NewCfnAnomalyMonitor

func NewCfnAnomalyMonitor(scope constructs.Construct, id *string, props *CfnAnomalyMonitorProps) CfnAnomalyMonitor

Create a new `AWS::CE::AnomalyMonitor`.

type CfnAnomalyMonitorProps

type CfnAnomalyMonitorProps struct {
	// The name of the monitor.
	MonitorName *string `json:"monitorName" yaml:"monitorName"`
	// The possible type values.
	MonitorType *string `json:"monitorType" yaml:"monitorType"`
	// The dimensions to evaluate.
	MonitorDimension *string `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 `json:"monitorSpecification" yaml:"monitorSpecification"`
}

Properties for defining a `CfnAnomalyMonitor`.

TODO: EXAMPLE

type CfnAnomalySubscription

type CfnAnomalySubscription interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAccountId() *string
	AttrSubscriptionArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Frequency() *string
	SetFrequency(val *string)
	LogicalId() *string
	MonitorArnList() *[]*string
	SetMonitorArnList(val *[]*string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Subscribers() interface{}
	SetSubscribers(val interface{})
	SubscriptionName() *string
	SetSubscriptionName(val *string)
	Threshold() *float64
	SetThreshold(val *float64)
	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::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.

TODO: EXAMPLE

func NewCfnAnomalySubscription

func NewCfnAnomalySubscription(scope constructs.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 `json:"frequency" yaml:"frequency"`
	// A list of cost anomaly monitors.
	MonitorArnList *[]*string `json:"monitorArnList" yaml:"monitorArnList"`
	// A list of subscribers to notify.
	Subscribers interface{} `json:"subscribers" yaml:"subscribers"`
	// The name for the subscription.
	SubscriptionName *string `json:"subscriptionName" yaml:"subscriptionName"`
	// The dollar value that triggers a notification if the threshold is exceeded.
	Threshold *float64 `json:"threshold" yaml:"threshold"`
}

Properties for defining a `CfnAnomalySubscription`.

TODO: EXAMPLE

type CfnAnomalySubscription_SubscriberProperty

type CfnAnomalySubscription_SubscriberProperty struct {
	// The email address or SNS Topic Amazon Resource Name (ARN), depending on the `Type` .
	Address *string `json:"address" yaml:"address"`
	// The notification delivery channel.
	Type *string `json:"type" yaml:"type"`
	// Indicates if the subscriber accepts the notifications.
	Status *string `json:"status" yaml:"status"`
}

The recipient of `AnomalySubscription` notifications.

TODO: EXAMPLE

type CfnCostCategory

type CfnCostCategory interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrEffectiveStart() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultValue() *string
	SetDefaultValue(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Rules() *string
	SetRules(val *string)
	RuleVersion() *string
	SetRuleVersion(val *string)
	SplitChargeRules() *string
	SetSplitChargeRules(val *string)
	Stack() awscdk.Stack
	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::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* .

TODO: EXAMPLE

func NewCfnCostCategory

func NewCfnCostCategory(scope constructs.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 `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 `json:"rules" yaml:"rules"`
	// The rule schema version in this particular Cost Category.
	RuleVersion *string `json:"ruleVersion" yaml:"ruleVersion"`
	// The default value for the cost category.
	DefaultValue *string `json:"defaultValue" yaml:"defaultValue"`
	// The split charge rules that are used to allocate your charges between your Cost Category values.
	SplitChargeRules *string `json:"splitChargeRules" yaml:"splitChargeRules"`
}

Properties for defining a `CfnCostCategory`.

TODO: EXAMPLE