cancel_update_stack
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.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
Parameters
$body
The input for the CancelUpdateStack action.
Type: object
{
"ClientRequestToken" : "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.",
"StackName" : "The name or the unique stack ID that is associated with the stack."
}
continue_update_rollback
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED 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.
Parameters
$body
The input for the ContinueUpdateRollback action.
Type: object
{
"ClientRequestToken" : "A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.",
"ResourcesToSkip" : [ "string" ],
"StackName" : "The name or the unique ID of the stack that you want to continue rolling back. \nDon't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).",
"RoleARN" : "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. \nIf 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."
}
create_change_set
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
Parameters
$body
The input for the CreateChangeSet action.
Type: object
{
"UsePreviousTemplate" : "Whether to reuse the template that is associated with the stack to create the change set.",
"ResourceTypes" : [ "string" ],
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"Description" : "A description to help you identify this change set.",
"NotificationARNs" : [ "string" ],
"TemplateBody" : "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. \nConditional: You must specify only TemplateBody or TemplateURL.",
"ChangeSetName" : "The name of the change set. The name must be unique among all change sets that are associated with the specified stack. \nA change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.",
"RoleARN" : "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 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. \nIf 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.",
"TemplateURL" : "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. \nConditional: You must specify only TemplateBody or TemplateURL.",
"RollbackConfiguration" : {
"RollbackTriggers" : [ {
"RollbackTrigger" : {
"Type" : "The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.",
"Arn" : "The Amazon Resource Name (ARN) of the rollback trigger. \nIf a specified trigger is missing, the entire stack operation fails and is rolled back. "
}
} ],
"MonitoringTimeInMinutes" : "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. \nThe default is 0 minutes. \nIf you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. \nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes."
},
"Capabilities" : [ "string. Possible values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND" ],
"ChangeSetType" : "The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. \nIf you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set. \nBy default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.",
"ClientToken" : "A unique identifier for this CreateChangeSet 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 CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.",
"StackName" : "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.",
"Tags" : [ {
"Tag" : {
"Value" : " Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.",
"Key" : " Required. 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: aws:."
}
} ]
}
create_stack
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 DescribeStacks API.
Parameters
$body
The input for CreateStack action.
Type: object
{
"ResourceTypes" : [ "string" ],
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"NotificationARNs" : [ "string" ],
"TemplateBody" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.",
"StackPolicyBody" : "Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.",
"StackPolicyURL" : "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 StackPolicyBody or the StackPolicyURL parameter, but not both.",
"RoleARN" : "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. \nIf 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.",
"TemplateURL" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.",
"RollbackConfiguration" : {
"RollbackTriggers" : [ {
"RollbackTrigger" : {
"Type" : "The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.",
"Arn" : "The Amazon Resource Name (ARN) of the rollback trigger. \nIf a specified trigger is missing, the entire stack operation fails and is rolled back. "
}
} ],
"MonitoringTimeInMinutes" : "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. \nThe default is 0 minutes. \nIf you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. \nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes."
},
"ClientRequestToken" : "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them. \nAll events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. \nIn the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ",
"Capabilities" : [ "string. Possible values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND" ],
"EnableTerminationProtection" : "Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default. \n For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.",
"StackName" : "The name that is associated with the stack. The name must be unique in the region in which you are creating the stack. \nA 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.",
"DisableRollback" : "Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both. \nDefault: false ",
"Tags" : [ {
"Tag" : {
"Value" : " Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.",
"Key" : " Required. 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: aws:."
}
} ],
"TimeoutInMinutes" : "The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.",
"OnFailure" : "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both. \nDefault: ROLLBACK "
}
create_stack_instances
Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.
Parameters
$body
Type: object
{
"OperationPreferences" : {
"MaxConcurrentPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"MaxConcurrentCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"FailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.",
"FailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).",
"RegionOrder" : [ "string" ]
},
"ParameterOverrides" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"OperationId" : "The unique identifier for this stack set operation. \nThe operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. \nIf you don't specify an operation ID, the SDK generates one automatically. \nRepeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. ",
"Regions" : [ "string" ],
"StackSetName" : "The name or unique ID of the stack set that you want to create stack instances from.",
"Accounts" : [ "string" ]
}
create_stack_set
Creates a stack set.
Parameters
$body
Type: object
{
"TemplateURL" : "The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.",
"ClientRequestToken" : "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. \nIf you don't specify an operation ID, the SDK generates one automatically. ",
"Description" : "A description of the stack set. You can use the description to identify the stack set's purpose or other important information.",
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"Capabilities" : [ "string. Possible values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND" ],
"AdministrationRoleARN" : "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. \nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.",
"ExecutionRoleName" : "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. \nSpecify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. ",
"TemplateBody" : "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.",
"StackSetName" : "The name to associate with the stack set. The name must be unique in the region where you create your stack set. \nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.",
"Tags" : [ {
"Tag" : {
"Value" : " Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.",
"Key" : " Required. 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: aws:."
}
} ]
}
delete_change_set
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.
Parameters
$body
The input for the DeleteChangeSet action.
Type: object
{
"ChangeSetName" : "The name or Amazon Resource Name (ARN) of the change set that you want to delete.",
"StackName" : "If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it."
}
delete_stack
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
Parameters
$body
The input for DeleteStack action.
Type: object
{
"RetainResources" : [ "string" ],
"ClientRequestToken" : "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them. \nAll events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. \nIn the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ",
"StackName" : "The name or the unique stack ID that is associated with the stack.",
"RoleARN" : "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. \nIf 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."
}
delete_stack_instances
Deletes stack instances for the specified accounts, in the specified regions.
Parameters
$body
Type: object
{
"OperationPreferences" : {
"MaxConcurrentPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"MaxConcurrentCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"FailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.",
"FailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).",
"RegionOrder" : [ "string" ]
},
"RetainStacks" : "Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. \nFor more information, see Stack set operation options.",
"OperationId" : "The unique identifier for this stack set operation. \nIf you don't specify an operation ID, the SDK generates one automatically. \nThe operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them. \nRepeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. ",
"Regions" : [ "string" ],
"StackSetName" : "The name or unique ID of the stack set that you want to delete stack instances for.",
"Accounts" : [ "string" ]
}
delete_stack_set
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
Parameters
$body
Type: object
{
"StackSetName" : "The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets."
}
describe_account_limits
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
This operation has no parameters
describe_change_set
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
Parameters
$body
The input for the DescribeChangeSet action.
Type: object
{
"ChangeSetName" : "The name or Amazon Resource Name (ARN) of the change set that you want to describe.",
"StackName" : "If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe."
}
describe_stack_drift_detection_status
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Parameters
$body
Type: object
{
"StackDriftDetectionId" : "The ID of the drift detection results of this operation. \nAWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary. "
}
describe_stack_events
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Parameters
$body
The input for DescribeStackEvents action.
Type: object
{
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value."
}
describe_stack_instance
Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
Parameters
$body
Type: object
{
"StackInstanceAccount" : "The ID of an AWS account that's associated with this stack instance.",
"StackSetName" : "The name or the unique stack ID of the stack set that you want to get stack instance information for.",
"StackInstanceRegion" : "The name of a region that's associated with this stack instance."
}
describe_stack_resource
Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
Parameters
$body
The input for DescribeStackResource action.
Type: object
{
"LogicalResourceId" : "The logical name of the resource as specified in the template. \nDefault: There is no default value.",
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value."
}
describe_stack_resource_drifts
Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
Parameters
$body
Type: object
{
"StackResourceDriftStatusFilters" : [ "string. Possible values: IN_SYNC | MODIFIED | DELETED | NOT_CHECKED" ],
"NextToken" : "A string that identifies the next page of stack resource drift results.",
"MaxResults" : "The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.",
"StackName" : "The name of the stack for which you want drift information."
}
describe_stack_resources
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
Parameters
$body
The input for DescribeStackResources action.
Type: object
{
"LogicalResourceId" : "The logical name of the resource as specified in the template. \nDefault: There is no default value.",
"PhysicalResourceId" : "The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. \nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack. \nRequired: Conditional. If you do not specify PhysicalResourceId, you must specify StackName. \nDefault: There is no default value.",
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value. \nRequired: Conditional. If you do not specify StackName, you must specify PhysicalResourceId."
}
describe_stack_set
Returns the description of the specified stack set.
Parameters
$body
Type: object
{
"StackSetName" : "The name or unique ID of the stack set whose description you want."
}
describe_stack_set_operation
Returns the description of the specified stack set operation.
Parameters
$body
Type: object
{
"OperationId" : "The unique ID of the stack set operation. ",
"StackSetName" : "The name or the unique stack ID of the stack set for the stack operation."
}
describe_stacks
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
Parameters
$body
The input for DescribeStacks action.
Type: object
{
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value."
}
detect_stack_drift
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
Parameters
$body
Type: object
{
"LogicalResourceIds" : [ "string" ],
"StackName" : "The name of the stack for which you want to detect drift. "
}
detect_stack_resource_drift
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Parameters
$body
Type: object
{
"LogicalResourceId" : "The logical name of the resource for which to return drift information.",
"StackName" : "The name of the stack to which the resource belongs."
}
estimate_template_cost
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.
Parameters
$body
The input for an EstimateTemplateCost action.
Type: object
{
"TemplateURL" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.",
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"TemplateBody" : "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 Template Anatomy in the AWS CloudFormation User Guide.) \nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used."
}
execute_change_set
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 DescribeStacks action to view the status of the update. 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. 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.
Parameters
$body
The input for the ExecuteChangeSet action.
Type: object
{
"ClientRequestToken" : "A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.",
"ChangeSetName" : "The name or ARN of the change set that you want use to update the specified stack.",
"StackName" : "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."
}
get_stack_policy
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
Parameters
$body
The input for the GetStackPolicy action.
Type: object
{
"StackName" : "The name or unique stack ID that is associated with the stack whose policy you want to get."
}
get_template
Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
Parameters
$body
The input for a GetTemplate action.
Type: object
{
"ChangeSetName" : "The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.",
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value.",
"TemplateStage" : "For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed. \nIf the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original. "
}
get_template_summary
Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
Parameters
$body
The input for the GetTemplateSummary action.
Type: object
{
"TemplateURL" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.",
"TemplateBody" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.",
"StackSetName" : "The name or unique ID of the stack set from which the stack was created. \nConditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.",
"StackName" : "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. \nConditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL."
}
list_change_sets
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Parameters
$body
The input for the ListChangeSets action.
Type: object
{
"StackName" : "The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets."
}
list_exports
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 Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
This operation has no parameters
list_imports
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
Parameters
$body
Type: object
{
"ExportName" : "The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. "
}
list_stack_instances
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
Parameters
$body
Type: object
{
"StackInstanceAccount" : "The name of the AWS account that you want to list stack instances for.",
"StackSetName" : "The name or unique ID of the stack set that you want to list stack instances for.",
"StackInstanceRegion" : "The name of the region where you want to list stack instances. "
}
list_stack_resources
Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
Parameters
$body
The input for the ListStackResource action.
Type: object
{
"StackName" : "The name or the unique stack ID that is associated with the stack, which are not always interchangeable: \n Running stacks: You can specify either the stack's name or its unique stack ID. \n Deleted stacks: You must specify the unique stack ID. \nDefault: There is no default value."
}
list_stack_set_operation_results
Returns summary information about the results of a stack set operation.
Parameters
$body
Type: object
{
"OperationId" : "The ID of the stack set operation.",
"StackSetName" : "The name or unique ID of the stack set that you want to get operation results for."
}
list_stack_set_operations
Returns summary information about operations performed on a stack set.
Parameters
$body
Type: object
{
"StackSetName" : "The name or unique ID of the stack set that you want to get operation summaries for."
}
list_stack_sets
Returns summary information about stack sets that are associated with the user.
Parameters
$body
Type: object
{
"Status" : "The status of the stack sets that you want to get summary information about."
}
list_stacks
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).
Parameters
$body
The input for ListStacks action.
Type: object
{
"StackStatusFilter" : [ "string. Possible values: 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" ]
}
set_stack_policy
Sets a stack policy for a specified stack.
Parameters
$body
The input for the SetStackPolicy action.
Type: object
{
"StackPolicyBody" : "Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.",
"StackPolicyURL" : "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 StackPolicyBody or the StackPolicyURL parameter, but not both.",
"StackName" : "The name or unique stack ID that you want to associate a policy with."
}
signal_resource
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.
Parameters
$body
The input for the SignalResource action.
Type: object
{
"Status" : "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.",
"UniqueId" : "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.",
"LogicalResourceId" : "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.",
"StackName" : "The stack name or unique stack ID that includes the resource that you want to signal."
}
stop_stack_set_operation
Stops an in-progress operation on a stack set and its associated stack instances.
Parameters
$body
Type: object
{
"OperationId" : "The ID of the stack operation. ",
"StackSetName" : "The name or unique ID of the stack set that you want to stop the operation for."
}
update_stack
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 DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
Parameters
$body
The input for an UpdateStack action.
Type: object
{
"UsePreviousTemplate" : "Reuse the existing template that is associated with the stack that you are updating. \nConditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.",
"ResourceTypes" : [ "string" ],
"StackPolicyDuringUpdateBody" : "Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. \nIf 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.",
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"NotificationARNs" : [ "string" ],
"TemplateBody" : "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 Template Anatomy in the AWS CloudFormation User Guide.) \nConditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.",
"StackPolicyBody" : "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. \nYou 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.",
"StackPolicyURL" : "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 StackPolicyBody or the StackPolicyURL parameter, but not both. \nYou 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.",
"StackPolicyDuringUpdateURL" : "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 StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. \nIf 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.",
"RoleARN" : "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. \nIf 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.",
"TemplateURL" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.",
"RollbackConfiguration" : {
"RollbackTriggers" : [ {
"RollbackTrigger" : {
"Type" : "The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.",
"Arn" : "The Amazon Resource Name (ARN) of the rollback trigger. \nIf a specified trigger is missing, the entire stack operation fails and is rolled back. "
}
} ],
"MonitoringTimeInMinutes" : "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. \nThe default is 0 minutes. \nIf you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. \nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes."
},
"ClientRequestToken" : "A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. \nAll events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. \nIn the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ",
"Capabilities" : [ "string. Possible values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND" ],
"StackName" : "The name or unique stack ID of the stack to update.",
"Tags" : [ {
"Tag" : {
"Value" : " Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.",
"Key" : " Required. 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: aws:."
}
} ]
}
update_stack_instances
Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.
You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
Parameters
$body
Type: object
{
"OperationPreferences" : {
"MaxConcurrentPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"MaxConcurrentCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"FailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.",
"FailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).",
"RegionOrder" : [ "string" ]
},
"ParameterOverrides" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"OperationId" : "The unique identifier for this stack set operation. \nThe operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. \nIf you don't specify an operation ID, the SDK generates one automatically. ",
"Regions" : [ "string" ],
"StackSetName" : "The name or unique ID of the stack set associated with the stack instances.",
"Accounts" : [ "string" ]
}
update_stack_set
Updates the stack set, and associated stack instances in the specified accounts and regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
Parameters
$body
Type: object
{
"UsePreviousTemplate" : "Use the existing template that's associated with the stack set that you're updating. \nConditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true. ",
"Description" : "A brief description of updates that you are making.",
"Parameters" : [ {
"Parameter" : {
"ParameterValue" : "The input value associated with the parameter.",
"UsePreviousValue" : "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.",
"ResolvedValue" : "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.",
"ParameterKey" : "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."
}
} ],
"OperationId" : "The unique ID for this stack set operation. \nThe operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. \nIf you don't specify an operation ID, AWS CloudFormation generates one automatically. \nRepeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. ",
"Regions" : [ "string" ],
"TemplateBody" : "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.",
"StackSetName" : "The name or unique ID of the stack set that you want to update.",
"OperationPreferences" : {
"MaxConcurrentPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"MaxConcurrentCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.",
"FailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.",
"FailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. \nConditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).",
"RegionOrder" : [ "string" ]
},
"TemplateURL" : "The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true. ",
"Capabilities" : [ "string. Possible values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND" ],
"AdministrationRoleARN" : "The Amazon Resource Number (ARN) of the IAM role to use to update this stack set. \nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. \nIf you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.",
"ExecutionRoleName" : "The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. \nSpecify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. \n If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.",
"Tags" : [ {
"Tag" : {
"Value" : " Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.",
"Key" : " Required. 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: aws:."
}
} ],
"Accounts" : [ "string" ]
}
update_termination_protection
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
Parameters
$body
Type: object
{
"EnableTerminationProtection" : "Whether to enable termination protection on the specified stack.",
"StackName" : "The name or unique ID of the stack for which you want to set termination protection."
}
validate_template
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.
Parameters
$body
The input for ValidateTemplate action.
Type: object
{
"TemplateURL" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.",
"TemplateBody" : "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 Template Anatomy in the AWS CloudFormation User Guide. \nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used."
}