Package software.amazon.awscdk.cfnpropertymixins.services.budgets

Interface CfnBudgetsActionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBudgetsActionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.778Z")
@Stability(Stable)
public interface CfnBudgetsActionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnBudgetsActionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.budgets.*;
 CfnBudgetsActionMixinProps cfnBudgetsActionMixinProps = CfnBudgetsActionMixinProps.builder()
         .actionThreshold(ActionThresholdProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .actionType("actionType")
         .approvalModel("approvalModel")
         .budgetName("budgetName")
         .definition(DefinitionProperty.builder()
                 .iamActionDefinition(IamActionDefinitionProperty.builder()
                         .groups(List.of("groups"))
                         .policyArn("policyArn")
                         .roles(List.of("roles"))
                         .users(List.of("users"))
                         .build())
                 .scpActionDefinition(ScpActionDefinitionProperty.builder()
                         .policyId("policyId")
                         .targetIds(List.of("targetIds"))
                         .build())
                 .ssmActionDefinition(SsmActionDefinitionProperty.builder()
                         .instanceIds(List.of("instanceIds"))
                         .region("region")
                         .subtype("subtype")
                         .build())
                 .build())
         .executionRoleArn("executionRoleArn")
         .notificationType("notificationType")
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .subscribers(List.of(SubscriberProperty.builder()
                 .address("address")
                 .type("type")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBudgetsActionMixinProps.Builder	A builder for CfnBudgetsActionMixinProps
static final class	CfnBudgetsActionMixinProps.Jsii$Proxy	An implementation for CfnBudgetsActionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnBudgetsActionMixinProps.Builder	builder()
default Object	getActionThreshold()	The trigger threshold of the action.
default String	getActionType()	The type of action.
default String	getApprovalModel()	This specifies if the action needs manual or automatic approval.
default String	getBudgetName()	A string that represents the budget name.
default Object	getDefinition()	Specifies all of the type-specific parameters.
default String	getExecutionRoleArn()	The role passed for action execution and reversion.
default String	getNotificationType()	The type of a notification.
default List<CfnBudgetsActionPropsMixin.ResourceTagProperty>	getResourceTags()	An optional list of tags to associate with the specified budget action.
default Object	getSubscribers()	A list of subscribers.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionThreshold

@Stability(Stable)
@Nullable
default Object getActionThreshold()

The trigger threshold of the action.

Returns union: either IResolvable or CfnBudgetsActionPropsMixin.ActionThresholdProperty

See Also:

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

getActionType

@Stability(Stable)
@Nullable
default String getActionType()

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 Also:

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

getApprovalModel

@Stability(Stable)
@Nullable
default String getApprovalModel()

This specifies if the action needs manual or automatic approval.

See Also:

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

getBudgetName

@Stability(Stable)
@Nullable
default String getBudgetName()

A string that represents the budget name.

":" and "" characters aren't allowed.

See Also:

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

getDefinition

@Stability(Stable)
@Nullable
default Object getDefinition()

Specifies all of the type-specific parameters.

Returns union: either IResolvable or CfnBudgetsActionPropsMixin.DefinitionProperty

See Also:

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

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

The role passed for action execution and reversion.

Roles and actions must be in the same account.

See Also:

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

getNotificationType

@Stability(Stable)
@Nullable
default String getNotificationType()

The type of a notification.

See Also:

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

getResourceTags

@Stability(Stable)
@Nullable
default List<CfnBudgetsActionPropsMixin.ResourceTagProperty> getResourceTags()

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 Also:

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

getSubscribers

@Stability(Stable)
@Nullable
default Object getSubscribers()

A list of subscribers.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBudgetsActionPropsMixin.SubscriberProperty>

See Also:

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

builder

@Stability(Stable)
static CfnBudgetsActionMixinProps.Builder builder()

Returns:

a CfnBudgetsActionMixinProps.Builder of CfnBudgetsActionMixinProps