1. Packages
  2. AWS Native
  3. API Docs
  4. cloudformation
  5. Stack

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.cloudformation.Stack

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

    Create Stack Resource

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

    Constructor syntax

    new Stack(name: string, args?: StackArgs, opts?: CustomResourceOptions);
    @overload
    def Stack(resource_name: str,
              args: Optional[StackArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Stack(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              capabilities: Optional[Sequence[StackCapabilitiesItem]] = None,
              description: Optional[str] = None,
              disable_rollback: Optional[bool] = None,
              enable_termination_protection: Optional[bool] = None,
              notification_arns: Optional[Sequence[str]] = None,
              parameters: Optional[Mapping[str, str]] = None,
              role_arn: Optional[str] = None,
              stack_name: Optional[str] = None,
              stack_policy_body: Optional[Any] = None,
              stack_policy_url: Optional[str] = None,
              stack_status_reason: Optional[str] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              template_body: Optional[Any] = None,
              template_url: Optional[str] = None,
              timeout_in_minutes: Optional[int] = None)
    func NewStack(ctx *Context, name string, args *StackArgs, opts ...ResourceOption) (*Stack, error)
    public Stack(string name, StackArgs? args = null, CustomResourceOptions? opts = null)
    public Stack(String name, StackArgs args)
    public Stack(String name, StackArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudformation:Stack
    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 StackArgs
    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 StackArgs
    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 StackArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StackArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StackArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const stackResource = new aws_native.cloudformation.Stack("stackResource", {
        capabilities: [aws_native.cloudformation.StackCapabilitiesItem.CapabilityIam],
        description: "string",
        disableRollback: false,
        enableTerminationProtection: false,
        notificationArns: ["string"],
        parameters: {
            string: "string",
        },
        roleArn: "string",
        stackName: "string",
        stackPolicyBody: "any",
        stackPolicyUrl: "string",
        stackStatusReason: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        templateBody: "any",
        templateUrl: "string",
        timeoutInMinutes: 0,
    });
    
    Coming soon!
    

    Stack Resource Properties

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

    Inputs

    The Stack resource accepts the following input properties:

    Capabilities List<Pulumi.AwsNative.CloudFormation.StackCapabilitiesItem>
    Description string
    DisableRollback bool
    EnableTerminationProtection bool
    NotificationArns List<string>
    Parameters Dictionary<string, string>
    RoleArn string
    StackName string
    StackPolicyBody object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    StackPolicyUrl string
    StackStatusReason string
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    TemplateBody object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    TemplateUrl string
    TimeoutInMinutes int
    Capabilities []StackCapabilitiesItem
    Description string
    DisableRollback bool
    EnableTerminationProtection bool
    NotificationArns []string
    Parameters map[string]string
    RoleArn string
    StackName string
    StackPolicyBody interface{}
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    StackPolicyUrl string
    StackStatusReason string
    Tags TagArgs
    TemplateBody interface{}
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    TemplateUrl string
    TimeoutInMinutes int
    capabilities List<StackCapabilitiesItem>
    description String
    disableRollback Boolean
    enableTerminationProtection Boolean
    notificationArns List<String>
    parameters Map<String,String>
    roleArn String
    stackName String
    stackPolicyBody Object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackPolicyUrl String
    stackStatusReason String
    tags List<Tag>
    templateBody Object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    templateUrl String
    timeoutInMinutes Integer
    capabilities StackCapabilitiesItem[]
    description string
    disableRollback boolean
    enableTerminationProtection boolean
    notificationArns string[]
    parameters {[key: string]: string}
    roleArn string
    stackName string
    stackPolicyBody any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackPolicyUrl string
    stackStatusReason string
    tags Tag[]
    templateBody any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    templateUrl string
    timeoutInMinutes number
    capabilities Sequence[StackCapabilitiesItem]
    description str
    disable_rollback bool
    enable_termination_protection bool
    notification_arns Sequence[str]
    parameters Mapping[str, str]
    role_arn str
    stack_name str
    stack_policy_body Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stack_policy_url str
    stack_status_reason str
    tags Sequence[TagArgs]
    template_body Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    template_url str
    timeout_in_minutes int
    capabilities List<"CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND">
    description String
    disableRollback Boolean
    enableTerminationProtection Boolean
    notificationArns List<String>
    parameters Map<String>
    roleArn String
    stackName String
    stackPolicyBody Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackPolicyUrl String
    stackStatusReason String
    tags List<Property Map>
    templateBody Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    templateUrl String
    timeoutInMinutes Number

    Outputs

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

    ChangeSetId string
    CreationTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdateTime string
    Outputs []StackOutputType
    ParentId string
    RootId string
    StackId string
    StackStatus StackStatus
    changeSetId String
    creationTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdateTime String
    outputs List<StackOutput>
    parentId String
    rootId String
    stackId String
    stackStatus StackStatus
    changeSetId string
    creationTime string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdateTime string
    outputs StackOutput[]
    parentId string
    rootId string
    stackId string
    stackStatus StackStatus
    change_set_id str
    creation_time str
    id str
    The provider-assigned unique ID for this managed resource.
    last_update_time str
    outputs Sequence[StackOutput]
    parent_id str
    root_id str
    stack_id str
    stack_status StackStatus

    Supporting Types

    StackCapabilitiesItem, StackCapabilitiesItemArgs

    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    StackCapabilitiesItemCapabilityIam
    CAPABILITY_IAM
    StackCapabilitiesItemCapabilityNamedIam
    CAPABILITY_NAMED_IAM
    StackCapabilitiesItemCapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_IAM
    CAPABILITY_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_AUTO_EXPAND
    "CAPABILITY_IAM"
    CAPABILITY_IAM
    "CAPABILITY_NAMED_IAM"
    CAPABILITY_NAMED_IAM
    "CAPABILITY_AUTO_EXPAND"
    CAPABILITY_AUTO_EXPAND

    StackOutput, StackOutputArgs

    Description string
    ExportName string
    OutputKey string
    OutputValue string
    Description string
    ExportName string
    OutputKey string
    OutputValue string
    description String
    exportName String
    outputKey String
    outputValue String
    description string
    exportName string
    outputKey string
    outputValue string
    description String
    exportName String
    outputKey String
    outputValue String

    StackStatus, StackStatusArgs

    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    CreateComplete
    CREATE_COMPLETE
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    RollbackFailed
    ROLLBACK_FAILED
    RollbackComplete
    ROLLBACK_COMPLETE
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    DeleteComplete
    DELETE_COMPLETE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateCompleteCleanupInProgress
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateComplete
    UPDATE_COMPLETE
    UpdateFailed
    UPDATE_FAILED
    UpdateRollbackInProgress
    UPDATE_ROLLBACK_IN_PROGRESS
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    UpdateRollbackCompleteCleanupInProgress
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateRollbackComplete
    UPDATE_ROLLBACK_COMPLETE
    ReviewInProgress
    REVIEW_IN_PROGRESS
    ImportInProgress
    IMPORT_IN_PROGRESS
    ImportComplete
    IMPORT_COMPLETE
    ImportRollbackInProgress
    IMPORT_ROLLBACK_IN_PROGRESS
    ImportRollbackFailed
    IMPORT_ROLLBACK_FAILED
    ImportRollbackComplete
    IMPORT_ROLLBACK_COMPLETE
    StackStatusCreateInProgress
    CREATE_IN_PROGRESS
    StackStatusCreateFailed
    CREATE_FAILED
    StackStatusCreateComplete
    CREATE_COMPLETE
    StackStatusRollbackInProgress
    ROLLBACK_IN_PROGRESS
    StackStatusRollbackFailed
    ROLLBACK_FAILED
    StackStatusRollbackComplete
    ROLLBACK_COMPLETE
    StackStatusDeleteInProgress
    DELETE_IN_PROGRESS
    StackStatusDeleteFailed
    DELETE_FAILED
    StackStatusDeleteComplete
    DELETE_COMPLETE
    StackStatusUpdateInProgress
    UPDATE_IN_PROGRESS
    StackStatusUpdateCompleteCleanupInProgress
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    StackStatusUpdateComplete
    UPDATE_COMPLETE
    StackStatusUpdateFailed
    UPDATE_FAILED
    StackStatusUpdateRollbackInProgress
    UPDATE_ROLLBACK_IN_PROGRESS
    StackStatusUpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    StackStatusUpdateRollbackCompleteCleanupInProgress
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    StackStatusUpdateRollbackComplete
    UPDATE_ROLLBACK_COMPLETE
    StackStatusReviewInProgress
    REVIEW_IN_PROGRESS
    StackStatusImportInProgress
    IMPORT_IN_PROGRESS
    StackStatusImportComplete
    IMPORT_COMPLETE
    StackStatusImportRollbackInProgress
    IMPORT_ROLLBACK_IN_PROGRESS
    StackStatusImportRollbackFailed
    IMPORT_ROLLBACK_FAILED
    StackStatusImportRollbackComplete
    IMPORT_ROLLBACK_COMPLETE
    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    CreateComplete
    CREATE_COMPLETE
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    RollbackFailed
    ROLLBACK_FAILED
    RollbackComplete
    ROLLBACK_COMPLETE
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    DeleteComplete
    DELETE_COMPLETE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateCompleteCleanupInProgress
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateComplete
    UPDATE_COMPLETE
    UpdateFailed
    UPDATE_FAILED
    UpdateRollbackInProgress
    UPDATE_ROLLBACK_IN_PROGRESS
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    UpdateRollbackCompleteCleanupInProgress
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateRollbackComplete
    UPDATE_ROLLBACK_COMPLETE
    ReviewInProgress
    REVIEW_IN_PROGRESS
    ImportInProgress
    IMPORT_IN_PROGRESS
    ImportComplete
    IMPORT_COMPLETE
    ImportRollbackInProgress
    IMPORT_ROLLBACK_IN_PROGRESS
    ImportRollbackFailed
    IMPORT_ROLLBACK_FAILED
    ImportRollbackComplete
    IMPORT_ROLLBACK_COMPLETE
    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    CreateComplete
    CREATE_COMPLETE
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    RollbackFailed
    ROLLBACK_FAILED
    RollbackComplete
    ROLLBACK_COMPLETE
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    DeleteComplete
    DELETE_COMPLETE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateCompleteCleanupInProgress
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateComplete
    UPDATE_COMPLETE
    UpdateFailed
    UPDATE_FAILED
    UpdateRollbackInProgress
    UPDATE_ROLLBACK_IN_PROGRESS
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    UpdateRollbackCompleteCleanupInProgress
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    UpdateRollbackComplete
    UPDATE_ROLLBACK_COMPLETE
    ReviewInProgress
    REVIEW_IN_PROGRESS
    ImportInProgress
    IMPORT_IN_PROGRESS
    ImportComplete
    IMPORT_COMPLETE
    ImportRollbackInProgress
    IMPORT_ROLLBACK_IN_PROGRESS
    ImportRollbackFailed
    IMPORT_ROLLBACK_FAILED
    ImportRollbackComplete
    IMPORT_ROLLBACK_COMPLETE
    CREATE_IN_PROGRESS
    CREATE_IN_PROGRESS
    CREATE_FAILED
    CREATE_FAILED
    CREATE_COMPLETE
    CREATE_COMPLETE
    ROLLBACK_IN_PROGRESS
    ROLLBACK_IN_PROGRESS
    ROLLBACK_FAILED
    ROLLBACK_FAILED
    ROLLBACK_COMPLETE
    ROLLBACK_COMPLETE
    DELETE_IN_PROGRESS
    DELETE_IN_PROGRESS
    DELETE_FAILED
    DELETE_FAILED
    DELETE_COMPLETE
    DELETE_COMPLETE
    UPDATE_IN_PROGRESS
    UPDATE_IN_PROGRESS
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    UPDATE_COMPLETE
    UPDATE_COMPLETE
    UPDATE_FAILED
    UPDATE_FAILED
    UPDATE_ROLLBACK_IN_PROGRESS
    UPDATE_ROLLBACK_IN_PROGRESS
    UPDATE_ROLLBACK_FAILED
    UPDATE_ROLLBACK_FAILED
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    UPDATE_ROLLBACK_COMPLETE
    UPDATE_ROLLBACK_COMPLETE
    REVIEW_IN_PROGRESS
    REVIEW_IN_PROGRESS
    IMPORT_IN_PROGRESS
    IMPORT_IN_PROGRESS
    IMPORT_COMPLETE
    IMPORT_COMPLETE
    IMPORT_ROLLBACK_IN_PROGRESS
    IMPORT_ROLLBACK_IN_PROGRESS
    IMPORT_ROLLBACK_FAILED
    IMPORT_ROLLBACK_FAILED
    IMPORT_ROLLBACK_COMPLETE
    IMPORT_ROLLBACK_COMPLETE
    "CREATE_IN_PROGRESS"
    CREATE_IN_PROGRESS
    "CREATE_FAILED"
    CREATE_FAILED
    "CREATE_COMPLETE"
    CREATE_COMPLETE
    "ROLLBACK_IN_PROGRESS"
    ROLLBACK_IN_PROGRESS
    "ROLLBACK_FAILED"
    ROLLBACK_FAILED
    "ROLLBACK_COMPLETE"
    ROLLBACK_COMPLETE
    "DELETE_IN_PROGRESS"
    DELETE_IN_PROGRESS
    "DELETE_FAILED"
    DELETE_FAILED
    "DELETE_COMPLETE"
    DELETE_COMPLETE
    "UPDATE_IN_PROGRESS"
    UPDATE_IN_PROGRESS
    "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
    UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
    "UPDATE_COMPLETE"
    UPDATE_COMPLETE
    "UPDATE_FAILED"
    UPDATE_FAILED
    "UPDATE_ROLLBACK_IN_PROGRESS"
    UPDATE_ROLLBACK_IN_PROGRESS
    "UPDATE_ROLLBACK_FAILED"
    UPDATE_ROLLBACK_FAILED
    "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
    UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
    "UPDATE_ROLLBACK_COMPLETE"
    UPDATE_ROLLBACK_COMPLETE
    "REVIEW_IN_PROGRESS"
    REVIEW_IN_PROGRESS
    "IMPORT_IN_PROGRESS"
    IMPORT_IN_PROGRESS
    "IMPORT_COMPLETE"
    IMPORT_COMPLETE
    "IMPORT_ROLLBACK_IN_PROGRESS"
    IMPORT_ROLLBACK_IN_PROGRESS
    "IMPORT_ROLLBACK_FAILED"
    IMPORT_ROLLBACK_FAILED
    "IMPORT_ROLLBACK_COMPLETE"
    IMPORT_ROLLBACK_COMPLETE

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi