Interface ICfnBudgetsActionProps

Properties for defining a CfnBudgetsAction.

Namespace: Amazon.CDK.AWS.Budgets

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnBudgetsActionProps

Syntax (vb)

Public Interface ICfnBudgetsActionProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Budgets;

             var cfnBudgetsActionProps = new CfnBudgetsActionProps {
                 ActionThreshold = new ActionThresholdProperty {
                     Type = "type",
                     Value = 123
                 },
                 ActionType = "actionType",
                 BudgetName = "budgetName",
                 Definition = new DefinitionProperty {
                     IamActionDefinition = new IamActionDefinitionProperty {
                         PolicyArn = "policyArn",

                         // the properties below are optional
                         Groups = new [] { "groups" },
                         Roles = new [] { "roles" },
                         Users = new [] { "users" }
                     },
                     ScpActionDefinition = new ScpActionDefinitionProperty {
                         PolicyId = "policyId",
                         TargetIds = new [] { "targetIds" }
                     },
                     SsmActionDefinition = new SsmActionDefinitionProperty {
                         InstanceIds = new [] { "instanceIds" },
                         Region = "region",
                         Subtype = "subtype"
                     }
                 },
                 ExecutionRoleArn = "executionRoleArn",
                 NotificationType = "notificationType",
                 Subscribers = new [] { new SubscriberProperty {
                     Address = "address",
                     Type = "type"
                 } },

                 // the properties below are optional
                 ApprovalModel = "approvalModel",
                 ResourceTags = new [] { new ResourceTagProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

ActionThreshold	The trigger threshold of the action.
ActionType	The type of action.
ApprovalModel	This specifies if the action needs manual or automatic approval.
BudgetName	A string that represents the budget name.
Definition	Specifies all of the type-specific parameters.
ExecutionRoleArn	The role passed for action execution and reversion.
NotificationType	The type of a notification.
ResourceTags	An optional list of tags to associate with the specified budget action.
Subscribers	A list of subscribers.

Properties

ActionThreshold

The trigger threshold of the action.

object ActionThreshold { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnBudgetsAction.IActionThresholdProperty

ActionType

The type of action.

string ActionType { get; }

Property Value

string

Remarks

This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

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

ApprovalModel

This specifies if the action needs manual or automatic approval.

string? ApprovalModel { get; }

Property Value

string

Remarks

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

BudgetName

A string that represents the budget name.

string BudgetName { get; }

Property Value

string

Remarks

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

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

Definition

Specifies all of the type-specific parameters.

object Definition { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnBudgetsAction.IDefinitionProperty

ExecutionRoleArn

The role passed for action execution and reversion.

string ExecutionRoleArn { get; }

Property Value

string

Remarks

Roles and actions must be in the same account.

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

NotificationType

The type of a notification.

string NotificationType { get; }

Property Value

string

Remarks

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

ResourceTags

An optional list of tags to associate with the specified budget action.

CfnBudgetsAction.IResourceTagProperty[]? ResourceTags { get; }

Property Value

IResourceTagProperty[]

Remarks

Each tag consists of a key and a value, and each key must be unique for the resource.

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

Subscribers

A list of subscribers.

object Subscribers { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnBudgetsAction.ISubscriberProperty)[]