You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Budgets::Types::CreateBudgetActionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Budgets::Types::CreateBudgetActionRequest
- Defined in:
- (unknown)
Overview
When passing CreateBudgetActionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
account_id: "AccountId", # required
budget_name: "BudgetName", # required
notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
action_type: "APPLY_IAM_POLICY", # required, accepts APPLY_IAM_POLICY, APPLY_SCP_POLICY, RUN_SSM_DOCUMENTS
action_threshold: { # required
action_threshold_value: 1.0, # required
action_threshold_type: "PERCENTAGE", # required, accepts PERCENTAGE, ABSOLUTE_VALUE
},
definition: { # required
iam_action_definition: {
policy_arn: "PolicyArn", # required
roles: ["Role"],
groups: ["Group"],
users: ["User"],
},
scp_action_definition: {
policy_id: "PolicyId", # required
target_ids: ["TargetId"], # required
},
ssm_action_definition: {
action_sub_type: "STOP_EC2_INSTANCES", # required, accepts STOP_EC2_INSTANCES, STOP_RDS_INSTANCES
region: "Region", # required
instance_ids: ["InstanceId"], # required
},
},
execution_role_arn: "RoleArn", # required
approval_model: "AUTOMATIC", # required, accepts AUTOMATIC, MANUAL
subscribers: [ # required
{
subscription_type: "SNS", # required, accepts SNS, EMAIL
address: "SubscriberAddress", # required
},
],
}
Instance Attribute Summary collapse
-
#account_id ⇒ String
The account ID of the user.
-
#action_threshold ⇒ Types::ActionThreshold
The trigger threshold of the action.
-
#action_type ⇒ String
The type of action.
-
#approval_model ⇒ String
This specifies if the action needs manual or automatic approval.
-
#budget_name ⇒ String
A string that represents the budget name.
-
#definition ⇒ Types::Definition
Specifies all of the type-specific parameters.
-
#execution_role_arn ⇒ String
The role passed for action execution and reversion.
-
#notification_type ⇒ String
The type of a notification.
-
#subscribers ⇒ Array<Types::Subscriber>
A list of subscribers.
.
Instance Attribute Details
#account_id ⇒ String
The account ID of the user. It should be a 12-digit number.
#action_threshold ⇒ Types::ActionThreshold
The trigger threshold of the action.
#action_type ⇒ String
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.
Possible values:
- APPLY_IAM_POLICY
- APPLY_SCP_POLICY
- RUN_SSM_DOCUMENTS
#approval_model ⇒ String
This specifies if the action needs manual or automatic approval.
Possible values:
- AUTOMATIC
- MANUAL
#budget_name ⇒ String
A string that represents the budget name. The ":" and "\" characters aren't allowed.
#definition ⇒ Types::Definition
Specifies all of the type-specific parameters.
#execution_role_arn ⇒ String
The role passed for action execution and reversion. Roles and actions must be in the same account.
#notification_type ⇒ String
The type of a notification. It must be ACTUAL or FORECASTED.
Possible values:
- ACTUAL
- FORECASTED
#subscribers ⇒ Array<Types::Subscriber>
A list of subscribers.