Skip to content

Describe Stack Instance

cloudformation_describe_stack_instance R Documentation

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region

Description

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

For a list of stack instances that are associated with a specific StackSet, use list_stack_instances.

Usage

cloudformation_describe_stack_instance(StackSetName,
  StackInstanceAccount, StackInstanceRegion, CallAs)

Arguments

StackSetName

[required] The name or the unique stack ID of the stack set that you want to get stack instance information for.
StackInstanceAccount

[required] The ID of an Amazon Web Services account that's associated with this stack instance.
StackInstanceRegion

[required] The name of a Region that's associated with this stack instance.
CallAs

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Value

A list with the following syntax:

list(
  StackInstance = list(
    StackSetId = "string",
    Region = "string",
    Account = "string",
    StackId = "string",
    ParameterOverrides = list(
      list(
        ParameterKey = "string",
        ParameterValue = "string",
        UsePreviousValue = TRUE|FALSE,
        ResolvedValue = "string"
      )
    ),
    Status = "CURRENT"|"OUTDATED"|"INOPERABLE",
    StackInstanceStatus = list(
      DetailedStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|"INOPERABLE"|"SKIPPED_SUSPENDED_ACCOUNT"|"FAILED_IMPORT"
    ),
    StatusReason = "string",
    OrganizationalUnitId = "string",
    DriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
    LastDriftCheckTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastOperationId = "string"
  )
)

Request syntax

svc$describe_stack_instance(
  StackSetName = "string",
  StackInstanceAccount = "string",
  StackInstanceRegion = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)