1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. budgets
  5. BudgetsAction

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.budgets.BudgetsAction

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

An example resource schema demonstrating some basic constructs and validation rules.

Create BudgetsAction Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BudgetsAction(name: string, args: BudgetsActionArgs, opts?: CustomResourceOptions);
@overload
def BudgetsAction(resource_name: str,
                  args: BudgetsActionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def BudgetsAction(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  action_threshold: Optional[BudgetsActionActionThresholdArgs] = None,
                  action_type: Optional[BudgetsActionActionType] = None,
                  budget_name: Optional[str] = None,
                  definition: Optional[BudgetsActionDefinitionArgs] = None,
                  execution_role_arn: Optional[str] = None,
                  notification_type: Optional[BudgetsActionNotificationType] = None,
                  subscribers: Optional[Sequence[BudgetsActionSubscriberArgs]] = None,
                  approval_model: Optional[BudgetsActionApprovalModel] = None,
                  resource_tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewBudgetsAction(ctx *Context, name string, args BudgetsActionArgs, opts ...ResourceOption) (*BudgetsAction, error)
public BudgetsAction(string name, BudgetsActionArgs args, CustomResourceOptions? opts = null)
public BudgetsAction(String name, BudgetsActionArgs args)
public BudgetsAction(String name, BudgetsActionArgs args, CustomResourceOptions options)
type: aws-native:budgets:BudgetsAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BudgetsActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BudgetsActionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BudgetsActionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BudgetsActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BudgetsActionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BudgetsAction Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BudgetsAction resource accepts the following input properties:

ActionThreshold This property is required. Pulumi.AwsNative.Budgets.Inputs.BudgetsActionActionThreshold
The trigger threshold of the action.
ActionType This property is required. Pulumi.AwsNative.Budgets.BudgetsActionActionType
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.
BudgetName This property is required. string
A string that represents the budget name. ":" and "" characters aren't allowed.
Definition This property is required. Pulumi.AwsNative.Budgets.Inputs.BudgetsActionDefinition
Specifies all of the type-specific parameters.
ExecutionRoleArn This property is required. string
The role passed for action execution and reversion. Roles and actions must be in the same account.
NotificationType This property is required. Pulumi.AwsNative.Budgets.BudgetsActionNotificationType
The type of a notification.
Subscribers This property is required. List<Pulumi.AwsNative.Budgets.Inputs.BudgetsActionSubscriber>
A list of subscribers.
ApprovalModel Pulumi.AwsNative.Budgets.BudgetsActionApprovalModel
This specifies if the action needs manual or automatic approval.
ResourceTags List<Pulumi.AwsNative.Inputs.Tag>
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.
ActionThreshold This property is required. BudgetsActionActionThresholdArgs
The trigger threshold of the action.
ActionType This property is required. BudgetsActionActionType
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.
BudgetName This property is required. string
A string that represents the budget name. ":" and "" characters aren't allowed.
Definition This property is required. BudgetsActionDefinitionArgs
Specifies all of the type-specific parameters.
ExecutionRoleArn This property is required. string
The role passed for action execution and reversion. Roles and actions must be in the same account.
NotificationType This property is required. BudgetsActionNotificationType
The type of a notification.
Subscribers This property is required. []BudgetsActionSubscriberArgs
A list of subscribers.
ApprovalModel BudgetsActionApprovalModel
This specifies if the action needs manual or automatic approval.
ResourceTags TagArgs
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.
actionThreshold This property is required. BudgetsActionActionThreshold
The trigger threshold of the action.
actionType This property is required. BudgetsActionActionType
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.
budgetName This property is required. String
A string that represents the budget name. ":" and "" characters aren't allowed.
definition This property is required. BudgetsActionDefinition
Specifies all of the type-specific parameters.
executionRoleArn This property is required. String
The role passed for action execution and reversion. Roles and actions must be in the same account.
notificationType This property is required. BudgetsActionNotificationType
The type of a notification.
subscribers This property is required. List<BudgetsActionSubscriber>
A list of subscribers.
approvalModel BudgetsActionApprovalModel
This specifies if the action needs manual or automatic approval.
resourceTags List<Tag>
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.
actionThreshold This property is required. BudgetsActionActionThreshold
The trigger threshold of the action.
actionType This property is required. BudgetsActionActionType
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.
budgetName This property is required. string
A string that represents the budget name. ":" and "" characters aren't allowed.
definition This property is required. BudgetsActionDefinition
Specifies all of the type-specific parameters.
executionRoleArn This property is required. string
The role passed for action execution and reversion. Roles and actions must be in the same account.
notificationType This property is required. BudgetsActionNotificationType
The type of a notification.
subscribers This property is required. BudgetsActionSubscriber[]
A list of subscribers.
approvalModel BudgetsActionApprovalModel
This specifies if the action needs manual or automatic approval.
resourceTags Tag[]
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.
action_threshold This property is required. BudgetsActionActionThresholdArgs
The trigger threshold of the action.
action_type This property is required. BudgetsActionActionType
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 This property is required. str
A string that represents the budget name. ":" and "" characters aren't allowed.
definition This property is required. BudgetsActionDefinitionArgs
Specifies all of the type-specific parameters.
execution_role_arn This property is required. str
The role passed for action execution and reversion. Roles and actions must be in the same account.
notification_type This property is required. BudgetsActionNotificationType
The type of a notification.
subscribers This property is required. Sequence[BudgetsActionSubscriberArgs]
A list of subscribers.
approval_model BudgetsActionApprovalModel
This specifies if the action needs manual or automatic approval.
resource_tags Sequence[TagArgs]
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.
actionThreshold This property is required. Property Map
The trigger threshold of the action.
actionType This property is required. "APPLY_IAM_POLICY" | "APPLY_SCP_POLICY" | "RUN_SSM_DOCUMENTS"
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.
budgetName This property is required. String
A string that represents the budget name. ":" and "" characters aren't allowed.
definition This property is required. Property Map
Specifies all of the type-specific parameters.
executionRoleArn This property is required. String
The role passed for action execution and reversion. Roles and actions must be in the same account.
notificationType This property is required. "ACTUAL" | "FORECASTED"
The type of a notification.
subscribers This property is required. List<Property Map>
A list of subscribers.
approvalModel "AUTOMATIC" | "MANUAL"
This specifies if the action needs manual or automatic approval.
resourceTags List<Property Map>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the BudgetsAction resource produces the following output properties:

ActionId string
A system-generated universally unique identifier (UUID) for the action.
Id string
The provider-assigned unique ID for this managed resource.
ActionId string
A system-generated universally unique identifier (UUID) for the action.
Id string
The provider-assigned unique ID for this managed resource.
actionId String
A system-generated universally unique identifier (UUID) for the action.
id String
The provider-assigned unique ID for this managed resource.
actionId string
A system-generated universally unique identifier (UUID) for the action.
id string
The provider-assigned unique ID for this managed resource.
action_id str
A system-generated universally unique identifier (UUID) for the action.
id str
The provider-assigned unique ID for this managed resource.
actionId String
A system-generated universally unique identifier (UUID) for the action.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

BudgetsActionActionThreshold
, BudgetsActionActionThresholdArgs

Type This property is required. Pulumi.AwsNative.Budgets.BudgetsActionActionThresholdType
The type of threshold for a notification.
Value This property is required. double
The threshold of a notification.
Type This property is required. BudgetsActionActionThresholdType
The type of threshold for a notification.
Value This property is required. float64
The threshold of a notification.
type This property is required. BudgetsActionActionThresholdType
The type of threshold for a notification.
value This property is required. Double
The threshold of a notification.
type This property is required. BudgetsActionActionThresholdType
The type of threshold for a notification.
value This property is required. number
The threshold of a notification.
type This property is required. BudgetsActionActionThresholdType
The type of threshold for a notification.
value This property is required. float
The threshold of a notification.
type This property is required. "PERCENTAGE" | "ABSOLUTE_VALUE"
The type of threshold for a notification.
value This property is required. Number
The threshold of a notification.

BudgetsActionActionThresholdType
, BudgetsActionActionThresholdTypeArgs

Percentage
PERCENTAGE
AbsoluteValue
ABSOLUTE_VALUE
BudgetsActionActionThresholdTypePercentage
PERCENTAGE
BudgetsActionActionThresholdTypeAbsoluteValue
ABSOLUTE_VALUE
Percentage
PERCENTAGE
AbsoluteValue
ABSOLUTE_VALUE
Percentage
PERCENTAGE
AbsoluteValue
ABSOLUTE_VALUE
PERCENTAGE
PERCENTAGE
ABSOLUTE_VALUE
ABSOLUTE_VALUE
"PERCENTAGE"
PERCENTAGE
"ABSOLUTE_VALUE"
ABSOLUTE_VALUE

BudgetsActionActionType
, BudgetsActionActionTypeArgs

ApplyIamPolicy
APPLY_IAM_POLICY
ApplyScpPolicy
APPLY_SCP_POLICY
RunSsmDocuments
RUN_SSM_DOCUMENTS
BudgetsActionActionTypeApplyIamPolicy
APPLY_IAM_POLICY
BudgetsActionActionTypeApplyScpPolicy
APPLY_SCP_POLICY
BudgetsActionActionTypeRunSsmDocuments
RUN_SSM_DOCUMENTS
ApplyIamPolicy
APPLY_IAM_POLICY
ApplyScpPolicy
APPLY_SCP_POLICY
RunSsmDocuments
RUN_SSM_DOCUMENTS
ApplyIamPolicy
APPLY_IAM_POLICY
ApplyScpPolicy
APPLY_SCP_POLICY
RunSsmDocuments
RUN_SSM_DOCUMENTS
APPLY_IAM_POLICY
APPLY_IAM_POLICY
APPLY_SCP_POLICY
APPLY_SCP_POLICY
RUN_SSM_DOCUMENTS
RUN_SSM_DOCUMENTS
"APPLY_IAM_POLICY"
APPLY_IAM_POLICY
"APPLY_SCP_POLICY"
APPLY_SCP_POLICY
"RUN_SSM_DOCUMENTS"
RUN_SSM_DOCUMENTS

BudgetsActionApprovalModel
, BudgetsActionApprovalModelArgs

Automatic
AUTOMATIC
Manual
MANUAL
BudgetsActionApprovalModelAutomatic
AUTOMATIC
BudgetsActionApprovalModelManual
MANUAL
Automatic
AUTOMATIC
Manual
MANUAL
Automatic
AUTOMATIC
Manual
MANUAL
AUTOMATIC
AUTOMATIC
MANUAL
MANUAL
"AUTOMATIC"
AUTOMATIC
"MANUAL"
MANUAL

BudgetsActionDefinition
, BudgetsActionDefinitionArgs

IamActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionIamActionDefinition
The AWS Identity and Access Management ( IAM ) action definition details.
ScpActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionScpActionDefinition
The service control policies (SCP) action definition details.
SsmActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionSsmActionDefinition
The Amazon EC2 Systems Manager ( SSM ) action definition details.
IamActionDefinition BudgetsActionIamActionDefinition
The AWS Identity and Access Management ( IAM ) action definition details.
ScpActionDefinition BudgetsActionScpActionDefinition
The service control policies (SCP) action definition details.
SsmActionDefinition BudgetsActionSsmActionDefinition
The Amazon EC2 Systems Manager ( SSM ) action definition details.
iamActionDefinition BudgetsActionIamActionDefinition
The AWS Identity and Access Management ( IAM ) action definition details.
scpActionDefinition BudgetsActionScpActionDefinition
The service control policies (SCP) action definition details.
ssmActionDefinition BudgetsActionSsmActionDefinition
The Amazon EC2 Systems Manager ( SSM ) action definition details.
iamActionDefinition BudgetsActionIamActionDefinition
The AWS Identity and Access Management ( IAM ) action definition details.
scpActionDefinition BudgetsActionScpActionDefinition
The service control policies (SCP) action definition details.
ssmActionDefinition BudgetsActionSsmActionDefinition
The Amazon EC2 Systems Manager ( SSM ) action definition details.
iam_action_definition BudgetsActionIamActionDefinition
The AWS Identity and Access Management ( IAM ) action definition details.
scp_action_definition BudgetsActionScpActionDefinition
The service control policies (SCP) action definition details.
ssm_action_definition BudgetsActionSsmActionDefinition
The Amazon EC2 Systems Manager ( SSM ) action definition details.
iamActionDefinition Property Map
The AWS Identity and Access Management ( IAM ) action definition details.
scpActionDefinition Property Map
The service control policies (SCP) action definition details.
ssmActionDefinition Property Map
The Amazon EC2 Systems Manager ( SSM ) action definition details.

BudgetsActionIamActionDefinition
, BudgetsActionIamActionDefinitionArgs

PolicyArn This property is required. string
The Amazon Resource Name (ARN) of the policy to be attached.
Groups List<string>
A list of groups to be attached. There must be at least one group.
Roles List<string>
A list of roles to be attached. There must be at least one role.
Users List<string>
A list of users to be attached. There must be at least one user.
PolicyArn This property is required. string
The Amazon Resource Name (ARN) of the policy to be attached.
Groups []string
A list of groups to be attached. There must be at least one group.
Roles []string
A list of roles to be attached. There must be at least one role.
Users []string
A list of users to be attached. There must be at least one user.
policyArn This property is required. String
The Amazon Resource Name (ARN) of the policy to be attached.
groups List<String>
A list of groups to be attached. There must be at least one group.
roles List<String>
A list of roles to be attached. There must be at least one role.
users List<String>
A list of users to be attached. There must be at least one user.
policyArn This property is required. string
The Amazon Resource Name (ARN) of the policy to be attached.
groups string[]
A list of groups to be attached. There must be at least one group.
roles string[]
A list of roles to be attached. There must be at least one role.
users string[]
A list of users to be attached. There must be at least one user.
policy_arn This property is required. str
The Amazon Resource Name (ARN) of the policy to be attached.
groups Sequence[str]
A list of groups to be attached. There must be at least one group.
roles Sequence[str]
A list of roles to be attached. There must be at least one role.
users Sequence[str]
A list of users to be attached. There must be at least one user.
policyArn This property is required. String
The Amazon Resource Name (ARN) of the policy to be attached.
groups List<String>
A list of groups to be attached. There must be at least one group.
roles List<String>
A list of roles to be attached. There must be at least one role.
users List<String>
A list of users to be attached. There must be at least one user.

BudgetsActionNotificationType
, BudgetsActionNotificationTypeArgs

Actual
ACTUAL
Forecasted
FORECASTED
BudgetsActionNotificationTypeActual
ACTUAL
BudgetsActionNotificationTypeForecasted
FORECASTED
Actual
ACTUAL
Forecasted
FORECASTED
Actual
ACTUAL
Forecasted
FORECASTED
ACTUAL
ACTUAL
FORECASTED
FORECASTED
"ACTUAL"
ACTUAL
"FORECASTED"
FORECASTED

BudgetsActionScpActionDefinition
, BudgetsActionScpActionDefinitionArgs

PolicyId This property is required. string
The policy ID attached.
TargetIds This property is required. List<string>
A list of target IDs.
PolicyId This property is required. string
The policy ID attached.
TargetIds This property is required. []string
A list of target IDs.
policyId This property is required. String
The policy ID attached.
targetIds This property is required. List<String>
A list of target IDs.
policyId This property is required. string
The policy ID attached.
targetIds This property is required. string[]
A list of target IDs.
policy_id This property is required. str
The policy ID attached.
target_ids This property is required. Sequence[str]
A list of target IDs.
policyId This property is required. String
The policy ID attached.
targetIds This property is required. List<String>
A list of target IDs.

BudgetsActionSsmActionDefinition
, BudgetsActionSsmActionDefinitionArgs

InstanceIds This property is required. List<string>
The EC2 and RDS instance IDs.
Region This property is required. string
The Region to run the ( SSM ) document.
Subtype This property is required. Pulumi.AwsNative.Budgets.BudgetsActionSsmActionDefinitionSubtype
The action subType.
InstanceIds This property is required. []string
The EC2 and RDS instance IDs.
Region This property is required. string
The Region to run the ( SSM ) document.
Subtype This property is required. BudgetsActionSsmActionDefinitionSubtype
The action subType.
instanceIds This property is required. List<String>
The EC2 and RDS instance IDs.
region This property is required. String
The Region to run the ( SSM ) document.
subtype This property is required. BudgetsActionSsmActionDefinitionSubtype
The action subType.
instanceIds This property is required. string[]
The EC2 and RDS instance IDs.
region This property is required. string
The Region to run the ( SSM ) document.
subtype This property is required. BudgetsActionSsmActionDefinitionSubtype
The action subType.
instance_ids This property is required. Sequence[str]
The EC2 and RDS instance IDs.
region This property is required. str
The Region to run the ( SSM ) document.
subtype This property is required. BudgetsActionSsmActionDefinitionSubtype
The action subType.
instanceIds This property is required. List<String>
The EC2 and RDS instance IDs.
region This property is required. String
The Region to run the ( SSM ) document.
subtype This property is required. "STOP_EC2_INSTANCES" | "STOP_RDS_INSTANCES"
The action subType.

BudgetsActionSsmActionDefinitionSubtype
, BudgetsActionSsmActionDefinitionSubtypeArgs

StopEc2Instances
STOP_EC2_INSTANCES
StopRdsInstances
STOP_RDS_INSTANCES
BudgetsActionSsmActionDefinitionSubtypeStopEc2Instances
STOP_EC2_INSTANCES
BudgetsActionSsmActionDefinitionSubtypeStopRdsInstances
STOP_RDS_INSTANCES
StopEc2Instances
STOP_EC2_INSTANCES
StopRdsInstances
STOP_RDS_INSTANCES
StopEc2Instances
STOP_EC2_INSTANCES
StopRdsInstances
STOP_RDS_INSTANCES
STOP_EC2_INSTANCES
STOP_EC2_INSTANCES
STOP_RDS_INSTANCES
STOP_RDS_INSTANCES
"STOP_EC2_INSTANCES"
STOP_EC2_INSTANCES
"STOP_RDS_INSTANCES"
STOP_RDS_INSTANCES

BudgetsActionSubscriber
, BudgetsActionSubscriberArgs

Address This property is required. string

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 This property is required. Pulumi.AwsNative.Budgets.BudgetsActionSubscriberType
The type of notification that AWS sends to a subscriber.
Address This property is required. string

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 This property is required. BudgetsActionSubscriberType
The type of notification that AWS sends to a subscriber.
address This property is required. String

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 This property is required. BudgetsActionSubscriberType
The type of notification that AWS sends to a subscriber.
address This property is required. string

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 This property is required. BudgetsActionSubscriberType
The type of notification that AWS sends to a subscriber.
address This property is required. 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 This property is required. BudgetsActionSubscriberType
The type of notification that AWS sends to a subscriber.
address This property is required. String

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 This property is required. "SNS" | "EMAIL"
The type of notification that AWS sends to a subscriber.

BudgetsActionSubscriberType
, BudgetsActionSubscriberTypeArgs

Sns
SNS
Email
EMAIL
BudgetsActionSubscriberTypeSns
SNS
BudgetsActionSubscriberTypeEmail
EMAIL
Sns
SNS
Email
EMAIL
Sns
SNS
Email
EMAIL
SNS
SNS
EMAIL
EMAIL
"SNS"
SNS
"EMAIL"
EMAIL

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi