CloudFormationClient Class

Member Function Documentation

CloudFormationClient::CloudFormationClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CloudFormationClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CloudFormationClient::CloudFormationClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CloudFormationClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelUpdateStackResponse *CloudFormationClient::cancelUpdateStack(const CancelUpdateStackRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an CancelUpdateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note>

You can cancel only stacks that are in the UPDATE_IN_PROGRESS

[slot] ContinueUpdateRollbackResponse *CloudFormationClient::continueUpdateRollback(const ContinueUpdateRollbackRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ContinueUpdateRollbackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

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

[slot] CreateChangeSetResponse *CloudFormationClient::createChangeSet(const CreateChangeSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an CreateChangeSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a>

action>

When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. AWS CloudFormation doesn't make changes until you execute the change

[slot] CreateStackResponse *CloudFormationClient::createStack(const CreateStackRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an CreateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

[slot] CreateStackInstancesResponse *CloudFormationClient::createStackInstances(const CreateStackInstancesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an CreateStackInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. <code>Accounts</code> and <code>Regions</code> are required parameters—you must specify at least one account and one region.

[slot] CreateStackSetResponse *CloudFormationClient::createStackSet(const CreateStackSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an CreateStackSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a stack

[slot] DeleteChangeSetResponse *CloudFormationClient::deleteChangeSet(const DeleteChangeSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DeleteChangeSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteStackResponse *CloudFormationClient::deleteStack(const DeleteStackRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DeleteStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteStackInstancesResponse *CloudFormationClient::deleteStackInstances(const DeleteStackInstancesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DeleteStackInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes stack instances for the specified accounts, in the specified regions.

[slot] DeleteStackSetResponse *CloudFormationClient::deleteStackSet(const DeleteStackSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DeleteStackSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DeleteStackInstances</a>.

[slot] DescribeAccountLimitsResponse *CloudFormationClient::describeAccountLimits(const DescribeAccountLimitsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeAccountLimitsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your

[slot] DescribeChangeSetResponse *CloudFormationClient::describeChangeSet(const DescribeChangeSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeChangeSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeStackEventsResponse *CloudFormationClient::describeStackEvents(const DescribeStackEventsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note>

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack

[slot] DescribeStackInstanceResponse *CloudFormationClient::describeStackInstance(const DescribeStackInstanceRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeStackResourceResponse *CloudFormationClient::describeStackResource(const DescribeStackResourceRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeStackResourcesResponse *CloudFormationClient::describeStackResources(const DescribeStackResourcesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note>

Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code>

instead> </note>

For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been

deleted>

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>> <note>

A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same

[slot] DescribeStackSetResponse *CloudFormationClient::describeStackSet(const DescribeStackSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the description of the specified stack set.

[slot] DescribeStackSetOperationResponse *CloudFormationClient::describeStackSetOperation(const DescribeStackSetOperationRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStackSetOperationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the description of the specified stack set operation.

[slot] DescribeStacksResponse *CloudFormationClient::describeStacks(const DescribeStacksRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an DescribeStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks

created> <note>

If the stack does not exist, an <code>AmazonCloudFormationException</code> is

[slot] EstimateTemplateCostResponse *CloudFormationClient::estimateTemplateCost(const EstimateTemplateCostRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an EstimateTemplateCostResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ExecuteChangeSetResponse *CloudFormationClient::executeChangeSet(const ExecuteChangeSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ExecuteChangeSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

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

[slot] GetStackPolicyResponse *CloudFormationClient::getStackPolicy(const GetStackPolicyRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an GetStackPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is

[slot] GetTemplateResponse *CloudFormationClient::getTemplate(const GetTemplateRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an GetTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note>

If the template does not exist, a <code>ValidationError</code> is returned.

[slot] GetTemplateSummaryResponse *CloudFormationClient::getTemplateSummary(const GetTemplateSummaryRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an GetTemplateSummaryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 or stack

set>

You can use the <code>GetTemplateSummary</code> 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, <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

[slot] ListChangeSetsResponse *CloudFormationClient::listChangeSets(const ListChangeSetsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListChangeSetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

[slot] ListExportsResponse *CloudFormationClient::listExports(const ListExportsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListExportsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html"> AWS CloudFormation Export Stack Output

[slot] ListImportsResponse *CloudFormationClient::listImports(const ListImportsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListImportsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>ListExports</a>.

</p

For more information about importing an exported output value, see the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html"> <code>Fn::ImportValue</code> </a> function.

[slot] ListStackInstancesResponse *CloudFormationClient::listStackInstances(const ListStackInstancesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStackInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListStackResourcesResponse *CloudFormationClient::listStackResources(const ListStackResourcesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStackResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListStackSetOperationResultsResponse *CloudFormationClient::listStackSetOperationResults(const ListStackSetOperationResultsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStackSetOperationResultsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summary information about the results of a stack set operation.

[slot] ListStackSetOperationsResponse *CloudFormationClient::listStackSetOperations(const ListStackSetOperationsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStackSetOperationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summary information about operations performed on a stack set.

[slot] ListStackSetsResponse *CloudFormationClient::listStackSets(const ListStackSetsRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStackSetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summary information about stack sets that are associated with the

[slot] ListStacksResponse *CloudFormationClient::listStacks(const ListStacksRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ListStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] SetStackPolicyResponse *CloudFormationClient::setStackPolicy(const SetStackPolicyRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an SetStackPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets a stack policy for a specified

[slot] SignalResourceResponse *CloudFormationClient::signalResource(const SignalResourceRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an SignalResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] StopStackSetOperationResponse *CloudFormationClient::stopStackSetOperation(const StopStackSetOperationRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an StopStackSetOperationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops an in-progress operation on a stack set and its associated stack instances.

[slot] UpdateStackResponse *CloudFormationClient::updateStack(const UpdateStackRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an UpdateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a>

action>

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

[slot] UpdateStackInstancesResponse *CloudFormationClient::updateStackInstances(const UpdateStackInstancesRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an UpdateStackInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.

</p

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 <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> 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 <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> 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

[slot] UpdateStackSetResponse *CloudFormationClient::updateStackSet(const UpdateStackSetRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an UpdateStackSetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the stack set and <i>all</i> associated stack

instances>

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 <a>CreateStackInstances</a> calls on the specified stack set use the updated stack

[slot] UpdateTerminationProtectionResponse *CloudFormationClient::updateTerminationProtection(const UpdateTerminationProtectionRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an UpdateTerminationProtectionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User

Guide</i>>

For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested

[slot] ValidateTemplateResponse *CloudFormationClient::validateTemplate(const ValidateTemplateRequest &request)

Sends request to the CloudFormationClient service, and returns a pointer to an ValidateTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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