AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccountGateResult

Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.

For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns FAILED, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.

For more information, see Configuring a target account gate.

Class AccountLimit

The AccountLimit data type.

Class AlreadyExistsException

CloudFormation exception

Class CancelUpdateStackRequest

Container for the parameters to the CancelUpdateStack operation. 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.

Class CancelUpdateStackResponse

This is the response object from the CancelUpdateStack operation.

Class Change

The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.

Class ChangeSetNotFoundException

CloudFormation exception

Class ChangeSetSummary

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

Class ContinueUpdateRollbackRequest

Container for the parameters to the ContinueUpdateRollback operation. 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.

Class ContinueUpdateRollbackResponse

The output for a ContinueUpdateRollback action.

Class CreateChangeSetRequest

Container for the parameters to the CreateChangeSet operation. 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.

Class CreateChangeSetResponse

The output for the CreateChangeSet action.

Class CreatedButModifiedException

CloudFormation exception

Class CreateStackInstancesRequest

Container for the parameters to the CreateStackInstances operation. 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.

Class CreateStackInstancesResponse

This is the response object from the CreateStackInstances operation.

Class CreateStackRequest

Container for the parameters to the CreateStack operation. 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.

Class CreateStackResponse

The output for a CreateStack action.

Class CreateStackSetRequest

Container for the parameters to the CreateStackSet operation. Creates a stack set.

Class CreateStackSetResponse

This is the response object from the CreateStackSet operation.

Class DeleteChangeSetRequest

Container for the parameters to the DeleteChangeSet operation. 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.

Class DeleteChangeSetResponse

The output for the DeleteChangeSet action.

Class DeleteStackInstancesRequest

Container for the parameters to the DeleteStackInstances operation. Deletes stack instances for the specified accounts, in the specified regions.

Class DeleteStackInstancesResponse

This is the response object from the DeleteStackInstances operation.

Class DeleteStackRequest

Container for the parameters to the DeleteStack operation. 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.

Class DeleteStackResponse

This is the response object from the DeleteStack operation.

Class DeleteStackSetRequest

Container for the parameters to the DeleteStackSet operation. 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.

Class DeleteStackSetResponse

This is the response object from the DeleteStackSet operation.

Class DescribeAccountLimitsRequest

Container for the parameters to the DescribeAccountLimits operation. Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.

Class DescribeAccountLimitsResponse

The output for the DescribeAccountLimits action.

Class DescribeChangeSetRequest

Container for the parameters to the DescribeChangeSet operation. 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.

Class DescribeChangeSetResponse

The output for the DescribeChangeSet action.

Class DescribeStackEventsRequest

Container for the parameters to the DescribeStackEvents operation. 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).

Class DescribeStackEventsResponse

The output for a DescribeStackEvents action.

Class DescribeStackInstanceRequest

Container for the parameters to the DescribeStackInstance operation. 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.

Class DescribeStackInstanceResponse

This is the response object from the DescribeStackInstance operation.

Class DescribeStackResourceRequest

Container for the parameters to the DescribeStackResource operation. 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.

Class DescribeStackResourceResponse

The output for a DescribeStackResource action.

Class DescribeStackResourcesRequest

Container for the parameters to the DescribeStackResources operation. 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.

Class DescribeStackResourcesResponse

The output for a DescribeStackResources action.

Class DescribeStackSetOperationRequest

Container for the parameters to the DescribeStackSetOperation operation. Returns the description of the specified stack set operation.

Class DescribeStackSetOperationResponse

This is the response object from the DescribeStackSetOperation operation.

Class DescribeStackSetRequest

Container for the parameters to the DescribeStackSet operation. Returns the description of the specified stack set.

Class DescribeStackSetResponse

This is the response object from the DescribeStackSet operation.

Class DescribeStacksRequest

Container for the parameters to the DescribeStacks operation. 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.

Class DescribeStacksResponse

The output for a DescribeStacks action.

Class EstimateTemplateCostRequest

Container for the parameters to the EstimateTemplateCost operation. 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.

Class EstimateTemplateCostResponse

The output for a EstimateTemplateCost action.

Class ExecuteChangeSetRequest

Container for the parameters to the ExecuteChangeSet operation. 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.

Class ExecuteChangeSetResponse

The output for the ExecuteChangeSet action.

Class Export

The Export structure describes the exported output values for a stack.

Class GetStackPolicyRequest

Container for the parameters to the GetStackPolicy operation. Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Class GetStackPolicyResponse

The output for the GetStackPolicy action.

Class GetTemplateRequest

Container for the parameters to the GetTemplate operation. 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.

Class GetTemplateResponse

The output for GetTemplate action.

Class GetTemplateSummaryRequest

Container for the parameters to the GetTemplateSummary operation. 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.

Class GetTemplateSummaryResponse

The output for the GetTemplateSummary action.

Class InsufficientCapabilitiesException

CloudFormation exception

