Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. budgets
  5. BudgetsAction

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.budgets.BudgetsAction

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    An example resource schema demonstrating some basic constructs and validation rules.

    Create BudgetsAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BudgetsAction(name: string, args: BudgetsActionArgs, opts?: CustomResourceOptions);
    @overload
def BudgetsAction(resource_name: str,
                  args: BudgetsActionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def BudgetsAction(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  action_threshold: Optional[BudgetsActionActionThresholdArgs] = None,
                  action_type: Optional[BudgetsActionActionType] = None,
                  budget_name: Optional[str] = None,
                  definition: Optional[BudgetsActionDefinitionArgs] = None,
                  execution_role_arn: Optional[str] = None,
                  notification_type: Optional[BudgetsActionNotificationType] = None,
                  subscribers: Optional[Sequence[BudgetsActionSubscriberArgs]] = None,
                  approval_model: Optional[BudgetsActionApprovalModel] = None,
                  resource_tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewBudgetsAction(ctx *Context, name string, args BudgetsActionArgs, opts ...ResourceOption) (*BudgetsAction, error)
    public BudgetsAction(string name, BudgetsActionArgs args, CustomResourceOptions? opts = null)
    public BudgetsAction(String name, BudgetsActionArgs args)
public BudgetsAction(String name, BudgetsActionArgs args, CustomResourceOptions options)

    type: aws-native:budgets:BudgetsAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BudgetsActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BudgetsActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BudgetsActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BudgetsActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BudgetsActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    BudgetsAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BudgetsAction resource accepts the following input properties:

    ActionThreshold Pulumi.AwsNative.Budgets.Inputs.BudgetsActionActionThreshold
    The trigger threshold of the action.
    ActionType Pulumi.AwsNative.Budgets.BudgetsActionActionType
    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 string
    A string that represents the budget name. ":" and "" characters aren't allowed.
    Definition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionDefinition
    Specifies all of the type-specific parameters.
    ExecutionRoleArn string
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    NotificationType Pulumi.AwsNative.Budgets.BudgetsActionNotificationType
    The type of a notification.
    Subscribers List<Pulumi.AwsNative.Budgets.Inputs.BudgetsActionSubscriber>
    A list of subscribers.
    ApprovalModel Pulumi.AwsNative.Budgets.BudgetsActionApprovalModel
    This specifies if the action needs manual or automatic approval.
    ResourceTags List<Pulumi.AwsNative.Inputs.Tag>
    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.
    ActionThreshold BudgetsActionActionThresholdArgs
    The trigger threshold of the action.
    ActionType BudgetsActionActionType
    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 string
    A string that represents the budget name. ":" and "" characters aren't allowed.
    Definition BudgetsActionDefinitionArgs
    Specifies all of the type-specific parameters.
    ExecutionRoleArn string
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    NotificationType BudgetsActionNotificationType
    The type of a notification.
    Subscribers []BudgetsActionSubscriberArgs
    A list of subscribers.
    ApprovalModel BudgetsActionApprovalModel
    This specifies if the action needs manual or automatic approval.
    ResourceTags TagArgs
    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.
    actionThreshold BudgetsActionActionThreshold
    The trigger threshold of the action.
    actionType BudgetsActionActionType
    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 String
    A string that represents the budget name. ":" and "" characters aren't allowed.
    definition BudgetsActionDefinition
    Specifies all of the type-specific parameters.
    executionRoleArn String
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    notificationType BudgetsActionNotificationType
    The type of a notification.
    subscribers List<BudgetsActionSubscriber>
    A list of subscribers.
    approvalModel BudgetsActionApprovalModel
    This specifies if the action needs manual or automatic approval.
    resourceTags List<Tag>
    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.
    actionThreshold BudgetsActionActionThreshold
    The trigger threshold of the action.
    actionType BudgetsActionActionType
    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 string
    A string that represents the budget name. ":" and "" characters aren't allowed.
    definition BudgetsActionDefinition
    Specifies all of the type-specific parameters.
    executionRoleArn string
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    notificationType BudgetsActionNotificationType
    The type of a notification.
    subscribers BudgetsActionSubscriber[]
    A list of subscribers.
    approvalModel BudgetsActionApprovalModel
    This specifies if the action needs manual or automatic approval.
    resourceTags Tag[]
    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.
    action_threshold BudgetsActionActionThresholdArgs
    The trigger threshold of the action.
    action_type BudgetsActionActionType
    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.
    budget_name str
    A string that represents the budget name. ":" and "" characters aren't allowed.
    definition BudgetsActionDefinitionArgs
    Specifies all of the type-specific parameters.
    execution_role_arn str
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    notification_type BudgetsActionNotificationType
    The type of a notification.
    subscribers Sequence[BudgetsActionSubscriberArgs]
    A list of subscribers.
    approval_model BudgetsActionApprovalModel
    This specifies if the action needs manual or automatic approval.
    resource_tags Sequence[TagArgs]
    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.
    actionThreshold Property Map
    The trigger threshold of the action.
    actionType "APPLY_IAM_POLICY" | "APPLY_SCP_POLICY" | "RUN_SSM_DOCUMENTS"
    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 String
    A string that represents the budget name. ":" and "" characters aren't allowed.
    definition Property Map
    Specifies all of the type-specific parameters.
    executionRoleArn String
    The role passed for action execution and reversion. Roles and actions must be in the same account.
    notificationType "ACTUAL" | "FORECASTED"
    The type of a notification.
    subscribers List<Property Map>
    A list of subscribers.
    approvalModel "AUTOMATIC" | "MANUAL"
    This specifies if the action needs manual or automatic approval.
    resourceTags List<Property Map>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BudgetsAction resource produces the following output properties:

    ActionId string
    A system-generated universally unique identifier (UUID) for the action.
    Id string
    The provider-assigned unique ID for this managed resource.
    ActionId string
    A system-generated universally unique identifier (UUID) for the action.
    Id string
    The provider-assigned unique ID for this managed resource.
    actionId String
    A system-generated universally unique identifier (UUID) for the action.
    id String
    The provider-assigned unique ID for this managed resource.
    actionId string
    A system-generated universally unique identifier (UUID) for the action.
    id string
    The provider-assigned unique ID for this managed resource.
    action_id str
    A system-generated universally unique identifier (UUID) for the action.
    id str
    The provider-assigned unique ID for this managed resource.
    actionId String
    A system-generated universally unique identifier (UUID) for the action.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BudgetsActionActionThreshold, BudgetsActionActionThresholdArgs

    Type Pulumi.AwsNative.Budgets.BudgetsActionActionThresholdType
    The type of threshold for a notification.
    Value double
    The threshold of a notification.
    Type BudgetsActionActionThresholdType
    The type of threshold for a notification.
    Value float64
    The threshold of a notification.
    type BudgetsActionActionThresholdType
    The type of threshold for a notification.
    value Double
    The threshold of a notification.
    type BudgetsActionActionThresholdType
    The type of threshold for a notification.
    value number
    The threshold of a notification.
    type BudgetsActionActionThresholdType
    The type of threshold for a notification.
    value float
    The threshold of a notification.
    type "PERCENTAGE" | "ABSOLUTE_VALUE"
    The type of threshold for a notification.
    value Number
    The threshold of a notification.

    BudgetsActionActionThresholdType, BudgetsActionActionThresholdTypeArgs

    Percentage
    PERCENTAGE
    AbsoluteValue
    ABSOLUTE_VALUE
    BudgetsActionActionThresholdTypePercentage
    PERCENTAGE
    BudgetsActionActionThresholdTypeAbsoluteValue
    ABSOLUTE_VALUE
    Percentage
    PERCENTAGE
    AbsoluteValue
    ABSOLUTE_VALUE
    Percentage
    PERCENTAGE
    AbsoluteValue
    ABSOLUTE_VALUE
    PERCENTAGE
    PERCENTAGE
    ABSOLUTE_VALUE
    ABSOLUTE_VALUE
    "PERCENTAGE"
    PERCENTAGE
    "ABSOLUTE_VALUE"
    ABSOLUTE_VALUE

    BudgetsActionActionType, BudgetsActionActionTypeArgs

    ApplyIamPolicy
    APPLY_IAM_POLICY
    ApplyScpPolicy
    APPLY_SCP_POLICY
    RunSsmDocuments
    RUN_SSM_DOCUMENTS
    BudgetsActionActionTypeApplyIamPolicy
    APPLY_IAM_POLICY
    BudgetsActionActionTypeApplyScpPolicy
    APPLY_SCP_POLICY
    BudgetsActionActionTypeRunSsmDocuments
    RUN_SSM_DOCUMENTS
    ApplyIamPolicy
    APPLY_IAM_POLICY
    ApplyScpPolicy
    APPLY_SCP_POLICY
    RunSsmDocuments
    RUN_SSM_DOCUMENTS
    ApplyIamPolicy
    APPLY_IAM_POLICY
    ApplyScpPolicy
    APPLY_SCP_POLICY
    RunSsmDocuments
    RUN_SSM_DOCUMENTS
    APPLY_IAM_POLICY
    APPLY_IAM_POLICY
    APPLY_SCP_POLICY
    APPLY_SCP_POLICY
    RUN_SSM_DOCUMENTS
    RUN_SSM_DOCUMENTS
    "APPLY_IAM_POLICY"
    APPLY_IAM_POLICY
    "APPLY_SCP_POLICY"
    APPLY_SCP_POLICY
    "RUN_SSM_DOCUMENTS"
    RUN_SSM_DOCUMENTS

    BudgetsActionApprovalModel, BudgetsActionApprovalModelArgs

    Automatic
    AUTOMATIC
    Manual
    MANUAL
    BudgetsActionApprovalModelAutomatic
    AUTOMATIC
    BudgetsActionApprovalModelManual
    MANUAL
    Automatic
    AUTOMATIC
    Manual
    MANUAL
    Automatic
    AUTOMATIC
    Manual
    MANUAL
    AUTOMATIC
    AUTOMATIC
    MANUAL
    MANUAL
    "AUTOMATIC"
    AUTOMATIC
    "MANUAL"
    MANUAL

    BudgetsActionDefinition, BudgetsActionDefinitionArgs

    IamActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionIamActionDefinition
    The AWS Identity and Access Management ( IAM ) action definition details.
    ScpActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionScpActionDefinition
    The service control policies (SCP) action definition details.
    SsmActionDefinition Pulumi.AwsNative.Budgets.Inputs.BudgetsActionSsmActionDefinition
    The Amazon EC2 Systems Manager ( SSM ) action definition details.
    IamActionDefinition BudgetsActionIamActionDefinition
    The AWS Identity and Access Management ( IAM ) action definition details.
    ScpActionDefinition BudgetsActionScpActionDefinition
    The service control policies (SCP) action definition details.
    SsmActionDefinition BudgetsActionSsmActionDefinition
    The Amazon EC2 Systems Manager ( SSM ) action definition details.
    iamActionDefinition BudgetsActionIamActionDefinition
    The AWS Identity and Access Management ( IAM ) action definition details.
    scpActionDefinition BudgetsActionScpActionDefinition
    The service control policies (SCP) action definition details.
    ssmActionDefinition BudgetsActionSsmActionDefinition
    The Amazon EC2 Systems Manager ( SSM ) action definition details.
    iamActionDefinition BudgetsActionIamActionDefinition
    The AWS Identity and Access Management ( IAM ) action definition details.
    scpActionDefinition BudgetsActionScpActionDefinition
    The service control policies (SCP) action definition details.
    ssmActionDefinition BudgetsActionSsmActionDefinition
    The Amazon EC2 Systems Manager ( SSM ) action definition details.
    iam_action_definition BudgetsActionIamActionDefinition
    The AWS Identity and Access Management ( IAM ) action definition details.
    scp_action_definition BudgetsActionScpActionDefinition
    The service control policies (SCP) action definition details.
    ssm_action_definition BudgetsActionSsmActionDefinition
    The Amazon EC2 Systems Manager ( SSM ) action definition details.
    iamActionDefinition Property Map
    The AWS Identity and Access Management ( IAM ) action definition details.
    scpActionDefinition Property Map
    The service control policies (SCP) action definition details.
    ssmActionDefinition Property Map
    The Amazon EC2 Systems Manager ( SSM ) action definition details.

    BudgetsActionIamActionDefinition, BudgetsActionIamActionDefinitionArgs

    PolicyArn string
    The Amazon Resource Name (ARN) of the policy to be attached.
    Groups List<string>
    A list of groups to be attached. There must be at least one group.
    Roles List<string>
    A list of roles to be attached. There must be at least one role.
    Users List<string>
    A list of users to be attached. There must be at least one user.
    PolicyArn string
    The Amazon Resource Name (ARN) of the policy to be attached.
    Groups []string
    A list of groups to be attached. There must be at least one group.
    Roles []string
    A list of roles to be attached. There must be at least one role.
    Users []string
    A list of users to be attached. There must be at least one user.
    policyArn String
    The Amazon Resource Name (ARN) of the policy to be attached.
    groups List<String>
    A list of groups to be attached. There must be at least one group.
    roles List<String>
    A list of roles to be attached. There must be at least one role.
    users List<String>
    A list of users to be attached. There must be at least one user.
    policyArn string
    The Amazon Resource Name (ARN) of the policy to be attached.
    groups string[]
    A list of groups to be attached. There must be at least one group.
    roles string[]
    A list of roles to be attached. There must be at least one role.
    users string[]
    A list of users to be attached. There must be at least one user.
    policy_arn str
    The Amazon Resource Name (ARN) of the policy to be attached.
    groups Sequence[str]
    A list of groups to be attached. There must be at least one group.
    roles Sequence[str]
    A list of roles to be attached. There must be at least one role.
    users Sequence[str]
    A list of users to be attached. There must be at least one user.
    policyArn String
    The Amazon Resource Name (ARN) of the policy to be attached.
    groups List<String>
    A list of groups to be attached. There must be at least one group.
    roles List<String>
    A list of roles to be attached. There must be at least one role.
    users List<String>
    A list of users to be attached. There must be at least one user.

    BudgetsActionNotificationType, BudgetsActionNotificationTypeArgs

    Actual
    ACTUAL
    Forecasted
    FORECASTED
    BudgetsActionNotificationTypeActual
    ACTUAL
    BudgetsActionNotificationTypeForecasted
    FORECASTED
    Actual
    ACTUAL
    Forecasted
    FORECASTED
    Actual
    ACTUAL
    Forecasted
    FORECASTED
    ACTUAL
    ACTUAL
    FORECASTED
    FORECASTED
    "ACTUAL"
    ACTUAL
    "FORECASTED"
    FORECASTED

    BudgetsActionScpActionDefinition, BudgetsActionScpActionDefinitionArgs

    PolicyId string
    The policy ID attached.
    TargetIds List<string>
    A list of target IDs.
    PolicyId string
    The policy ID attached.
    TargetIds []string
    A list of target IDs.
    policyId String
    The policy ID attached.
    targetIds List<String>
    A list of target IDs.
    policyId string
    The policy ID attached.
    targetIds string[]
    A list of target IDs.
    policy_id str
    The policy ID attached.
    target_ids Sequence[str]
    A list of target IDs.
    policyId String
    The policy ID attached.
    targetIds List<String>
    A list of target IDs.

    BudgetsActionSsmActionDefinition, BudgetsActionSsmActionDefinitionArgs

    InstanceIds List<string>
    The EC2 and RDS instance IDs.
    Region string
    The Region to run the ( SSM ) document.
    Subtype Pulumi.AwsNative.Budgets.BudgetsActionSsmActionDefinitionSubtype
    The action subType.
    InstanceIds []string
    The EC2 and RDS instance IDs.
    Region string
    The Region to run the ( SSM ) document.
    Subtype BudgetsActionSsmActionDefinitionSubtype
    The action subType.
    instanceIds List<String>
    The EC2 and RDS instance IDs.
    region String
    The Region to run the ( SSM ) document.
    subtype BudgetsActionSsmActionDefinitionSubtype
    The action subType.
    instanceIds string[]
    The EC2 and RDS instance IDs.
    region string
    The Region to run the ( SSM ) document.
    subtype BudgetsActionSsmActionDefinitionSubtype
    The action subType.
    instance_ids Sequence[str]
    The EC2 and RDS instance IDs.
    region str
    The Region to run the ( SSM ) document.
    subtype BudgetsActionSsmActionDefinitionSubtype
    The action subType.
    instanceIds List<String>
    The EC2 and RDS instance IDs.
    region String
    The Region to run the ( SSM ) document.
    subtype "STOP_EC2_INSTANCES" | "STOP_RDS_INSTANCES"
    The action subType.

    BudgetsActionSsmActionDefinitionSubtype, BudgetsActionSsmActionDefinitionSubtypeArgs

    StopEc2Instances
    STOP_EC2_INSTANCES
    StopRdsInstances
    STOP_RDS_INSTANCES
    BudgetsActionSsmActionDefinitionSubtypeStopEc2Instances
    STOP_EC2_INSTANCES
    BudgetsActionSsmActionDefinitionSubtypeStopRdsInstances
    STOP_RDS_INSTANCES
    StopEc2Instances
    STOP_EC2_INSTANCES
    StopRdsInstances
    STOP_RDS_INSTANCES
    StopEc2Instances
    STOP_EC2_INSTANCES
    StopRdsInstances
    STOP_RDS_INSTANCES
    STOP_EC2_INSTANCES
    STOP_EC2_INSTANCES
    STOP_RDS_INSTANCES
    STOP_RDS_INSTANCES
    "STOP_EC2_INSTANCES"
    STOP_EC2_INSTANCES
    "STOP_RDS_INSTANCES"
    STOP_RDS_INSTANCES

    BudgetsActionSubscriber, BudgetsActionSubscriberArgs

    Address string

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    Type Pulumi.AwsNative.Budgets.BudgetsActionSubscriberType
    The type of notification that AWS sends to a subscriber.
    Address string

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    Type BudgetsActionSubscriberType
    The type of notification that AWS sends to a subscriber.
    address String

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    type BudgetsActionSubscriberType
    The type of notification that AWS sends to a subscriber.
    address string

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    type BudgetsActionSubscriberType
    The type of notification that AWS sends to a subscriber.
    address str

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    type BudgetsActionSubscriberType
    The type of notification that AWS sends to a subscriber.
    address String

    The address that AWS sends budget notifications to, either an SNS topic or an email.

    When you create a subscriber, the value of Address can't contain line breaks.

    type "SNS" | "EMAIL"
    The type of notification that AWS sends to a subscriber.

    BudgetsActionSubscriberType, BudgetsActionSubscriberTypeArgs

    Sns
    SNS
    Email
    EMAIL
    BudgetsActionSubscriberTypeSns
    SNS
    BudgetsActionSubscriberTypeEmail
    EMAIL
    Sns
    SNS
    Email
    EMAIL
    Sns
    SNS
    Email
    EMAIL
    SNS
    SNS
    EMAIL
    EMAIL
    "SNS"
    SNS
    "EMAIL"
    EMAIL

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native