CfnBudgetsAction

class aws_cdk.aws_budgets.CfnBudgetsAction(scope, id, *, action_threshold, action_type, budget_name, definition, execution_role_arn, notification_type, approval_model=None, subscribers=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Budgets::BudgetsAction.

CloudformationResource

AWS::Budgets::BudgetsAction

Link

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

Create a new AWS::Budgets::BudgetsAction.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • action_threshold (Union[IResolvable, ActionThresholdProperty]) – AWS::Budgets::BudgetsAction.ActionThreshold.

  • action_type (str) – AWS::Budgets::BudgetsAction.ActionType.

  • budget_name (str) – AWS::Budgets::BudgetsAction.BudgetName.

  • definition (Union[IResolvable, DefinitionProperty]) – AWS::Budgets::BudgetsAction.Definition.

  • execution_role_arn (str) – AWS::Budgets::BudgetsAction.ExecutionRoleArn.

  • notification_type (str) – AWS::Budgets::BudgetsAction.NotificationType.

  • approval_model (Optional[str]) – AWS::Budgets::BudgetsAction.ApprovalModel.

  • subscribers (Union[IResolvable, Sequence[Union[IResolvable, SubscriberProperty]], None]) – AWS::Budgets::BudgetsAction.Subscribers.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Budgets::BudgetsAction'
action_threshold

AWS::Budgets::BudgetsAction.ActionThreshold.

Link

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

Return type

Union[IResolvable, ActionThresholdProperty]

action_type

AWS::Budgets::BudgetsAction.ActionType.

Link

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

Return type

str

approval_model

AWS::Budgets::BudgetsAction.ApprovalModel.

Link

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

Return type

Optional[str]

attr_action_id

ActionId

Type

cloudformationAttribute

Return type

str

budget_name

AWS::Budgets::BudgetsAction.BudgetName.

Link

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

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

definition

AWS::Budgets::BudgetsAction.Definition.

Link

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

Return type

Union[IResolvable, DefinitionProperty]

execution_role_arn

AWS::Budgets::BudgetsAction.ExecutionRoleArn.

Link

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

Return type

str

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

notification_type

AWS::Budgets::BudgetsAction.NotificationType.

Link

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

Return type

str

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

subscribers

AWS::Budgets::BudgetsAction.Subscribers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, SubscriberProperty]], None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ActionThresholdProperty

class CfnBudgetsAction.ActionThresholdProperty(*, type, value)

Bases: object

Parameters
  • type (str) – CfnBudgetsAction.ActionThresholdProperty.Type.

  • value (Union[int, float]) – CfnBudgetsAction.ActionThresholdProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html

Attributes

type

CfnBudgetsAction.ActionThresholdProperty.Type.

Link

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

Return type

str

value

CfnBudgetsAction.ActionThresholdProperty.Value.

Link

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

Return type

Union[int, float]

DefinitionProperty

class CfnBudgetsAction.DefinitionProperty(*, iam_action_definition=None, scp_action_definition=None, ssm_action_definition=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html

Attributes

iam_action_definition

CfnBudgetsAction.DefinitionProperty.IamActionDefinition.

Link

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

Return type

Union[IResolvable, IamActionDefinitionProperty, None]

scp_action_definition

CfnBudgetsAction.DefinitionProperty.ScpActionDefinition.

Link

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

Return type

Union[IResolvable, ScpActionDefinitionProperty, None]

ssm_action_definition

CfnBudgetsAction.DefinitionProperty.SsmActionDefinition.

Link

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

Return type

Union[IResolvable, SsmActionDefinitionProperty, None]

IamActionDefinitionProperty

class CfnBudgetsAction.IamActionDefinitionProperty(*, policy_arn, groups=None, roles=None, users=None)

Bases: object

Parameters
  • policy_arn (str) – CfnBudgetsAction.IamActionDefinitionProperty.PolicyArn.

  • groups (Optional[Sequence[str]]) – CfnBudgetsAction.IamActionDefinitionProperty.Groups.

  • roles (Optional[Sequence[str]]) – CfnBudgetsAction.IamActionDefinitionProperty.Roles.

  • users (Optional[Sequence[str]]) – CfnBudgetsAction.IamActionDefinitionProperty.Users.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html

Attributes

groups

CfnBudgetsAction.IamActionDefinitionProperty.Groups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-groups

Return type

Optional[List[str]]

policy_arn

CfnBudgetsAction.IamActionDefinitionProperty.PolicyArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-policyarn

Return type

str

roles

CfnBudgetsAction.IamActionDefinitionProperty.Roles.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-roles

Return type

Optional[List[str]]

users

CfnBudgetsAction.IamActionDefinitionProperty.Users.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-users

Return type

Optional[List[str]]

ScpActionDefinitionProperty

class CfnBudgetsAction.ScpActionDefinitionProperty(*, policy_id, target_ids)

Bases: object

Parameters
  • policy_id (str) – CfnBudgetsAction.ScpActionDefinitionProperty.PolicyId.

  • target_ids (Sequence[str]) – CfnBudgetsAction.ScpActionDefinitionProperty.TargetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html

Attributes

policy_id

CfnBudgetsAction.ScpActionDefinitionProperty.PolicyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-policyid

Return type

str

target_ids

CfnBudgetsAction.ScpActionDefinitionProperty.TargetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-targetids

Return type

List[str]

SsmActionDefinitionProperty

class CfnBudgetsAction.SsmActionDefinitionProperty(*, instance_ids, region, subtype)

Bases: object

Parameters
  • instance_ids (Sequence[str]) – CfnBudgetsAction.SsmActionDefinitionProperty.InstanceIds.

  • region (str) – CfnBudgetsAction.SsmActionDefinitionProperty.Region.

  • subtype (str) – CfnBudgetsAction.SsmActionDefinitionProperty.Subtype.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html

Attributes

instance_ids

CfnBudgetsAction.SsmActionDefinitionProperty.InstanceIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-instanceids

Return type

List[str]

region

CfnBudgetsAction.SsmActionDefinitionProperty.Region.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-region

Return type

str

subtype

CfnBudgetsAction.SsmActionDefinitionProperty.Subtype.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-subtype

Return type

str

SubscriberProperty

class CfnBudgetsAction.SubscriberProperty(*, address, type)

Bases: object

Parameters
  • address (str) – CfnBudgetsAction.SubscriberProperty.Address.

  • type (str) – CfnBudgetsAction.SubscriberProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html

Attributes

address

CfnBudgetsAction.SubscriberProperty.Address.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-address

Return type

str

type

CfnBudgetsAction.SubscriberProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-type

Return type

str