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

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.getStack

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.

    Using getStack

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStack(args: GetStackArgs, opts?: InvokeOptions): Promise<GetStackResult>
    function getStackOutput(args: GetStackOutputArgs, opts?: InvokeOptions): Output<GetStackResult>
    def get_stack(stack_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetStackResult
    def get_stack_output(stack_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetStackResult]
    func LookupStack(ctx *Context, args *LookupStackArgs, opts ...InvokeOption) (*LookupStackResult, error)
    func LookupStackOutput(ctx *Context, args *LookupStackOutputArgs, opts ...InvokeOption) LookupStackResultOutput

    > Note: This function is named LookupStack in the Go SDK.

    public static class GetStack 
    {
        public static Task<GetStackResult> InvokeAsync(GetStackArgs args, InvokeOptions? opts = null)
        public static Output<GetStackResult> Invoke(GetStackInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStackResult> getStack(GetStackArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudformation:getStack
      arguments:
        # arguments dictionary

    The following arguments are supported:

    StackId string
    StackId string
    stackId String
    stackId string
    stackId String

    getStack Result

    The following output properties are available:

    Capabilities List<Pulumi.AwsNative.CloudFormation.StackCapabilitiesItem>
    ChangeSetId string
    CreationTime string
    Description string
    DisableRollback bool
    EnableTerminationProtection bool
    LastUpdateTime string
    NotificationArns List<string>
    Outputs List<Pulumi.AwsNative.CloudFormation.Outputs.StackOutput>
    Parameters Dictionary<string, string>
    ParentId string
    RoleArn string
    RootId string
    StackId string
    StackPolicyBody object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    StackStatus Pulumi.AwsNative.CloudFormation.StackStatus
    StackStatusReason string
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    TemplateBody object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    TimeoutInMinutes int
    Capabilities []StackCapabilitiesItem
    ChangeSetId string
    CreationTime string
    Description string
    DisableRollback bool
    EnableTerminationProtection bool
    LastUpdateTime string
    NotificationArns []string
    Outputs []StackOutputType
    Parameters map[string]string
    ParentId string
    RoleArn string
    RootId string
    StackId string
    StackPolicyBody interface{}
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    StackStatus StackStatus
    StackStatusReason string
    Tags Tag
    TemplateBody interface{}
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    TimeoutInMinutes int
    capabilities List<StackCapabilitiesItem>
    changeSetId String
    creationTime String
    description String
    disableRollback Boolean
    enableTerminationProtection Boolean
    lastUpdateTime String
    notificationArns List<String>
    outputs List<StackOutput>
    parameters Map<String,String>
    parentId String
    roleArn String
    rootId String
    stackId String
    stackPolicyBody Object
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackStatus StackStatus
    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.
    timeoutInMinutes Integer
    capabilities StackCapabilitiesItem[]
    changeSetId string
    creationTime string
    description string
    disableRollback boolean
    enableTerminationProtection boolean
    lastUpdateTime string
    notificationArns string[]
    outputs StackOutput[]
    parameters {[key: string]: string}
    parentId string
    roleArn string
    rootId string
    stackId string
    stackPolicyBody any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackStatus StackStatus
    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.
    timeoutInMinutes number
    capabilities Sequence[StackCapabilitiesItem]
    change_set_id str
    creation_time str
    description str
    disable_rollback bool
    enable_termination_protection bool
    last_update_time str
    notification_arns Sequence[str]
    outputs Sequence[StackOutput]
    parameters Mapping[str, str]
    parent_id str
    role_arn str
    root_id str
    stack_id 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_status StackStatus
    stack_status_reason str
    tags Sequence[root_Tag]
    template_body Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    timeout_in_minutes int
    capabilities List<"CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND">
    changeSetId String
    creationTime String
    description String
    disableRollback Boolean
    enableTerminationProtection Boolean
    lastUpdateTime String
    notificationArns List<String>
    outputs List<Property Map>
    parameters Map<String>
    parentId String
    roleArn String
    rootId String
    stackId String
    stackPolicyBody Any
    Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.
    stackStatus "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "CREATE_COMPLETE" | "ROLLBACK_IN_PROGRESS" | "ROLLBACK_FAILED" | "ROLLBACK_COMPLETE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETE_COMPLETE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "UPDATE_ROLLBACK_IN_PROGRESS" | "UPDATE_ROLLBACK_FAILED" | "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" | "UPDATE_ROLLBACK_COMPLETE" | "REVIEW_IN_PROGRESS" | "IMPORT_IN_PROGRESS" | "IMPORT_COMPLETE" | "IMPORT_ROLLBACK_IN_PROGRESS" | "IMPORT_ROLLBACK_FAILED" | "IMPORT_ROLLBACK_COMPLETE"
    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.
    timeoutInMinutes Number

    Supporting Types

    StackCapabilitiesItem

    StackOutput

    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

    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 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