aws-cdk-lib.aws_budgets.CfnBudgetsActionProps

interface CfnBudgetsActionProps

LanguageType name
.NETAmazon.CDK.AWS.Budgets.CfnBudgetsActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbudgets#CfnBudgetsActionProps
Javasoftware.amazon.awscdk.services.budgets.CfnBudgetsActionProps
Pythonaws_cdk.aws_budgets.CfnBudgetsActionProps
TypeScript 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',
};

Properties

NameTypeDescription
actionThresholdIResolvable | ActionThresholdPropertyThe trigger threshold of the action.
actionTypestringThe type of action.
budgetNamestringA string that represents the budget name.
definitionIResolvable | DefinitionPropertySpecifies all of the type-specific parameters.
executionRoleArnstringThe role passed for action execution and reversion.
notificationTypestringThe type of a notification.
subscribersIResolvable | IResolvable | SubscriberProperty[]A list of subscribers.
approvalModel?stringThis specifies if the action needs manual or automatic approval.

actionThreshold

Type: IResolvable | ActionThresholdProperty

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 | DefinitionProperty

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 | SubscriberProperty[]

A list of subscribers.


approvalModel?

Type: string (optional)

This specifies if the action needs manual or automatic approval.