CfnBudgetsActionPropsMixin

class aws_cdk.mixins_preview.aws_budgets.mixins.CfnBudgetsActionPropsMixin(props, *, strategy=None)

Bases: Mixin

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 Billing and Cost Management User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html
CloudformationResource:: AWS::Budgets::BudgetsAction
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_budgets import mixins as budgets_mixins

cfn_budgets_action_props_mixin = budgets_mixins.CfnBudgetsActionPropsMixin(budgets_mixins.CfnBudgetsActionMixinProps(
    action_threshold=budgets_mixins.CfnBudgetsActionPropsMixin.ActionThresholdProperty(
        type="type",
        value=123
    ),
    action_type="actionType",
    approval_model="approvalModel",
    budget_name="budgetName",
    definition=budgets_mixins.CfnBudgetsActionPropsMixin.DefinitionProperty(
        iam_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.IamActionDefinitionProperty(
            groups=["groups"],
            policy_arn="policyArn",
            roles=["roles"],
            users=["users"]
        ),
        scp_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.ScpActionDefinitionProperty(
            policy_id="policyId",
            target_ids=["targetIds"]
        ),
        ssm_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.SsmActionDefinitionProperty(
            instance_ids=["instanceIds"],
            region="region",
            subtype="subtype"
        )
    ),
    execution_role_arn="executionRoleArn",
    notification_type="notificationType",
    resource_tags=[budgets_mixins.CfnBudgetsActionPropsMixin.ResourceTagProperty(
        key="key",
        value="value"
    )],
    subscribers=[budgets_mixins.CfnBudgetsActionPropsMixin.SubscriberProperty(
        address="address",
        type="type"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Budgets::BudgetsAction.

Parameters:

props (Union[CfnBudgetsActionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['actionThreshold', 'actionType', 'approvalModel', 'budgetName', 'definition', 'executionRoleArn', 'notificationType', 'resourceTags', 'subscribers']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActionThresholdProperty

class CfnBudgetsActionPropsMixin.ActionThresholdProperty(*, type=None, value=None)

Bases: object

The trigger threshold of the action.

Parameters:

type (Optional[str]) – The type of threshold for a notification.
value (Union[int, float, None]) – 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.mixins_preview.aws_budgets import mixins as budgets_mixins

action_threshold_property = budgets_mixins.CfnBudgetsActionPropsMixin.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 CfnBudgetsActionPropsMixin.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:

iam_action_definition (Union[IResolvable, IamActionDefinitionProperty, Dict[str, Any], None]) – The AWS Identity and Access Management ( IAM ) action definition details.
scp_action_definition (Union[IResolvable, ScpActionDefinitionProperty, Dict[str, Any], None]) – The service control policies (SCP) action definition details.
ssm_action_definition (Union[IResolvable, SsmActionDefinitionProperty, Dict[str, Any], None]) – The Amazon EC2 Systems Manager ( SSM ) action definition details.

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.mixins_preview.aws_budgets import mixins as budgets_mixins

definition_property = budgets_mixins.CfnBudgetsActionPropsMixin.DefinitionProperty(
    iam_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.IamActionDefinitionProperty(
        groups=["groups"],
        policy_arn="policyArn",
        roles=["roles"],
        users=["users"]
    ),
    scp_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.ScpActionDefinitionProperty(
        policy_id="policyId",
        target_ids=["targetIds"]
    ),
    ssm_action_definition=budgets_mixins.CfnBudgetsActionPropsMixin.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 CfnBudgetsActionPropsMixin.IamActionDefinitionProperty(*, groups=None, policy_arn=None, roles=None, users=None)

Bases: object

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

Parameters:

groups (Optional[Sequence[str]]) – A list of groups to be attached. There must be at least one group.
policy_arn (Optional[str]) – The Amazon Resource Name (ARN) of the policy to be attached.
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.mixins_preview.aws_budgets import mixins as budgets_mixins

iam_action_definition_property = budgets_mixins.CfnBudgetsActionPropsMixin.IamActionDefinitionProperty(
    groups=["groups"],
    policy_arn="policyArn",
    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 CfnBudgetsActionPropsMixin.ResourceTagProperty(*, key=None, value=None)

Bases: object

The tag structure that contains a tag key and value.

Parameters:

key (Optional[str]) – The key that’s associated with the tag.
value (Optional[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.mixins_preview.aws_budgets import mixins as budgets_mixins

resource_tag_property = budgets_mixins.CfnBudgetsActionPropsMixin.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 CfnBudgetsActionPropsMixin.ScpActionDefinitionProperty(*, policy_id=None, target_ids=None)

Bases: object

The service control policies (SCP) action definition details.

Parameters:

policy_id (Optional[str]) – The policy ID attached.
target_ids (Optional[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.mixins_preview.aws_budgets import mixins as budgets_mixins

scp_action_definition_property = budgets_mixins.CfnBudgetsActionPropsMixin.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 CfnBudgetsActionPropsMixin.SsmActionDefinitionProperty(*, instance_ids=None, region=None, subtype=None)

Bases: object

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

Parameters:

instance_ids (Optional[Sequence[str]]) – The EC2 and RDS instance IDs.
region (Optional[str]) – The Region to run the ( SSM ) document.
subtype (Optional[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.mixins_preview.aws_budgets import mixins as budgets_mixins

ssm_action_definition_property = budgets_mixins.CfnBudgetsActionPropsMixin.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 CfnBudgetsActionPropsMixin.SubscriberProperty(*, address=None, type=None)

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 (Optional[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 (Optional[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.mixins_preview.aws_budgets import mixins as budgets_mixins

subscriber_property = budgets_mixins.CfnBudgetsActionPropsMixin.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