CfnBudgetsActionMixinProps

class aws_cdk.mixins_preview.aws_budgets.mixins.CfnBudgetsActionMixinProps(*, action_threshold=None, action_type=None, approval_model=None, budget_name=None, definition=None, execution_role_arn=None, notification_type=None, resource_tags=None, subscribers=None)

Bases: object

Properties for CfnBudgetsActionPropsMixin.

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

  • action_type (Optional[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.

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

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

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

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

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

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.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

cfn_budgets_action_mixin_props = 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"
    )]
)

Attributes

action_threshold

The trigger threshold of the action.

See:

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

action_type

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.

See:

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

approval_model

This specifies if the action needs manual or automatic approval.

See:

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

budget_name

A string that represents the budget name.

“:” and “” characters aren’t allowed.

See:

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

definition

Specifies all of the type-specific parameters.

See:

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

execution_role_arn

The role passed for action execution and reversion.

Roles and actions must be in the same account.

See:

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

notification_type

The type of a notification.

See:

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

resource_tags

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.

See:

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

subscribers

A list of subscribers.

See:

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