dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/cloudformation/2010-05-15/service-2.json
TANIGUCHI Takaki 2519667221 New upstream version 1.4.70
2016-11-10 11:24:10 +09:00

2243 lines
120 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2010-05-15",
"endpointPrefix":"cloudformation",
"protocol":"query",
"serviceFullName":"AWS CloudFormation",
"signatureVersion":"v4",
"xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/"
},
"operations":{
"CancelUpdateStack":{
"name":"CancelUpdateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelUpdateStackInput"},
"documentation":"<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.</p> <note> <p>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</p> </note>"
},
"ContinueUpdateRollback":{
"name":"ContinueUpdateRollback",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ContinueUpdateRollbackInput"},
"output":{
"shape":"ContinueUpdateRollbackOutput",
"resultWrapper":"ContinueUpdateRollbackResult"
},
"documentation":"<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>"
},
"CreateChangeSet":{
"name":"CreateChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateChangeSetInput"},
"output":{
"shape":"CreateChangeSetOutput",
"resultWrapper":"CreateChangeSetResult"
},
"errors":[
{"shape":"AlreadyExistsException"},
{"shape":"InsufficientCapabilitiesException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.</p> <p>AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the <a>ExecuteChangeSet</a> action.</p> <p>After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the <a>DescribeChangeSet</a> action.</p>"
},
"CreateStack":{
"name":"CreateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateStackInput"},
"output":{
"shape":"CreateStackOutput",
"resultWrapper":"CreateStackResult"
},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AlreadyExistsException"},
{"shape":"InsufficientCapabilitiesException"}
],
"documentation":"<p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>"
},
"DeleteChangeSet":{
"name":"DeleteChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteChangeSetInput"},
"output":{
"shape":"DeleteChangeSetOutput",
"resultWrapper":"DeleteChangeSetResult"
},
"errors":[
{"shape":"InvalidChangeSetStatusException"}
],
"documentation":"<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, AWS CloudFormation successfully deleted the change set.</p>"
},
"DeleteStack":{
"name":"DeleteStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteStackInput"},
"documentation":"<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.</p>"
},
"DescribeAccountLimits":{
"name":"DescribeAccountLimits",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountLimitsInput"},
"output":{
"shape":"DescribeAccountLimitsOutput",
"resultWrapper":"DescribeAccountLimitsResult"
},
"documentation":"<p>Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.</p>"
},
"DescribeChangeSet":{
"name":"DescribeChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeChangeSetInput"},
"output":{
"shape":"DescribeChangeSetOutput",
"resultWrapper":"DescribeChangeSetResult"
},
"errors":[
{"shape":"ChangeSetNotFoundException"}
],
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html\">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.</p>"
},
"DescribeStackEvents":{
"name":"DescribeStackEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackEventsInput"},
"output":{
"shape":"DescribeStackEventsOutput",
"resultWrapper":"DescribeStackEventsResult"
},
"documentation":"<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>"
},
"DescribeStackResource":{
"name":"DescribeStackResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackResourceInput"},
"output":{
"shape":"DescribeStackResourceOutput",
"resultWrapper":"DescribeStackResourceResult"
},
"documentation":"<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</p>"
},
"DescribeStackResources":{
"name":"DescribeStackResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackResourcesInput"},
"output":{
"shape":"DescribeStackResourcesOutput",
"resultWrapper":"DescribeStackResourcesResult"
},
"documentation":"<p>Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/\">AWS CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>"
},
"DescribeStacks":{
"name":"DescribeStacks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStacksInput"},
"output":{
"shape":"DescribeStacksOutput",
"resultWrapper":"DescribeStacksResult"
},
"documentation":"<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If the stack does not exist, an <code>AmazonCloudFormationException</code> is returned.</p> </note>"
},
"EstimateTemplateCost":{
"name":"EstimateTemplateCost",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EstimateTemplateCostInput"},
"output":{
"shape":"EstimateTemplateCostOutput",
"resultWrapper":"EstimateTemplateCostResult"
},
"documentation":"<p>Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>"
},
"ExecuteChangeSet":{
"name":"ExecuteChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExecuteChangeSetInput"},
"output":{
"shape":"ExecuteChangeSetOutput",
"resultWrapper":"ExecuteChangeSetResult"
},
"errors":[
{"shape":"InvalidChangeSetStatusException"},
{"shape":"ChangeSetNotFoundException"}
],
"documentation":"<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p>"
},
"GetStackPolicy":{
"name":"GetStackPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetStackPolicyInput"},
"output":{
"shape":"GetStackPolicyOutput",
"resultWrapper":"GetStackPolicyResult"
},
"documentation":"<p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</p>"
},
"GetTemplate":{
"name":"GetTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTemplateInput"},
"output":{
"shape":"GetTemplateOutput",
"resultWrapper":"GetTemplateResult"
},
"documentation":"<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</p> <note> <p> If the template does not exist, a <code>ValidationError</code> is returned. </p> </note>"
},
"GetTemplateSummary":{
"name":"GetTemplateSummary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTemplateSummaryInput"},
"output":{
"shape":"GetTemplateSummaryOutput",
"resultWrapper":"GetTemplateSummaryResult"
},
"documentation":"<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.</p>"
},
"ListChangeSets":{
"name":"ListChangeSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListChangeSetsInput"},
"output":{
"shape":"ListChangeSetsOutput",
"resultWrapper":"ListChangeSetsResult"
},
"documentation":"<p>Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>"
},
"ListExports":{
"name":"ListExports",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListExportsInput"},
"output":{
"shape":"ListExportsOutput",
"resultWrapper":"ListExportsResult"
},
"documentation":"<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>"
},
"ListStackResources":{
"name":"ListStackResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStackResourcesInput"},
"output":{
"shape":"ListStackResourcesOutput",
"resultWrapper":"ListStackResourcesResult"
},
"documentation":"<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>"
},
"ListStacks":{
"name":"ListStacks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStacksInput"},
"output":{
"shape":"ListStacksOutput",
"resultWrapper":"ListStacksResult"
},
"documentation":"<p>Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).</p>"
},
"SetStackPolicy":{
"name":"SetStackPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetStackPolicyInput"},
"documentation":"<p>Sets a stack policy for a specified stack.</p>"
},
"SignalResource":{
"name":"SignalResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SignalResourceInput"},
"documentation":"<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>"
},
"UpdateStack":{
"name":"UpdateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateStackInput"},
"output":{
"shape":"UpdateStackOutput",
"resultWrapper":"UpdateStackResult"
},
"errors":[
{"shape":"InsufficientCapabilitiesException"}
],
"documentation":"<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>"
},
"ValidateTemplate":{
"name":"ValidateTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ValidateTemplateInput"},
"output":{
"shape":"ValidateTemplateOutput",
"resultWrapper":"ValidateTemplateResult"
},
"documentation":"<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
}
},
"shapes":{
"AccountLimit":{
"type":"structure",
"members":{
"Name":{
"shape":"LimitName",
"documentation":"<p>The name of the account limit. Currently, the only account limit is <code>StackLimit</code>.</p>"
},
"Value":{
"shape":"LimitValue",
"documentation":"<p>The value that is associated with the account limit name.</p>"
}
},
"documentation":"<p>The AccountLimit data type.</p>"
},
"AccountLimitList":{
"type":"list",
"member":{"shape":"AccountLimit"}
},
"AllowedValue":{"type":"string"},
"AllowedValues":{
"type":"list",
"member":{"shape":"AllowedValue"}
},
"AlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>Resource with the name requested already exists.</p>",
"error":{
"code":"AlreadyExistsException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"CancelUpdateStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack.</p>"
}
},
"documentation":"<p>The input for the <a>CancelUpdateStack</a> action.</p>"
},
"Capabilities":{
"type":"list",
"member":{"shape":"Capability"}
},
"CapabilitiesReason":{"type":"string"},
"Capability":{
"type":"string",
"enum":[
"CAPABILITY_IAM",
"CAPABILITY_NAMED_IAM"
]
},
"CausingEntity":{"type":"string"},
"Change":{
"type":"structure",
"members":{
"Type":{
"shape":"ChangeType",
"documentation":"<p>The type of entity that AWS CloudFormation changes. Currently, the only entity type is <code>Resource</code>.</p>"
},
"ResourceChange":{
"shape":"ResourceChange",
"documentation":"<p>A <code>ResourceChange</code> structure that describes the resource and action that AWS CloudFormation will perform.</p>"
}
},
"documentation":"<p>The <code>Change</code> structure describes the changes AWS CloudFormation will perform if you execute the change set.</p>"
},
"ChangeAction":{
"type":"string",
"enum":[
"Add",
"Modify",
"Remove"
]
},
"ChangeSetId":{
"type":"string",
"min":1,
"pattern":"arn:[-a-zA-Z0-9:/]*"
},
"ChangeSetName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
},
"ChangeSetNameOrId":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*"
},
"ChangeSetNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the <code>ListChangeSets</code> action.</p>",
"error":{
"code":"ChangeSetNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ChangeSetStatus":{
"type":"string",
"enum":[
"CREATE_PENDING",
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"DELETE_COMPLETE",
"FAILED"
]
},
"ChangeSetStatusReason":{"type":"string"},
"ChangeSetSummaries":{
"type":"list",
"member":{"shape":"ChangeSetSummary"}
},
"ChangeSetSummary":{
"type":"structure",
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>The ID of the stack with which the change set is associated.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name of the stack with which the change set is associated.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The ID of the change set.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set.</p>"
},
"ExecutionStatus":{
"shape":"ExecutionStatus",
"documentation":"<p>If the change set execution status is <code>AVAILABLE</code>, 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 <code>UNAVAILABLE</code> state because AWS CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>"
},
"Status":{
"shape":"ChangeSetStatus",
"documentation":"<p>The state of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>"
},
"StatusReason":{
"shape":"ChangeSetStatusReason",
"documentation":"<p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, AWS CloudFormation shows the error message.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The start time when the change set was created, in UTC.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Descriptive information about the change set.</p>"
}
},
"documentation":"<p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the stack with which it's associated.</p>"
},
"ChangeSetType":{
"type":"string",
"enum":[
"CREATE",
"UPDATE"
]
},
"ChangeSource":{
"type":"string",
"enum":[
"ResourceReference",
"ParameterReference",
"ResourceAttribute",
"DirectModification",
"Automatic"
]
},
"ChangeType":{
"type":"string",
"enum":["Resource"]
},
"Changes":{
"type":"list",
"member":{"shape":"Change"}
},
"ClientToken":{
"type":"string",
"max":128,
"min":1
},
"ContinueUpdateRollbackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the unique ID of the stack that you want to continue rolling back.</p> <note> <p>Don't specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource).</p> </note>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"ResourcesToSkip":{
"shape":"ResourcesToSkip",
"documentation":"<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. You can specify a nested stack resource (the logical ID of an <code>AWS::CloudFormation::Stack</code> resource) only if it's in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
}
},
"documentation":"<p>The input for the <a>ContinueUpdateRollback</a> action.</p>"
},
"ContinueUpdateRollbackOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for a <a>ContinueUpdateRollback</a> action.</p>"
},
"CreateChangeSetInput":{
"type":"structure",
"required":[
"StackName",
"ChangeSetName"
],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.</p>"
},
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
"documentation":"<p>Whether to reuse the template that is associated with the stack to create the change set.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a> in the AWS CloudFormation User Guide.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set. The name must be unique among all change sets that are associated with the specified stack.</p> <p>A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.</p>"
},
"ClientToken":{
"shape":"ClientToken",
"documentation":"<p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry <code>CreateChangeSet</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description to help you identify this change set.</p>"
},
"ChangeSetType":{
"shape":"ChangeSetType",
"documentation":"<p>The type of change set operation. Valid values are <code>CREATE</code> and <code>UPDATE</code>:</p> <ul> <li> <p> <code>CREATE</code> - Specify for a change set for a stack that does not yet exist. The stack has an expected unique ID, but no template or resources. It can include multiple change sets.</p> </li> <li> <p> <code>UPDATE</code> - Specify for a change set for an existing stack.</p> </li> </ul>"
}
},
"documentation":"<p>The input for the <a>CreateChangeSet</a> action.</p>"
},
"CreateChangeSetOutput":{
"type":"structure",
"members":{
"Id":{
"shape":"ChangeSetId",
"documentation":"<p>The Amazon Resource Name (ARN) of the change set.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>The unique ID of the stack.</p>"
}
},
"documentation":"<p>The output for the <a>CreateChangeSet</a> action.</p>"
},
"CreateStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.</p> <note> <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.</p> </note>"
},
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"DisableRollback":{
"shape":"DisableRollback",
"documentation":"<p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both.</p> <p>Default: <code>false</code> </p>"
},
"TimeoutInMinutes":{
"shape":"TimeoutMinutes",
"documentation":"<p>The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href=\"https://console.aws.amazon.com/sns\">SNS console</a> or your Command Line Interface (CLI).</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific AWS resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"OnFailure":{
"shape":"OnFailure",
"documentation":"<p>Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p> <p>Default: <code>ROLLBACK</code> </p>"
},
"StackPolicyBody":{
"shape":"StackPolicyBody",
"documentation":"<p>Structure containing the stack policy body. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the <i>AWS CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.</p>"
}
},
"documentation":"<p>The input for <a>CreateStack</a> action.</p>"
},
"CreateStackOutput":{
"type":"structure",
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
}
},
"documentation":"<p>The output for a <a>CreateStack</a> action.</p>"
},
"CreationTime":{"type":"timestamp"},
"DeleteChangeSetInput":{
"type":"structure",
"required":["ChangeSetName"],
"members":{
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>The name or Amazon Resource Name (ARN) of the change set that you want to delete.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.</p>"
}
},
"documentation":"<p>The input for the <a>DeleteChangeSet</a> action.</p>"
},
"DeleteChangeSetOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for the <a>DeleteChangeSet</a> action.</p>"
},
"DeleteStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack.</p>"
},
"RetainResources":{
"shape":"RetainResources",
"documentation":"<p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.</p> <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
}
},
"documentation":"<p>The input for <a>DeleteStack</a> action.</p>"
},
"DeletionTime":{"type":"timestamp"},
"DescribeAccountLimitsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of limits that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>DescribeAccountLimits</a> action.</p>"
},
"DescribeAccountLimitsOutput":{
"type":"structure",
"members":{
"AccountLimits":{
"shape":"AccountLimitList",
"documentation":"<p>An account limit structure that contain a list of AWS CloudFormation account limits and their values.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>The output for the <a>DescribeAccountLimits</a> action.</p>"
},
"DescribeChangeSetInput":{
"type":"structure",
"required":["ChangeSetName"],
"members":{
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string (provided by the <a>DescribeChangeSet</a> response output) that identifies the next page of information that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>DescribeChangeSet</a> action.</p>"
},
"DescribeChangeSetOutput":{
"type":"structure",
"members":{
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The ARN of the change set.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>The ARN of the stack that is associated with the change set.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name of the stack that is associated with the change set.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Information about the change set.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The start time when the change set was created, in UTC.</p>"
},
"ExecutionStatus":{
"shape":"ExecutionStatus",
"documentation":"<p>If the change set execution status is <code>AVAILABLE</code>, 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 <code>UNAVAILABLE</code> state because AWS CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>"
},
"Status":{
"shape":"ChangeSetStatus",
"documentation":"<p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>"
},
"StatusReason":{
"shape":"ChangeSetStatusReason",
"documentation":"<p>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.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>If you execute the change set, the tags that will be associated with the stack.</p>"
},
"Changes":{
"shape":"Changes",
"documentation":"<p>A list of <code>Change</code> structures that describes the resources AWS CloudFormation changes if you execute the change set.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>The output for the <a>DescribeChangeSet</a> action.</p>"
},
"DescribeStackEventsInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of events that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackEvents</a> action.</p>"
},
"DescribeStackEventsOutput":{
"type":"structure",
"members":{
"StackEvents":{
"shape":"StackEvents",
"documentation":"<p>A list of <code>StackEvents</code> structures.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackEvents</a> action.</p>"
},
"DescribeStackResourceInput":{
"type":"structure",
"required":[
"StackName",
"LogicalResourceId"
],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackResource</a> action.</p>"
},
"DescribeStackResourceOutput":{
"type":"structure",
"members":{
"StackResourceDetail":{
"shape":"StackResourceDetail",
"documentation":"<p>A <code>StackResourceDetail</code> structure containing the description of the specified resource in the specified stack.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackResource</a> action.</p>"
},
"DescribeStackResourcesInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p> <p>Required: Conditional. If you do not specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p> <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p> <p>Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p> <p>Default: There is no default value.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackResources</a> action.</p>"
},
"DescribeStackResourcesOutput":{
"type":"structure",
"members":{
"StackResources":{
"shape":"StackResources",
"documentation":"<p>A list of <code>StackResource</code> structures.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackResources</a> action.</p>"
},
"DescribeStacksInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of stacks that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStacks</a> action.</p>"
},
"DescribeStacksOutput":{
"type":"structure",
"members":{
"Stacks":{
"shape":"Stacks",
"documentation":"<p>A list of stack structures.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStacks</a> action.</p>"
},
"Description":{
"type":"string",
"max":1024,
"min":1
},
"DisableRollback":{"type":"boolean"},
"EstimateTemplateCostInput":{
"type":"structure",
"members":{
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters.</p>"
}
},
"documentation":"<p>The input for an <a>EstimateTemplateCost</a> action.</p>"
},
"EstimateTemplateCostOutput":{
"type":"structure",
"members":{
"Url":{
"shape":"Url",
"documentation":"<p>An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>"
}
},
"documentation":"<p>The output for a <a>EstimateTemplateCost</a> action.</p>"
},
"EvaluationType":{
"type":"string",
"enum":[
"Static",
"Dynamic"
]
},
"EventId":{"type":"string"},
"ExecuteChangeSetInput":{
"type":"structure",
"required":["ChangeSetName"],
"members":{
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>The name or ARN of the change set that you want use to update the specified stack.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.</p>"
}
},
"documentation":"<p>The input for the <a>ExecuteChangeSet</a> action.</p>"
},
"ExecuteChangeSetOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for the <a>ExecuteChangeSet</a> action.</p>"
},
"ExecutionStatus":{
"type":"string",
"enum":[
"UNAVAILABLE",
"AVAILABLE",
"EXECUTE_IN_PROGRESS",
"EXECUTE_COMPLETE",
"EXECUTE_FAILED",
"OBSOLETE"
]
},
"Export":{
"type":"structure",
"members":{
"ExportingStackId":{
"shape":"StackId",
"documentation":"<p>The stack that contains the exported output name and value.</p>"
},
"Name":{
"shape":"ExportName",
"documentation":"<p>The name of exported output value. Use this name and the <code>Fn::ImportValue</code> function to import the associated value into other stacks. The name is defined in the <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>"
},
"Value":{
"shape":"ExportValue",
"documentation":"<p>The value of the exported output, such as a resource physical ID. This value is defined in the <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>"
}
},
"documentation":"<p>The <code>Export</code> structure describes the exported output values for a stack.</p>"
},
"ExportName":{"type":"string"},
"ExportValue":{"type":"string"},
"Exports":{
"type":"list",
"member":{"shape":"Export"}
},
"GetStackPolicyInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or unique stack ID that is associated with the stack whose policy you want to get.</p>"
}
},
"documentation":"<p>The input for the <a>GetStackPolicy</a> action.</p>"
},
"GetStackPolicyOutput":{
"type":"structure",
"members":{
"StackPolicyBody":{
"shape":"StackPolicyBody",
"documentation":"<p>Structure containing the stack policy body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.)</p>"
}
},
"documentation":"<p>The output for the <a>GetStackPolicy</a> action.</p>"
},
"GetTemplateInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>Returns the template for a change set using the Amazon Resource Name (ARN) or name of the change set. If you specify a name, you must also specify the <code>StackName</code>.</p>"
},
"TemplateStage":{
"shape":"TemplateStage",
"documentation":"<p>The stage of the template that is returned. Valid values are <code>Original</code> and <code>Processed</code>:</p> <ul> <li> <p> <code>Original</code> - Use to return the specified pre-transform template.</p> </li> <li> <p> <code>Processed</code> - Use to return the template after all transforms have been processed.</p> </li> </ul>"
}
},
"documentation":"<p>The input for a <a>GetTemplate</a> action.</p>"
},
"GetTemplateOutput":{
"type":"structure",
"members":{
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>AWS CloudFormation returns the same template that was used when the stack was created.</p>"
},
"StagesAvailable":{
"shape":"StageList",
"documentation":"<p>The available template type. For stacks, both the <code>Original</code> and <code>Processed</code> template types are always available. For change sets, the <code>Original</code> template is always available. After the transforms are processed, the <code>Processed</code> template becomes available.</p>"
}
},
"documentation":"<p>The output for <a>GetTemplate</a> action.</p>"
},
"GetTemplateSummaryInput":{
"type":"structure",
"members":{
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
}
},
"documentation":"<p>The input for the <a>GetTemplateSummary</a> action.</p>"
},
"GetTemplateSummaryOutput":{
"type":"structure",
"members":{
"Parameters":{
"shape":"ParameterDeclarations",
"documentation":"<p>A list of parameter declarations that describe various properties for each parameter.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The value that is defined in the <code>Description</code> property of the template.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"CapabilitiesReason":{
"shape":"CapabilitiesReason",
"documentation":"<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>"
},
"Version":{
"shape":"Version",
"documentation":"<p>The AWS template format version, which identifies the capabilities of the template.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The value that is defined for the <code>Metadata</code> property of the template.</p>"
},
"DeclaredTransforms":{
"shape":"TransformsList",
"documentation":"<p>A list of the transforms that have been declared in the template.</p>"
}
},
"documentation":"<p>The output for the <a>GetTemplateSummary</a> action.</p>"
},
"InsufficientCapabilitiesException":{
"type":"structure",
"members":{
},
"documentation":"<p>The template contains resources with capabilities that were not specified in the Capabilities parameter.</p>",
"error":{
"code":"InsufficientCapabilitiesException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidChangeSetStatusException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified change set cannot be used to update the stack. For example, the change set status might be <code>CREATE_IN_PROGRESS</code> or the stack status might be <code>UPDATE_IN_PROGRESS</code>.</p>",
"error":{
"code":"InvalidChangeSetStatus",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"LastUpdatedTime":{"type":"timestamp"},
"LimitExceededException":{
"type":"structure",
"members":{
},
"documentation":"<p>Quota for the resource has already been reached.</p>",
"error":{
"code":"LimitExceededException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"LimitName":{"type":"string"},
"LimitValue":{"type":"integer"},
"ListChangeSetsInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string (provided by the <a>ListChangeSets</a> response output) that identifies the next page of change sets that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>ListChangeSets</a> action.</p>"
},
"ListChangeSetsOutput":{
"type":"structure",
"members":{
"Summaries":{
"shape":"ChangeSetSummaries",
"documentation":"<p>A list of <code>ChangeSetSummary</code> structures that provides the ID and status of each change set for the specified stack.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.</p>"
}
},
"documentation":"<p>The output for the <a>ListChangeSets</a> action.</p>"
},
"ListExportsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string (provided by the <a>ListExports</a> response output) that identifies the next page of exported output values that you asked to retrieve.</p>"
}
}
},
"ListExportsOutput":{
"type":"structure",
"members":{
"Exports":{
"shape":"Exports",
"documentation":"<p>The output for the <a>ListExports</a> action.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.</p>"
}
}
},
"ListStackResourcesInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of stack resources that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>ListStackResource</a> action.</p>"
},
"ListStackResourcesOutput":{
"type":"structure",
"members":{
"StackResourceSummaries":{
"shape":"StackResourceSummaries",
"documentation":"<p>A list of <code>StackResourceSummary</code> structures.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for a <a>ListStackResources</a> action.</p>"
},
"ListStacksInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of stacks that you want to retrieve.</p>"
},
"StackStatusFilter":{
"shape":"StackStatusFilter",
"documentation":"<p>Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the <code>StackStatus</code> parameter of the <a>Stack</a> data type.</p>"
}
},
"documentation":"<p>The input for <a>ListStacks</a> action.</p>"
},
"ListStacksOutput":{
"type":"structure",
"members":{
"StackSummaries":{
"shape":"StackSummaries",
"documentation":"<p>A list of <code>StackSummary</code> structures containing information about the specified stacks.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for <a>ListStacks</a> action.</p>"
},
"LogicalResourceId":{"type":"string"},
"Metadata":{"type":"string"},
"NextToken":{
"type":"string",
"max":1024,
"min":1
},
"NoEcho":{"type":"boolean"},
"NotificationARN":{"type":"string"},
"NotificationARNs":{
"type":"list",
"member":{"shape":"NotificationARN"},
"max":5
},
"OnFailure":{
"type":"string",
"enum":[
"DO_NOTHING",
"ROLLBACK",
"DELETE"
]
},
"Output":{
"type":"structure",
"members":{
"OutputKey":{
"shape":"OutputKey",
"documentation":"<p>The key associated with the output.</p>"
},
"OutputValue":{
"shape":"OutputValue",
"documentation":"<p>The value associated with the output.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>User defined description associated with the output.</p>"
}
},
"documentation":"<p>The Output data type.</p>"
},
"OutputKey":{"type":"string"},
"OutputValue":{"type":"string"},
"Outputs":{
"type":"list",
"member":{"shape":"Output"}
},
"Parameter":{
"type":"structure",
"members":{
"ParameterKey":{
"shape":"ParameterKey",
"documentation":"<p>The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.</p>"
},
"ParameterValue":{
"shape":"ParameterValue",
"documentation":"<p>The value associated with the parameter.</p>"
},
"UsePreviousValue":{
"shape":"UsePreviousValue",
"documentation":"<p>During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify <code>true</code>, do not specify a parameter value.</p>"
}
},
"documentation":"<p>The Parameter data type.</p>"
},
"ParameterConstraints":{
"type":"structure",
"members":{
"AllowedValues":{
"shape":"AllowedValues",
"documentation":"<p>A list of values that are permitted for a parameter.</p>"
}
},
"documentation":"<p>A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the <code>AllowedValues</code> property.</p>"
},
"ParameterDeclaration":{
"type":"structure",
"members":{
"ParameterKey":{
"shape":"ParameterKey",
"documentation":"<p>The name that is associated with the parameter.</p>"
},
"DefaultValue":{
"shape":"ParameterValue",
"documentation":"<p>The default value of the parameter.</p>"
},
"ParameterType":{
"shape":"ParameterType",
"documentation":"<p>The type of parameter.</p>"
},
"NoEcho":{
"shape":"NoEcho",
"documentation":"<p>Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description that is associate with the parameter.</p>"
},
"ParameterConstraints":{
"shape":"ParameterConstraints",
"documentation":"<p>The criteria that AWS CloudFormation uses to validate parameter values.</p>"
}
},
"documentation":"<p>The ParameterDeclaration data type.</p>"
},
"ParameterDeclarations":{
"type":"list",
"member":{"shape":"ParameterDeclaration"}
},
"ParameterKey":{"type":"string"},
"ParameterType":{"type":"string"},
"ParameterValue":{"type":"string"},
"Parameters":{
"type":"list",
"member":{"shape":"Parameter"}
},
"PhysicalResourceId":{"type":"string"},
"PropertyName":{"type":"string"},
"Replacement":{
"type":"string",
"enum":[
"True",
"False",
"Conditional"
]
},
"RequiresRecreation":{
"type":"string",
"enum":[
"Never",
"Conditionally",
"Always"
]
},
"ResourceAttribute":{
"type":"string",
"enum":[
"Properties",
"Metadata",
"CreationPolicy",
"UpdatePolicy",
"DeletionPolicy",
"Tags"
]
},
"ResourceChange":{
"type":"structure",
"members":{
"Action":{
"shape":"ChangeAction",
"documentation":"<p>The action that AWS CloudFormation takes on the resource, such as <code>Add</code> (adds a new resource), <code>Modify</code> (changes a resource), or <code>Remove</code> (deletes a resource).</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The resource's logical ID, which is defined in the stack's template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>"
},
"Replacement":{
"shape":"Replacement",
"documentation":"<p>For the <code>Modify</code> action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the <code>RequiresRecreation</code> property in the <code>ResourceTargetDefinition</code> structure. For example, if the <code>RequiresRecreation</code> field is <code>Always</code> and the <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is <code>True</code>. If the <code>RequiresRecreation</code> field is <code>Always</code> and the <code>Evaluation</code> field is <code>Dynamic</code>, <code>Replacement</code> is <code>Conditionally</code>.</p> <p>If you have multiple changes with different <code>RequiresRecreation</code> values, the <code>Replacement</code> value depends on the change with the most impact. A <code>RequiresRecreation</code> value of <code>Always</code> has the most impact, followed by <code>Conditionally</code>, and then <code>Never</code>.</p>"
},
"Scope":{
"shape":"Scope",
"documentation":"<p>For the <code>Modify</code> action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's <code>Metadata</code>, <code>Properties</code>, or <code>Tags</code>.</p>"
},
"Details":{
"shape":"ResourceChangeDetails",
"documentation":"<p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code> structures that describes the changes that AWS CloudFormation will make to the resource. </p>"
}
},
"documentation":"<p>The <code>ResourceChange</code> structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.</p>"
},
"ResourceChangeDetail":{
"type":"structure",
"members":{
"Target":{
"shape":"ResourceTargetDefinition",
"documentation":"<p>A <code>ResourceTargetDefinition</code> structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.</p>"
},
"Evaluation":{
"shape":"EvaluationType",
"documentation":"<p>Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.</p> <p>For <code>Static</code> evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the <code>InstanceType</code> property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a <code>Static</code> evaluation.</p> <p>For <code>Dynamic</code> evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a <code>Ref</code> or <code>Fn::GetAtt</code> intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.</p>"
},
"ChangeSource":{
"shape":"ChangeSource",
"documentation":"<p>The group to which the <code>CausingEntity</code> value belongs. There are five entity groups:</p> <ul> <li> <p> <code>ResourceReference</code> entities are <code>Ref</code> intrinsic functions that refer to resources in the template, such as <code>{ \"Ref\" : \"MyEC2InstanceResource\" }</code>.</p> </li> <li> <p> <code>ParameterReference</code> entities are <code>Ref</code> intrinsic functions that get template parameter values, such as <code>{ \"Ref\" : \"MyPasswordParameter\" }</code>.</p> </li> <li> <p> <code>ResourceAttribute</code> entities are <code>Fn::GetAtt</code> intrinsic functions that get resource attribute values, such as <code>{ \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }</code>.</p> </li> <li> <p> <code>DirectModification</code> entities are changes that are made directly to the template.</p> </li> <li> <p> <code>Automatic</code> entities are <code>AWS::CloudFormation::Stack</code> resource types, which are also known as nested stacks. If you made no changes to the <code>AWS::CloudFormation::Stack</code> resource, AWS CloudFormation sets the <code>ChangeSource</code> to <code>Automatic</code> because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.</p> </li> </ul>"
},
"CausingEntity":{
"shape":"CausingEntity",
"documentation":"<p>The identity of the entity that triggered this change. This entity is a member of the group that is specified by the <code>ChangeSource</code> field. For example, if you modified the value of the <code>KeyPairName</code> parameter, the <code>CausingEntity</code> is the name of the parameter (<code>KeyPairName</code>).</p> <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value is given for <code>CausingEntity</code>.</p>"
}
},
"documentation":"<p>For a resource with <code>Modify</code> as the action, the <code>ResourceChange</code> structure describes the changes AWS CloudFormation will make to that resource.</p>"
},
"ResourceChangeDetails":{
"type":"list",
"member":{"shape":"ResourceChangeDetail"}
},
"ResourceProperties":{"type":"string"},
"ResourceSignalStatus":{
"type":"string",
"enum":[
"SUCCESS",
"FAILURE"
]
},
"ResourceSignalUniqueId":{
"type":"string",
"max":64,
"min":1
},
"ResourceStatus":{
"type":"string",
"enum":[
"CREATE_IN_PROGRESS",
"CREATE_FAILED",
"CREATE_COMPLETE",
"DELETE_IN_PROGRESS",
"DELETE_FAILED",
"DELETE_COMPLETE",
"DELETE_SKIPPED",
"UPDATE_IN_PROGRESS",
"UPDATE_FAILED",
"UPDATE_COMPLETE"
]
},
"ResourceStatusReason":{"type":"string"},
"ResourceTargetDefinition":{
"type":"structure",
"members":{
"Attribute":{
"shape":"ResourceAttribute",
"documentation":"<p>Indicates which resource attribute is triggering this update, such as a change in the resource attribute's <code>Metadata</code>, <code>Properties</code>, or <code>Tags</code>.</p>"
},
"Name":{
"shape":"PropertyName",
"documentation":"<p>If the <code>Attribute</code> value is <code>Properties</code>, the name of the property. For all other attributes, the value is null.</p>"
},
"RequiresRecreation":{
"shape":"RequiresRecreation",
"documentation":"<p>If the <code>Attribute</code> value is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update behavior for that <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">property</a> in the AWS CloudFormation User Guide.</p>"
}
},
"documentation":"<p>The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.</p>"
},
"ResourceToSkip":{
"type":"string",
"pattern":"[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+"
},
"ResourceType":{
"type":"string",
"max":256,
"min":1
},
"ResourceTypes":{
"type":"list",
"member":{"shape":"ResourceType"}
},
"ResourcesToSkip":{
"type":"list",
"member":{"shape":"ResourceToSkip"}
},
"RetainResources":{
"type":"list",
"member":{"shape":"LogicalResourceId"}
},
"RoleARN":{
"type":"string",
"max":2048,
"min":20
},
"Scope":{
"type":"list",
"member":{"shape":"ResourceAttribute"}
},
"SetStackPolicyInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or unique stack ID that you want to associate a policy with.</p>"
},
"StackPolicyBody":{
"shape":"StackPolicyBody",
"documentation":"<p>Structure containing the stack policy body. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
}
},
"documentation":"<p>The input for the <a>SetStackPolicy</a> action.</p>"
},
"SignalResourceInput":{
"type":"structure",
"required":[
"StackName",
"LogicalResourceId",
"UniqueId",
"Status"
],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The stack name or unique stack ID that includes the resource that you want to signal.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.</p>"
},
"UniqueId":{
"shape":"ResourceSignalUniqueId",
"documentation":"<p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.</p>"
},
"Status":{
"shape":"ResourceSignalStatus",
"documentation":"<p>The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.</p>"
}
},
"documentation":"<p>The input for the <a>SignalResource</a> action.</p>"
},
"Stack":{
"type":"structure",
"required":[
"StackName",
"CreationTime",
"StackStatus"
],
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name associated with the stack.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The unique ID of the change set.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A user-defined description associated with the stack.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The time at which the stack was created.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
"documentation":"<p>The time the stack was last updated. This field will only be returned if the stack has been updated at least once.</p>"
},
"StackStatus":{
"shape":"StackStatus",
"documentation":"<p>Current status of the stack.</p>"
},
"StackStatusReason":{
"shape":"StackStatusReason",
"documentation":"<p>Success/failure message associated with the stack status.</p>"
},
"DisableRollback":{
"shape":"DisableRollback",
"documentation":"<p>Boolean to enable or disable rollback on stack creation failures:</p> <ul> <li> <p> <code>true</code>: disable rollback</p> </li> <li> <p> <code>false</code>: enable rollback</p> </li> </ul>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>SNS topic ARNs to which stack related events are published.</p>"
},
"TimeoutInMinutes":{
"shape":"TimeoutMinutes",
"documentation":"<p>The amount of time within which stack creation should complete.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>The capabilities allowed in the stack.</p>"
},
"Outputs":{
"shape":"Outputs",
"documentation":"<p>A list of output structures.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of <code>Tag</code>s that specify information about the stack.</p>"
}
},
"documentation":"<p>The Stack data type.</p>"
},
"StackEvent":{
"type":"structure",
"required":[
"StackId",
"EventId",
"StackName",
"Timestamp"
],
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>The unique ID name of the instance of the stack.</p>"
},
"EventId":{
"shape":"EventId",
"documentation":"<p>The unique ID of this event.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name associated with a stack.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource specified in the template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier associated with the physical instance of the resource.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>Time the status was updated.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Current status of the resource.</p>"
},
"ResourceStatusReason":{
"shape":"ResourceStatusReason",
"documentation":"<p>Success/failure message associated with the resource.</p>"
},
"ResourceProperties":{
"shape":"ResourceProperties",
"documentation":"<p>BLOB of the properties used to create the resource.</p>"
}
},
"documentation":"<p>The StackEvent data type.</p>"
},
"StackEvents":{
"type":"list",
"member":{"shape":"StackEvent"}
},
"StackId":{"type":"string"},
"StackName":{"type":"string"},
"StackNameOrId":{
"type":"string",
"min":1,
"pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)"
},
"StackPolicyBody":{
"type":"string",
"max":16384,
"min":1
},
"StackPolicyDuringUpdateBody":{
"type":"string",
"max":16384,
"min":1
},
"StackPolicyDuringUpdateURL":{
"type":"string",
"max":1350,
"min":1
},
"StackPolicyURL":{
"type":"string",
"max":1350,
"min":1
},
"StackResource":{
"type":"structure",
"required":[
"LogicalResourceId",
"ResourceType",
"Timestamp",
"ResourceStatus"
],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name associated with the stack.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource specified in the template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>Time the status was updated.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Current status of the resource.</p>"
},
"ResourceStatusReason":{
"shape":"ResourceStatusReason",
"documentation":"<p>Success/failure message associated with the resource.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>User defined description associated with the resource.</p>"
}
},
"documentation":"<p>The StackResource data type.</p>"
},
"StackResourceDetail":{
"type":"structure",
"required":[
"LogicalResourceId",
"ResourceType",
"LastUpdatedTimestamp",
"ResourceStatus"
],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name associated with the stack.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource specified in the template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Type of resource. ((For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
},
"LastUpdatedTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Time the status was updated.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Current status of the resource.</p>"
},
"ResourceStatusReason":{
"shape":"ResourceStatusReason",
"documentation":"<p>Success/failure message associated with the resource.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>User defined description associated with the resource.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html\">Metadata Attribute</a> in the AWS CloudFormation User Guide.</p>"
}
},
"documentation":"<p>Contains detailed information about the specified stack resource.</p>"
},
"StackResourceSummaries":{
"type":"list",
"member":{"shape":"StackResourceSummary"}
},
"StackResourceSummary":{
"type":"structure",
"required":[
"LogicalResourceId",
"ResourceType",
"LastUpdatedTimestamp",
"ResourceStatus"
],
"members":{
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource specified in the template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier that corresponds to a physical instance ID of the resource.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
},
"LastUpdatedTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Time the status was updated.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Current status of the resource.</p>"
},
"ResourceStatusReason":{
"shape":"ResourceStatusReason",
"documentation":"<p>Success/failure message associated with the resource.</p>"
}
},
"documentation":"<p>Contains high-level information about the specified stack resource.</p>"
},
"StackResources":{
"type":"list",
"member":{"shape":"StackResource"}
},
"StackStatus":{
"type":"string",
"enum":[
"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_ROLLBACK_IN_PROGRESS",
"UPDATE_ROLLBACK_FAILED",
"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
"UPDATE_ROLLBACK_COMPLETE",
"REVIEW_IN_PROGRESS"
]
},
"StackStatusFilter":{
"type":"list",
"member":{"shape":"StackStatus"}
},
"StackStatusReason":{"type":"string"},
"StackSummaries":{
"type":"list",
"member":{"shape":"StackSummary"}
},
"StackSummary":{
"type":"structure",
"required":[
"StackName",
"CreationTime",
"StackStatus"
],
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique stack identifier.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name associated with the stack.</p>"
},
"TemplateDescription":{
"shape":"TemplateDescription",
"documentation":"<p>The template description of the template used to create the stack.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The time the stack was created.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
"documentation":"<p>The time the stack was last updated. This field will only be returned if the stack has been updated at least once.</p>"
},
"DeletionTime":{
"shape":"DeletionTime",
"documentation":"<p>The time the stack was deleted.</p>"
},
"StackStatus":{
"shape":"StackStatus",
"documentation":"<p>The current status of the stack.</p>"
},
"StackStatusReason":{
"shape":"StackStatusReason",
"documentation":"<p>Success/Failure message associated with the stack status.</p>"
}
},
"documentation":"<p>The StackSummary Data Type</p>"
},
"Stacks":{
"type":"list",
"member":{"shape":"Stack"}
},
"StageList":{
"type":"list",
"member":{"shape":"TemplateStage"}
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p> <i>Required</i>. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: <code>aws:</code>.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p> <i>Required</i>. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.</p>"
}
},
"documentation":"<p>The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.</p>"
},
"TagKey":{"type":"string"},
"TagValue":{"type":"string"},
"Tags":{
"type":"list",
"member":{"shape":"Tag"}
},
"TemplateBody":{
"type":"string",
"min":1
},
"TemplateDescription":{"type":"string"},
"TemplateParameter":{
"type":"structure",
"members":{
"ParameterKey":{
"shape":"ParameterKey",
"documentation":"<p>The name associated with the parameter.</p>"
},
"DefaultValue":{
"shape":"ParameterValue",
"documentation":"<p>The default value associated with the parameter.</p>"
},
"NoEcho":{
"shape":"NoEcho",
"documentation":"<p>Flag indicating whether the parameter should be displayed as plain text in logs and UIs.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>User defined description associated with the parameter.</p>"
}
},
"documentation":"<p>The TemplateParameter data type.</p>"
},
"TemplateParameters":{
"type":"list",
"member":{"shape":"TemplateParameter"}
},
"TemplateStage":{
"type":"string",
"enum":[
"Original",
"Processed"
]
},
"TemplateURL":{
"type":"string",
"max":1024,
"min":1
},
"TimeoutMinutes":{
"type":"integer",
"min":1
},
"Timestamp":{"type":"timestamp"},
"TransformName":{"type":"string"},
"TransformsList":{
"type":"list",
"member":{"shape":"TransformName"}
},
"UpdateStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or unique stack ID of the stack to update.</p>"
},
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
"documentation":"<p>Reuse the existing template that is associated with the stack that you are updating.</p>"
},
"StackPolicyDuringUpdateBody":{
"shape":"StackPolicyDuringUpdateBody",
"documentation":"<p>Structure containing the temporary overriding stack policy body. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</p>"
},
"StackPolicyDuringUpdateURL":{
"shape":"StackPolicyDuringUpdateURL",
"documentation":"<p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"StackPolicyBody":{
"shape":"StackPolicyBody",
"documentation":"<p>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>"
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.</p> <p>If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.</p>"
}
},
"documentation":"<p>The input for an <a>UpdateStack</a> action.</p>"
},
"UpdateStackOutput":{
"type":"structure",
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
}
},
"documentation":"<p>The output for an <a>UpdateStack</a> action.</p>"
},
"Url":{"type":"string"},
"UsePreviousTemplate":{"type":"boolean"},
"UsePreviousValue":{"type":"boolean"},
"ValidateTemplateInput":{
"type":"structure",
"members":{
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
}
},
"documentation":"<p>The input for <a>ValidateTemplate</a> action.</p>"
},
"ValidateTemplateOutput":{
"type":"structure",
"members":{
"Parameters":{
"shape":"TemplateParameters",
"documentation":"<p>A list of <code>TemplateParameter</code> structures.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description found within the template.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"CapabilitiesReason":{
"shape":"CapabilitiesReason",
"documentation":"<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>"
},
"DeclaredTransforms":{
"shape":"TransformsList",
"documentation":"<p>A list of the transforms that have been declared in the template.</p>"
}
},
"documentation":"<p>The output for <a>ValidateTemplate</a> action.</p>"
},
"Version":{"type":"string"}
},
"documentation":"<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://docs.aws.amazon.com/\">http://docs.aws.amazon.com/</a>.</p>"
}
Reference in a new issue View git blame Copy permalink