software.amazon.awscdk.services.budgets

Class CfnBudgetsAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.budgets.CfnBudgetsAction

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.944Z")
 @Stability(value=Stable)
public class CfnBudgetsAction
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Budgets::BudgetsAction`.

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded. For more information, see Managing Your Costs with Budgets in the AWS Billing and Cost Management User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.budgets.*;
 CfnBudgetsAction cfnBudgetsAction = CfnBudgetsAction.Builder.create(this, "MyCfnBudgetsAction")
         .actionThreshold(ActionThresholdProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .actionType("actionType")
         .budgetName("budgetName")
         .definition(DefinitionProperty.builder()
                 .iamActionDefinition(IamActionDefinitionProperty.builder()
                         .policyArn("policyArn")
                         // the properties below are optional
                         .groups(List.of("groups"))
                         .roles(List.of("roles"))
                         .users(List.of("users"))
                         .build())
                 .scpActionDefinition(ScpActionDefinitionProperty.builder()
                         .policyId("policyId")
                         .targetIds(List.of("targetIds"))
                         .build())
                 .ssmActionDefinition(SsmActionDefinitionProperty.builder()
                         .instanceIds(List.of("instanceIds"))
                         .region("region")
                         .subtype("subtype")
                         .build())
                 .build())
         .executionRoleArn("executionRoleArn")
         .notificationType("notificationType")
         .subscribers(List.of(SubscriberProperty.builder()
                 .address("address")
                 .type("type")
                 .build()))
         // the properties below are optional
         .approvalModel("approvalModel")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBudgetsAction.ActionThresholdProperty The trigger threshold of the action.
static class	CfnBudgetsAction.Builder A fluent builder for CfnBudgetsAction.
static interface	CfnBudgetsAction.DefinitionProperty The definition is where you specify all of the type-specific parameters.
static interface	CfnBudgetsAction.IamActionDefinitionProperty The AWS Identity and Access Management ( IAM ) action definition details.
static interface	CfnBudgetsAction.ScpActionDefinitionProperty The service control policies (SCP) action definition details.
static interface	CfnBudgetsAction.SsmActionDefinitionProperty The Amazon EC2 Systems Manager ( SSM ) action definition details.
static interface	CfnBudgetsAction.SubscriberProperty The subscriber to a budget notification.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBudgetsAction(software.constructs.Construct scope, String id, CfnBudgetsActionProps props) Create a new `AWS::Budgets::BudgetsAction`.
protected	CfnBudgetsAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBudgetsAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActionThreshold() The trigger threshold of the action.
String	getActionType() The type of action.
String	getApprovalModel() This specifies if the action needs manual or automatic approval.
String	getAttrActionId() A system-generated universally unique identifier (UUID) for the action.
String	getBudgetName() A string that represents the budget name.
protected Map<String,Object>	getCfnProperties()
Object	getDefinition() Specifies all of the type-specific parameters.
String	getExecutionRoleArn() The role passed for action execution and reversion.
String	getNotificationType() The type of a notification.
Object	getSubscribers() A list of subscribers.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionThreshold(CfnBudgetsAction.ActionThresholdProperty value) The trigger threshold of the action.
void	setActionThreshold(IResolvable value) The trigger threshold of the action.
void	setActionType(String value) The type of action.
void	setApprovalModel(String value) This specifies if the action needs manual or automatic approval.
void	setBudgetName(String value) A string that represents the budget name.
void	setDefinition(CfnBudgetsAction.DefinitionProperty value) Specifies all of the type-specific parameters.
void	setDefinition(IResolvable value) Specifies all of the type-specific parameters.
void	setExecutionRoleArn(String value) The role passed for action execution and reversion.
void	setNotificationType(String value) The type of a notification.
void	setSubscribers(IResolvable value) A list of subscribers.
void	setSubscribers(List<Object> value) A list of subscribers.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBudgetsAction

protected CfnBudgetsAction(software.amazon.jsii.JsiiObjectRef objRef)

CfnBudgetsAction

protected CfnBudgetsAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBudgetsAction

@Stability(value=Stable)
public CfnBudgetsAction(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnBudgetsActionProps props)

Create a new `AWS::Budgets::BudgetsAction`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrActionId

@Stability(value=Stable)
 @NotNull
public String getAttrActionId()

A system-generated universally unique identifier (UUID) for the action.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getActionThreshold

@Stability(value=Stable)
 @NotNull
public Object getActionThreshold()

The trigger threshold of the action.

setActionThreshold

@Stability(value=Stable)
public void setActionThreshold(@NotNull
                                                        CfnBudgetsAction.ActionThresholdProperty value)

The trigger threshold of the action.

setActionThreshold

@Stability(value=Stable)
public void setActionThreshold(@NotNull
                                                        IResolvable value)

The trigger threshold of the action.

getActionType

@Stability(value=Stable)
 @NotNull
public String getActionType()

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.

setActionType

@Stability(value=Stable)
public void setActionType(@NotNull
                                                   String value)

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.

getBudgetName

@Stability(value=Stable)
 @NotNull
public String getBudgetName()

A string that represents the budget name.

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

setBudgetName

@Stability(value=Stable)
public void setBudgetName(@NotNull
                                                   String value)

A string that represents the budget name.

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

getDefinition

@Stability(value=Stable)
 @NotNull
public Object getDefinition()

Specifies all of the type-specific parameters.

setDefinition

@Stability(value=Stable)
public void setDefinition(@NotNull
                                                   CfnBudgetsAction.DefinitionProperty value)

Specifies all of the type-specific parameters.

setDefinition

@Stability(value=Stable)
public void setDefinition(@NotNull
                                                   IResolvable value)

Specifies all of the type-specific parameters.

getExecutionRoleArn

@Stability(value=Stable)
 @NotNull
public String getExecutionRoleArn()

The role passed for action execution and reversion.

Roles and actions must be in the same account.

setExecutionRoleArn

@Stability(value=Stable)
public void setExecutionRoleArn(@NotNull
                                                         String value)

The role passed for action execution and reversion.

Roles and actions must be in the same account.

getNotificationType

@Stability(value=Stable)
 @NotNull
public String getNotificationType()

The type of a notification.

setNotificationType

@Stability(value=Stable)
public void setNotificationType(@NotNull
                                                         String value)

The type of a notification.

getSubscribers

@Stability(value=Stable)
 @NotNull
public Object getSubscribers()

A list of subscribers.

setSubscribers

@Stability(value=Stable)
public void setSubscribers(@NotNull
                                                    IResolvable value)

A list of subscribers.

setSubscribers

@Stability(value=Stable)
public void setSubscribers(@NotNull
                                                    List<Object> value)

A list of subscribers.

getApprovalModel

@Stability(value=Stable)
 @Nullable
public String getApprovalModel()

This specifies if the action needs manual or automatic approval.

setApprovalModel

@Stability(value=Stable)
public void setApprovalModel(@Nullable
                                                      String value)

This specifies if the action needs manual or automatic approval.