interface CfnBudgetsActionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Budgets.CfnBudgetsActionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbudgets#CfnBudgetsActionProps |
![]() | software.amazon.awscdk.services.budgets.CfnBudgetsActionProps |
![]() | aws_cdk.aws_budgets.CfnBudgetsActionProps |
![]() | aws-cdk-lib » aws_budgets » CfnBudgetsActionProps |
Properties for defining a CfnBudgetsAction
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_budgets as budgets } from 'aws-cdk-lib';
const cfnBudgetsActionProps: budgets.CfnBudgetsActionProps = {
actionThreshold: {
type: 'type',
value: 123,
},
actionType: 'actionType',
budgetName: 'budgetName',
definition: {
iamActionDefinition: {
policyArn: 'policyArn',
// the properties below are optional
groups: ['groups'],
roles: ['roles'],
users: ['users'],
},
scpActionDefinition: {
policyId: 'policyId',
targetIds: ['targetIds'],
},
ssmActionDefinition: {
instanceIds: ['instanceIds'],
region: 'region',
subtype: 'subtype',
},
},
executionRoleArn: 'executionRoleArn',
notificationType: 'notificationType',
subscribers: [{
address: 'address',
type: 'type',
}],
// the properties below are optional
approvalModel: 'approvalModel',
resourceTags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
action | IResolvable | Action | The trigger threshold of the action. |
action | string | The type of action. |
budget | string | A string that represents the budget name. |
definition | IResolvable | Definition | Specifies all of the type-specific parameters. |
execution | string | The role passed for action execution and reversion. |
notification | string | The type of a notification. |
subscribers | IResolvable | IResolvable | Subscriber [] | A list of subscribers. |
approval | string | This specifies if the action needs manual or automatic approval. |
resource | Resource [] | An optional list of tags to associate with the specified budget action. |
actionThreshold
Type:
IResolvable
|
Action
The trigger threshold of the action.
actionType
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.
budgetName
Type:
string
A string that represents the budget name.
":" and "" characters aren't allowed.
definition
Type:
IResolvable
|
Definition
Specifies all of the type-specific parameters.
executionRoleArn
Type:
string
The role passed for action execution and reversion.
Roles and actions must be in the same account.
notificationType
Type:
string
The type of a notification.
subscribers
Type:
IResolvable
|
IResolvable
|
Subscriber
[]
A list of subscribers.
approvalModel?
Type:
string
(optional)
This specifies if the action needs manual or automatic approval.
resourceTags?
Type:
Resource
[]
(optional)
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.