AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cloudformation ]
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 ListStackInstances .
See also: AWS API Documentation
describe-stack-instance
--stack-set-name <value>
--stack-instance-account <value>
--stack-instance-region <value>
[--call-as <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--stack-set-name
(string)
The name or the unique stack ID of the stack set that you want to get stack instance information for.
--stack-instance-account
(string)
The ID of an Amazon Web Services account that's associated with this stack instance.
--stack-instance-region
(string)
The name of a Region that's associated with this stack instance.
--call-as
(string)
[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. UseSELF
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 .Possible values:
SELF
DELEGATED_ADMIN
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe a stack instance
The following command describes an instance of the specified stack set in the specified account and Region. The stack set is in the current region and account, and the instance is in the us-west-2
region in account 123456789012
.:
aws cloudformation describe-stack-instance \
--stack-set-name my-stack-set \
--stack-instance-account 123456789012 \
--stack-instance-region us-west-2
Output:
{
"StackInstance": {
"StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
"Region": "us-west-2",
"Account": "123456789012",
"StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/4287f9a0-e615-xmpl-894a-12b31d3117be",
"ParameterOverrides": [],
"Status": "OUTDATED",
"StatusReason": "ResourceLogicalId:ConfigBucket, ResourceType:AWS::S3::Bucket, ResourceStatusReason:You have attempted to create more buckets than allowed (Service: Amazon S3; Status Code: 400; Error Code: TooManyBuckets; Request ID: F7F21CXMPL580224; S3 Extended Request ID: egd/Fdt89BXMPLyiqbMNljVk55Yqqvi3NYW2nKLUVWhUGEhNfCmZdyj967lhriaG/dWMobSO40o=)."
}
}
StackInstance -> (structure)
The stack instance that matches the specified request parameters.
StackSetId -> (string)
The name or unique ID of the stack set that the stack instance is associated with.Region -> (string)
The name of the Amazon Web Services Region that the stack instance is associated with.Account -> (string)
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.StackId -> (string)
The ID of the stack instance.ParameterOverrides -> (list)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
(structure)
The Parameter data type.
ParameterKey -> (string)
The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.ParameterValue -> (string)
The input value associated with the parameter.UsePreviousValue -> (boolean)
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specifytrue
, do not specify a parameter value.ResolvedValue -> (string)
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.Status -> (string)
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, to delete the stack instance, and then delete the stack manually.INOPERABLE
can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at theDetailedStatus
member in theStackInstanceSummary
member that is a peer to thisStatus
member.OUTDATED
: The stack isn't currently up to date with the stack set because:
- The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation.- The stack was part of a
CreateStackSet
orUpdateStackSet
operation that failed or was stopped before the stack was created or updated.CURRENT
: The stack is currently up to date with the stack set.StackInstanceStatus -> (structure)
The detailed status of the stack instance.
DetailedStatus -> (string)
CANCELLED
: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.FAILED
: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.FAILED_IMPORT
: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, to delete the stack instance, and then delete the stack manually.PENDING
: The operation in the specified account and Region has yet to start.RUNNING
: The operation in the specified account and Region is currently in progress.SKIPPED_SUSPENDED_ACCOUNT
: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.SUCCEEDED
: The operation in the specified account and Region completed successfully.StatusReason -> (string)
The explanation for the specific status code that's assigned to this stack instance.OrganizationalUnitId -> (string)
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .DriftStatus -> (string)
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.NOT_CHECKED
: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.IN_SYNC
: The stack instance's actual configuration matches its expected stack set configuration.UNKNOWN
: This value is reserved for future use.LastDriftCheckTimestamp -> (timestamp)
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will beNULL
for any stack instance on which drift detection hasn't yet been performed.LastOperationId -> (string)
The last unique ID of a StackSet operation performed on a stack instance.