The following example removes a specific version of the My::Resource::Example resource type from active use in the CloudFormation registry.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DeregisterType &Version=2010-05-15
&TypeName=My::Resource::Example &Type=RESOURCE
&VersionId=00000002
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20191204T181601Z
&X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]
Sample Response
<DeregisterTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DeregisterTypeResult/>
<ResponseMetadata>
See Also
<RequestId>78c291d1-4463-4845-a600-29221example</RequestId>
</ResponseMetadata>
</DeregisterTypeResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeAccountLimits
DescribeAccountLimits
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Quotas in the AWS CloudFormation User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
NextToken
A string that identifies the next page of limits that you want to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Elements
The following elements are returned by the service.
AccountLimits.member.N
An account limit structure that contain a list of AWS CloudFormation account limits and their values.
Type: Array of AccountLimit (p. 232) objects NextToken
If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 331).
Examples
DescribeAccountLimits
This example illustrates one usage of DescribeAccountLimits.
Sample Request
See Also
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeAccountLimits &NextToken=[NextToken]
&Version=2010-05-15 &SignatureVersion=2
&Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID]
&Signature=[Signature]
Sample Response
<DescribeAccountLimitsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeAccountLimitsResult>
<AccountLimits>
<member>
<Name>StackLimit</Name>
<Value>20</Value>
</member>
</AccountLimits>
</DescribeAccountLimitsResult>
<ResponseMetadata>
<RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
</ResponseMetadata>
</DescribeAccountLimitsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeChangeSet
DescribeChangeSet
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
ChangeSetName
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*
Required: Yes NextToken
A string (provided by the DescribeChangeSet (p. 59) response output) that identifies the next page of information that you want to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No StackName
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
Type: String
Length Constraints: Minimum length of 1.
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
Required: No
Response Elements
The following elements are returned by the service.
Capabilities.member.N
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
Type: Array of strings
Response Elements
Valid Values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND Changes.member.N
A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.
Type: Array of Change (p. 235) objects ChangeSetId
The Amazon Resource Name (ARN) of the change set.
Type: String
Length Constraints: Minimum length of 1.
Pattern: arn:[-a-zA-Z0-9:/]*
ChangeSetName
The name of the change set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z][-a-zA-Z0-9]*
CreationTime
The start time when the change set was created, in UTC.
Type: Timestamp Description
Information about the change set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
ExecutionStatus
If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
Type: String
Valid Values: UNAVAILABLE | AVAILABLE | EXECUTE_IN_PROGRESS | EXECUTE_COMPLETE
| EXECUTE_FAILED | OBSOLETE IncludeNestedStacks
Verifies if IncludeNestedStacks is set to True.
Type: Boolean NextToken
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
Type: String
Response Elements
Length Constraints: Minimum length of 1. Maximum length of 1024.
NotificationARNs.member.N
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
Type: Array of strings
Array Members: Maximum number of 5 items.
Parameters.member.N
A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
Type: Array of Parameter (p. 249) objects ParentChangeSetId
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
Type: String
Length Constraints: Minimum length of 1.
Pattern: arn:[-a-zA-Z0-9:/]*
RollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Type: RollbackConfiguration (p. 264) object RootChangeSetId
Specifies the change set ID of the root change set in the current nested change set hierarchy.
Type: String
Length Constraints: Minimum length of 1.
Pattern: arn:[-a-zA-Z0-9:/]*
StackId
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
Type: String StackName
The name of the stack that's associated with the change set.
Type: String Status
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
Type: String
Valid Values: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_COMPLETE | DELETE_FAILED | FAILED
Errors
StatusReason
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
Type: String Tags.member.N
If you execute the change set, the tags that will be associated with the stack.
Type: Array of Tag (p. 315) objects
Array Members: Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 331).
ChangeSetNotFound
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.
HTTP Status Code: 404
Examples
DescribeChangeSet
This example illustrates one usage of DescribeChangeSet.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeChangeSet
&ChangeSetName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/
SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b &Version=2010-05-15
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20160316T233349Z
&X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]
Sample Response
<DescribeChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeChangeSetResult>
<StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/
SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
<Status>CREATE_COMPLETE</Status>
<ChangeSetId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet-direct/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ChangeSetId>
<StackName>SampleStack</StackName>
See Also
<ChangeSetName>SampleChangeSet-direct</ChangeSetName>
<NotificationARNs/>
<CreationTime>2016-03-17T23:35:25.813Z</CreationTime>
<Capabilities/>
<Parameters>
<member>
<ParameterValue>testing</ParameterValue>
<ParameterKey>Purpose</ParameterKey>
</member>
<member>
<ParameterValue>MyKeyName</ParameterValue>
<ParameterKey>KeyPairName</ParameterKey>
</member>
<member>
<ParameterValue>t2.micro</ParameterValue>
<ParameterKey>InstanceType</ParameterKey>
</member>
</Parameters>
<Changes>
<member>
<ResourceChange>
<Replacement>False</Replacement>
<Scope>
<member>Tags</member>
</Scope>
<Details>
<member>
<ChangeSource>DirectModification</ChangeSource>
<Target>
<LogicalResourceId>MyEC2Instance</LogicalResourceId>
<Action>Modify</Action>
<PhysicalResourceId>i-1abc23d4</PhysicalResourceId>
<ResourceType>AWS::EC2::Instance</ResourceType>
</ResourceChange>
<Type>Resource</Type>
</member>
</Changes>
</DescribeChangeSetResult>
<ResponseMetadata>
<RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
</ResponseMetadata>
</DescribeChangeSetResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeChangeSetHooks
DescribeChangeSetHooks
Returns hook-related information for the change set and a list of changes that AWS CloudFormation makes when you run the change set.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
ChangeSetName
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*
Required: Yes LogicalResourceId
If specified, lists only the hooks related to the specified LogicalResourceId.
Type: String Required: No NextToken
A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No StackName
If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.
Type: String
Length Constraints: Minimum length of 1.
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
Required: No
Response Elements
The following elements are returned by the service.
Errors
ChangeSetId
The change set identifier (stack ID).
Type: String
Length Constraints: Minimum length of 1.
Pattern: arn:[-a-zA-Z0-9:/]*
ChangeSetName
The change set name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z][-a-zA-Z0-9]*
Hooks.member.N List of hook objects.
Type: Array of ChangeSetHook (p. 236) objects NextToken
Pagination token, null or empty if no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
StackId
The stack identifier (stack ID).
Type: String StackName
The stack name.
Type: String Status
Provides the status of the change set hook.
Type: String
Valid Values: PLANNING | PLANNED | UNAVAILABLE
Errors
For information about the errors that are common to all actions, see Common Errors (p. 331).
ChangeSetNotFound
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.
HTTP Status Code: 404
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribePublisher
DescribePublisher
Returns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
• RegisterPublisher
• Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
PublisherId
The ID of the extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern: [0-9a-zA-Z]{12,40}
Required: No
Response Elements
The following elements are returned by the service.
IdentityProvider
The type of account used as the identity provider when registering this publisher with CloudFormation.
Type: String
Valid Values: AWS_Marketplace | GitHub | Bitbucket PublisherId
The ID of the extension publisher.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern: [0-9a-zA-Z]{12,40}
PublisherProfile
The URL to the publisher's profile with the identity provider.
Errors
Type: String
Length Constraints: Maximum length of 1024.
Pattern: (http:|https:)+[^\s]+[\w]
PublisherStatus
Whether the publisher is verified. Currently, all registered publishers are verified.
Type: String
Valid Values: VERIFIED | UNVERIFIED
Errors
For information about the errors that are common to all actions, see Common Errors (p. 331).
CFNRegistry
An error occurred during a CloudFormation registry operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeStackDriftDetectionStatus
DescribeStackDriftDetectionStatus
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift (p. 110) to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts (p. 81) to return drift information about the stack and its resources.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
StackDriftDetectionId
The ID of the drift detection results of this operation.
AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: Yes
Response Elements
The following elements are returned by the service.
DetectionStatus
The status of the stack drift detection operation.
• DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)
If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
• DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.
• DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
Type: String
Valid Values: DETECTION_IN_PROGRESS | DETECTION_FAILED | DETECTION_COMPLETE DetectionStatusReason
The reason the stack drift detection operation has its current status.
Errors
Type: String
DriftedStackResourceCount
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.
Type: Integer StackDriftDetectionId
The ID of the drift detection results of this operation.
AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
StackDriftStatus
Status of the stack's actual configuration compared to its expected configuration.
• DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
• NOT_CHECKED: AWS CloudFormation hasn't checked if the stack differs from its expected template configuration.
• IN_SYNC: The stack's actual configuration matches its expected template configuration.
• UNKNOWN: This value is reserved for future use.
Type: String
Valid Values: DRIFTED | IN_SYNC | UNKNOWN | NOT_CHECKED StackId
The ID of the stack.
Type: String Timestamp
Time at which the stack drift detection operation was initiated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 331).
Examples
DescribeStackDriftDetectionStatus
This example illustrates one usage of DescribeStackDriftDetectionStatus.
Sample Request
See Also
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeStackDriftDetectionStatus &Version=2010-05-15
&StackDriftDetectionId=b78ac9b0-dec1-11e7-a451-503a3example &X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20171211T230005Z
&X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]
Sample Response
<DescribeStackDriftDetectionStatusResponse xmlns="http://cloudformation.amazonaws.com/
doc/2010-05-15/">
<DescribeStackDriftDetectionStatusResult>
<DetectionStatus>DETECTION_COMPLETE</DetectionStatus>
<StackDriftDetectionId>b78ac9b0-dec1-11e7-a451-503a3example</StackDriftDetectionId>
<DriftedStackResourceCount>0</DriftedStackResourceCount>
<StackId>arn:aws:cloudformation:us-east-1:012345678910:stack/example/
cb438120-6cc7-11e7-998e-50example</StackId>
<StackDriftStatus>IN_SYNC</StackDriftStatus>
<Timestamp>2017-12-11T22:22:04.747Z</Timestamp>
</DescribeStackDriftDetectionStatusResult>
<ResponseMetadata>
<RequestId>f89bbda1-dec1-11e7-83c6-d92bexample</RequestId>
</ResponseMetadata>
</DescribeStackDriftDetectionStatusResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeStackEvents
DescribeStackEvents
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
NoteYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 329).
NextToken
A string that identifies the next page of events that you want to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No StackName
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.
• Deleted stacks: You must specify the unique stack ID.