CfnBudgetsActionProps

class aws_cdk.aws_budgets.CfnBudgetsActionProps(*, action_threshold, action_type, budget_name, definition, execution_role_arn, notification_type, subscribers, approval_model=None)

Bases: object

Properties for defining a CfnBudgetsAction.

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

Link

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.
import aws_cdk.aws_budgets as budgets

cfn_budgets_action_props = budgets.CfnBudgetsActionProps(
    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"
)

Attributes

action_threshold

The trigger threshold of the action.

Link

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

Return type

Union[IResolvable, ActionThresholdProperty]

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.

Link

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

Return type

str

approval_model

This specifies if the action needs manual or automatic approval.

Link

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

Return type

Optional[str]

budget_name

A string that represents the budget name.

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

Link

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

Return type

str

definition

Specifies all of the type-specific parameters.

Link

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

Return type

Union[IResolvable, DefinitionProperty]

execution_role_arn

The role passed for action execution and reversion.

Roles and actions must be in the same account.

Link

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

Return type

str

notification_type

The type of a notification.

Link

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

Return type

str

subscribers

A list of subscribers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, SubscriberProperty]]]