CfnBudgetsAction

class aws_cdk.aws_budgets.CfnBudgetsAction(scope, id, *, action_threshold, action_type, budget_name, definition, execution_role_arn, notification_type, subscribers, approval_model=None, resource_tags=None)

Bases: CfnResource

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.

For more information, see Managing Your Costs with Budgets in the AWS Billing and Cost Management User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html

CloudformationResource:

AWS::Budgets::BudgetsAction

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

cfn_budgets_action = budgets.CfnBudgetsAction(self, "MyCfnBudgetsAction",
    action_threshold=budgets.CfnBudgetsAction.ActionThresholdProperty(
        type="type",
        value=123
    ),
    action_type="actionType",
    budget_name="budgetName",
    definition=budgets.CfnBudgetsAction.DefinitionProperty(
        iam_action_definition=budgets.CfnBudgetsAction.IamActionDefinitionProperty(
            policy_arn="policyArn",

            # the properties below are optional
            groups=["groups"],
            roles=["roles"],
            users=["users"]
        ),
        scp_action_definition=budgets.CfnBudgetsAction.ScpActionDefinitionProperty(
            policy_id="policyId",
            target_ids=["targetIds"]
        ),
        ssm_action_definition=budgets.CfnBudgetsAction.SsmActionDefinitionProperty(
            instance_ids=["instanceIds"],
            region="region",
            subtype="subtype"
        )
    ),
    execution_role_arn="executionRoleArn",
    notification_type="notificationType",
    subscribers=[budgets.CfnBudgetsAction.SubscriberProperty(
        address="address",
        type="type"
    )],

    # the properties below are optional
    approval_model="approvalModel",
    resource_tags=[budgets.CfnBudgetsAction.ResourceTagProperty(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • action_threshold (Union[IResolvable, ActionThresholdProperty, Dict[str, Any]]) – The trigger threshold of the action.

  • action_type (str) – The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

  • budget_name (str) – A string that represents the budget name. “:” and “” characters aren’t allowed.

  • definition (Union[IResolvable, DefinitionProperty, Dict[str, Any]]) – Specifies all of the type-specific parameters.

  • execution_role_arn (str) – The role passed for action execution and reversion. Roles and actions must be in the same account.

  • notification_type (str) – The type of a notification.

  • subscribers (Union[IResolvable, Sequence[Union[IResolvable, SubscriberProperty, Dict[str, Any]]]]) – A list of subscribers.

  • approval_model (Optional[str]) – This specifies if the action needs manual or automatic approval.

  • resource_tags (Optional[Sequence[Union[ResourceTagProperty, Dict[str, Any]]]]) – An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

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.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

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.

add_override(path, value)

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

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.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Budgets::BudgetsAction'
action_threshold

The trigger threshold of the action.

action_type

The type of action.

approval_model

This specifies if the action needs manual or automatic approval.

attr_action_id

A system-generated universally unique identifier (UUID) for the action.

CloudformationAttribute:

ActionId

budget_name

A string that represents the budget name.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

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.

definition

Specifies all of the type-specific parameters.

execution_role_arn

The role passed for action execution and reversion.

logical_id

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.

node

The tree node.

notification_type

The type of a notification.

ref

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 }).

resource_tags

An optional list of tags to associate with the specified budget action.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

subscribers

A list of subscribers.

Static Methods

classmethod is_cfn_element(x)

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.

Parameters:

x (Any) –

Return type:

bool

Returns:

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

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

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.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

ActionThresholdProperty

class CfnBudgetsAction.ActionThresholdProperty(*, type, value)

Bases: object

The trigger threshold of the action.

Parameters:

  • type (str) – The type of threshold for a notification.

  • value (Union[int, float]) – The threshold of a notification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

action_threshold_property = budgets.CfnBudgetsAction.ActionThresholdProperty(
    type="type",
    value=123
)

Attributes

type

The type of threshold for a notification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html#cfn-budgets-budgetsaction-actionthreshold-type

value

The threshold of a notification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html#cfn-budgets-budgetsaction-actionthreshold-value

DefinitionProperty

class CfnBudgetsAction.DefinitionProperty(*, iam_action_definition=None, scp_action_definition=None, ssm_action_definition=None)

Bases: object

The definition is where you specify all of the type-specific parameters.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

definition_property = budgets.CfnBudgetsAction.DefinitionProperty(
    iam_action_definition=budgets.CfnBudgetsAction.IamActionDefinitionProperty(
        policy_arn="policyArn",

        # the properties below are optional
        groups=["groups"],
        roles=["roles"],
        users=["users"]
    ),
    scp_action_definition=budgets.CfnBudgetsAction.ScpActionDefinitionProperty(
        policy_id="policyId",
        target_ids=["targetIds"]
    ),
    ssm_action_definition=budgets.CfnBudgetsAction.SsmActionDefinitionProperty(
        instance_ids=["instanceIds"],
        region="region",
        subtype="subtype"
    )
)

Attributes

iam_action_definition

The AWS Identity and Access Management ( IAM ) action definition details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-iamactiondefinition

scp_action_definition

The service control policies (SCP) action definition details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-scpactiondefinition

ssm_action_definition

The Amazon EC2 Systems Manager ( SSM ) action definition details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-ssmactiondefinition

IamActionDefinitionProperty

class CfnBudgetsAction.IamActionDefinitionProperty(*, policy_arn, groups=None, roles=None, users=None)

Bases: object

The AWS Identity and Access Management ( IAM ) action definition details.

Parameters:

  • policy_arn (str) – The Amazon Resource Name (ARN) of the policy to be attached.

  • groups (Optional[Sequence[str]]) – A list of groups to be attached. There must be at least one group.

  • roles (Optional[Sequence[str]]) – A list of roles to be attached. There must be at least one role.

  • users (Optional[Sequence[str]]) – A list of users to be attached. There must be at least one user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

iam_action_definition_property = budgets.CfnBudgetsAction.IamActionDefinitionProperty(
    policy_arn="policyArn",

    # the properties below are optional
    groups=["groups"],
    roles=["roles"],
    users=["users"]
)

Attributes

groups

A list of groups to be attached.

There must be at least one group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-groups

policy_arn

The Amazon Resource Name (ARN) of the policy to be attached.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-policyarn

roles

A list of roles to be attached.

There must be at least one role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-roles

users

A list of users to be attached.

There must be at least one user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-users

ResourceTagProperty

class CfnBudgetsAction.ResourceTagProperty(*, key, value)

Bases: object

The tag structure that contains a tag key and value.

Parameters:

  • key (str) – The key that’s associated with the tag.

  • value (str) – The value that’s associated with the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

resource_tag_property = budgets.CfnBudgetsAction.ResourceTagProperty(
    key="key",
    value="value"
)

Attributes

key

The key that’s associated with the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html#cfn-budgets-budgetsaction-resourcetag-key

value

The value that’s associated with the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html#cfn-budgets-budgetsaction-resourcetag-value

ScpActionDefinitionProperty

class CfnBudgetsAction.ScpActionDefinitionProperty(*, policy_id, target_ids)

Bases: object

The service control policies (SCP) action definition details.

Parameters:

  • policy_id (str) – The policy ID attached.

  • target_ids (Sequence[str]) – A list of target IDs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

scp_action_definition_property = budgets.CfnBudgetsAction.ScpActionDefinitionProperty(
    policy_id="policyId",
    target_ids=["targetIds"]
)

Attributes

policy_id

The policy ID attached.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-policyid

target_ids

A list of target IDs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-targetids

SsmActionDefinitionProperty

class CfnBudgetsAction.SsmActionDefinitionProperty(*, instance_ids, region, subtype)

Bases: object

The Amazon EC2 Systems Manager ( SSM ) action definition details.

Parameters:

  • instance_ids (Sequence[str]) – The EC2 and RDS instance IDs.

  • region (str) – The Region to run the ( SSM ) document.

  • subtype (str) – The action subType.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

ssm_action_definition_property = budgets.CfnBudgetsAction.SsmActionDefinitionProperty(
    instance_ids=["instanceIds"],
    region="region",
    subtype="subtype"
)

Attributes

instance_ids

The EC2 and RDS instance IDs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-instanceids

region

The Region to run the ( SSM ) document.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-region

subtype

The action subType.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-subtype

SubscriberProperty

class CfnBudgetsAction.SubscriberProperty(*, address, type)

Bases: object

The subscriber to a budget notification.

The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber has the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

Parameters:

  • address (str) – The address that AWS sends budget notifications to, either an SNS topic or an email. When you create a subscriber, the value of Address can’t contain line breaks.

  • type (str) – The type of notification that AWS sends to a subscriber.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

subscriber_property = budgets.CfnBudgetsAction.SubscriberProperty(
    address="address",
    type="type"
)

Attributes

address

The address that AWS sends budget notifications to, either an SNS topic or an email.

When you create a subscriber, the value of Address can’t contain line breaks.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-address

type

The type of notification that AWS sends to a subscriber.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-type