Class InvalidChangeSetStatusException

CloudFormation exception

Class InvalidOperationException

CloudFormation exception

Class LimitExceededException

CloudFormation exception

Class ListChangeSetsRequest

Container for the parameters to the ListChangeSets operation. 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.

Class ListChangeSetsResponse

The output for the ListChangeSets action.

Class ListExportsRequest

Container for the parameters to the ListExports operation. 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.

Class ListExportsResponse

This is the response object from the ListExports operation.

Class ListImportsRequest

Container for the parameters to the ListImports operation. 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.

Class ListImportsResponse

This is the response object from the ListImports operation.

Class ListStackInstancesRequest

Container for the parameters to the ListStackInstances operation. 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.

Class ListStackInstancesResponse

This is the response object from the ListStackInstances operation.

Class ListStackResourcesRequest

Container for the parameters to the ListStackResources operation. 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.

Class ListStackResourcesResponse

The output for a ListStackResources action.

Class ListStackSetOperationResultsRequest

Container for the parameters to the ListStackSetOperationResults operation. Returns summary information about the results of a stack set operation.

Class ListStackSetOperationResultsResponse

This is the response object from the ListStackSetOperationResults operation.

Class ListStackSetOperationsRequest

Container for the parameters to the ListStackSetOperations operation. Returns summary information about operations performed on a stack set.

Class ListStackSetOperationsResponse

This is the response object from the ListStackSetOperations operation.

Class ListStackSetsRequest

Container for the parameters to the ListStackSets operation. Returns summary information about stack sets that are associated with the user.

Class ListStackSetsResponse

This is the response object from the ListStackSets operation.

Class ListStacksRequest

Container for the parameters to the ListStacks operation. 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).

Class ListStacksResponse

The output for ListStacks action.

Class NameAlreadyExistsException

CloudFormation exception

Class OperationIdAlreadyExistsException

CloudFormation exception

Class OperationInProgressException

CloudFormation exception

Class OperationNotFoundException

CloudFormation exception

Class Output

The Output data type.

Class Parameter

The Parameter data type.

Class ParameterConstraints

A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.

Class ParameterDeclaration

The ParameterDeclaration data type.

Class ResourceChange

The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.

Class ResourceChangeDetail

For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.

Class ResourceTargetDefinition

The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

Class RollbackConfiguration

Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.

By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as breaching. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.

Class RollbackTrigger

A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALERT state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

Class SetStackPolicyRequest

Container for the parameters to the SetStackPolicy operation. Sets a stack policy for a specified stack.

Class SetStackPolicyResponse

This is the response object from the SetStackPolicy operation.

Class SignalResourceRequest

Container for the parameters to the SignalResource operation. 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.

Class SignalResourceResponse

This is the response object from the SignalResource operation.

Class Stack

The Stack data type.

Class StackEvent

The StackEvent data type.

Class StackInstance

An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

Class StackInstanceNotFoundException

CloudFormation exception

Class StackInstanceSummary

The structure that contains summary information about a stack instance.

Class StackResource

The StackResource data type.

Class StackResourceDetail

Contains detailed information about the specified stack resource.

Class StackResourceSummary

Contains high-level information about the specified stack resource.

Class StackSet

A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.

Class StackSetNotEmptyException

CloudFormation exception

Class StackSetNotFoundException

CloudFormation exception

Class StackSetOperation

The structure that contains information about a stack set operation.

Class StackSetOperationPreferences

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

Class StackSetOperationResultSummary

The structure that contains information about a specified operation's results for a given account in a given region.

Class StackSetOperationSummary

The structures that contain summary information about the specified operation.

Class StackSetSummary

The structures that contain summary information about the specified stack set.

Class StackSummary

The StackSummary Data Type

Class StaleRequestException

CloudFormation exception

Class StopStackSetOperationRequest

Container for the parameters to the StopStackSetOperation operation. Stops an in-progress operation on a stack set and its associated stack instances.

Class StopStackSetOperationResponse

This is the response object from the StopStackSetOperation operation.

Class Tag

The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.

Class TemplateParameter

The TemplateParameter data type.

Class TokenAlreadyExistsException

CloudFormation exception

Class UpdateStackRequest

The input for UpdateStack action.

Class UpdateStackResponse

The output for an UpdateStack action.

Class UpdateStackSetRequest

Container for the parameters to the UpdateStackSet operation. Updates the stack set and all 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 CreateStackInstances calls on the specified stack set use the updated stack set.

Class UpdateStackSetResponse

This is the response object from the UpdateStackSet operation.

Class UpdateTerminationProtectionRequest

Container for the parameters to the UpdateTerminationProtection operation. 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.

Class UpdateTerminationProtectionResponse

This is the response object from the UpdateTerminationProtection operation.

Class ValidateTemplateRequest

Container for the parameters to the ValidateTemplate operation. 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.

Class ValidateTemplateResponse

The output for ValidateTemplate action.