Describe Stacks
cloudformation_describe_stacks | R Documentation |
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created¶
Description¶
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a ValidationError
is returned.
Usage¶
Arguments¶
StackName
If you don't pass a parameter to
StackName
, the API returns a response that describes all resources in the account, which can impact performance. This requireslist_stacks
anddescribe_stacks
permissions.Consider using the
list_stacks
API if you're not passing a parameter toStackName
.The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:::stack//" }] }
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
NextToken
A string that identifies the next page of stacks that you want to retrieve.
Value¶
A list with the following syntax:
list(
Stacks = list(
list(
StackId = "string",
StackName = "string",
ChangeSetId = "string",
Description = "string",
Parameters = list(
list(
ParameterKey = "string",
ParameterValue = "string",
UsePreviousValue = TRUE|FALSE,
ResolvedValue = "string"
)
),
CreationTime = as.POSIXct(
"2015-01-01"
),
DeletionTime = as.POSIXct(
"2015-01-01"
),
LastUpdatedTime = as.POSIXct(
"2015-01-01"
),
RollbackConfiguration = list(
RollbackTriggers = list(
list(
Arn = "string",
Type = "string"
)
),
MonitoringTimeInMinutes = 123
),
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",
DisableRollback = TRUE|FALSE,
NotificationARNs = list(
"string"
),
TimeoutInMinutes = 123,
Capabilities = list(
"CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
),
Outputs = list(
list(
OutputKey = "string",
OutputValue = "string",
Description = "string",
ExportName = "string"
)
),
RoleARN = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
EnableTerminationProtection = TRUE|FALSE,
ParentId = "string",
RootId = "string",
DriftInformation = list(
StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
LastCheckTimestamp = as.POSIXct(
"2015-01-01"
)
),
RetainExceptOnCreate = TRUE|FALSE,
DeletionMode = "STANDARD"|"FORCE_DELETE_STACK",
DetailedStatus = "CONFIGURATION_COMPLETE"|"VALIDATION_FAILED"
)
),
NextToken = "string"
)