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 CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.

For each account and Region, CloudFormation lets you specify a Lambda 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.

CloudFormation has the following limits per account:

  • Number of concurrent resources

  • Number of stacks

  • Number of stack outputs

For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide.

Class ActivateTypeRequest

Container for the parameters to the ActivateType operation. Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Class ActivateTypeResponse

This is the response object from the ActivateType operation.

Class AlreadyExistsException

The resource with the name requested already exists.

Class AutoDeployment

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

Class BatchDescribeTypeConfigurationsError

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

Class BatchDescribeTypeConfigurationsRequest

Container for the parameters to the BatchDescribeTypeConfigurations operation. Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Class BatchDescribeTypeConfigurationsResponse

This is the response object from the BatchDescribeTypeConfigurations operation.

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 CFNRegistryException

An error occurred during a CloudFormation registry operation.

Class Change

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

Class ChangeSetHook

Specifies the resource, the hook, and the hook version to be invoked.

Class ChangeSetHookResourceTargetDetails

Specifies RESOURCE type target details for activated hooks.

Class ChangeSetHookTargetDetails

Specifies target details for an activated hook.

Class ChangeSetNotFoundException

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.

Class ChangeSetSummary

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

Class CloudFormationPaginatorFactory

Paginators for the CloudFormation service

Class ContinueUpdateRollbackRequest

Container for the parameters to the ContinueUpdateRollback operation. For a specified stack that's 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 CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because 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 operation.

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 CloudFormation will create. If you create a change set for an existing stack, 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 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. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, 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. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

Class CreateChangeSetResponse

The output for the CreateChangeSet action.

Class CreatedButModifiedException

The specified resource exists, but has been changed.

Class CreateStackInstancesRequest

Container for the parameters to the CreateStackInstances operation. Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

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 through the DescribeStacksoperation.

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 DeactivateTypeRequest

Container for the parameters to the DeactivateType operation. Deactivates a public extension that was previously activated in this account and region.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

Class DeactivateTypeResponse

This is the response object from the DeactivateType 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, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

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 Amazon Web Services 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 don't show up in the DescribeStacks operation 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 its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.

Class DeleteStackSetResponse

This is the response object from the DeleteStackSet operation.

Class DeploymentTargets

[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

For update operations, you can specify either Accounts or OrganizationalUnitIds. For create and delete operations, specify OrganizationalUnitIds.

Class DeregisterTypeRequest

Container for the parameters to the DeregisterType operation. Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

Class DeregisterTypeResponse

This is the response object from the DeregisterType operation.

Class DescribeAccountLimitsRequest

Container for the parameters to the DescribeAccountLimits operation. Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.

Class DescribeAccountLimitsResponse

The output for the DescribeAccountLimits action.

Class DescribeChangeSetHooksRequest

Container for the parameters to the DescribeChangeSetHooks operation. Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Class DescribeChangeSetHooksResponse

This is the response object from the DescribeChangeSetHooks operation.

Class DescribeChangeSetRequest

Container for the parameters to the DescribeChangeSet operation. Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.

Class DescribeChangeSetResponse

The output for the DescribeChangeSet action.

Class DescribePublisherRequest

Container for the parameters to the DescribePublisher operation. Returns information about a CloudFormation extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information about registering as a publisher, see:

Class DescribePublisherResponse

This is the response object from the DescribePublisher operation.

Class DescribeStackDriftDetectionStatusRequest

Container for the parameters to the DescribeStackDriftDetectionStatus operation. Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift 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.

Class DescribeStackDriftDetectionStatusResponse

This is the response object from the DescribeStackDriftDetectionStatus operation.

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 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, Amazon Web Services 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 DescribeStackResourceDriftsRequest

Container for the parameters to the DescribeStackResourceDrifts operation. 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 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 haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't 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.

Class DescribeStackResourceDriftsResponse

This is the response object from the DescribeStackResourceDrifts 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 Amazon Web Services 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 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 doesn't exist, an ValidationError is returned.

Class DescribeStacksResponse

The output for a DescribeStacks action.

Class DescribeTypeRegistrationRequest

Container for the parameters to the DescribeTypeRegistration operation. Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

Class DescribeTypeRegistrationResponse

This is the response object from the DescribeTypeRegistration operation.

Class DescribeTypeRequest

Container for the parameters to the DescribeType operation. Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Class DescribeTypeResponse

This is the response object from the DescribeType operation.

Class DetectStackDriftRequest

Container for the parameters to the DetectStackDrift 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. For each resource in the stack that supports drift detection, 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, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

Class DetectStackDriftResponse

This is the response object from the DetectStackDrift operation.

Class DetectStackResourceDriftRequest

Container for the parameters to the DetectStackResourceDrift operation. 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 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 don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Class DetectStackResourceDriftResponse

This is the response object from the DetectStackResourceDrift operation.

Class DetectStackSetDriftRequest

Container for the parameters to the DetectStackSetDrift operation. Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)

  • Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation.

Class DetectStackSetDriftResponse

This is the response object from the DetectStackSetDrift operation.

Class EstimateTemplateCostRequest

Container for the parameters to the EstimateTemplateCost operation. Returns the estimated monthly cost of a template. The return value is an Amazon Web Services 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, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, 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, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.

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 doesn't 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 doesn't exist, a ValidationError is returned.

Class GetTemplateSummaryResponse

The output for the GetTemplateSummary action.

Class ImportStacksToStackSetRequest

Container for the parameters to the ImportStacksToStackSet operation. Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

ImportStacksToStackSet is only supported by self-managed permissions.

Class ImportStacksToStackSetResponse

This is the response object from the ImportStacksToStackSet operation.

Class InsufficientCapabilitiesException

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

Class InvalidChangeSetStatusException

The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

Class InvalidOperationException

The specified operation isn't valid.

Class InvalidStateTransitionException

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

Class LimitExceededException

The quota for the resource has already been reached.

For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.

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, 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 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 Amazon Web Services account name or Region, or that have a specific status.

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.

  • [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.

  • [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.

  • [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.

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 ListTypeRegistrationsRequest

Container for the parameters to the ListTypeRegistrations operation. Returns a list of registration tokens for the specified extension(s).

Class ListTypeRegistrationsResponse

This is the response object from the ListTypeRegistrations operation.

Class ListTypesRequest

Container for the parameters to the ListTypes operation. Returns summary information about extension that have been registered with CloudFormation.

Class ListTypesResponse

This is the response object from the ListTypes operation.

Class ListTypeVersionsRequest

Container for the parameters to the ListTypeVersions operation. Returns summary information about the versions of an extension.

Class ListTypeVersionsResponse

This is the response object from the ListTypeVersions operation.

Class LoggingConfig

Contains logging configuration information for an extension.

Class ManagedExecution

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Class ModuleInfo

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.

Class NameAlreadyExistsException

The specified name is already in use.

Class OperationIdAlreadyExistsException

The specified operation ID already exists.

Class OperationInProgressException

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

Class OperationNotFoundException

The specified ID refers to an operation that doesn't exist.

Class OperationStatusCheckFailedException

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

Class Output

The Output data type.

Class Parameter

The Parameter data type.

Class ParameterConstraints

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

Class ParameterDeclaration

The ParameterDeclaration data type.

Class PhysicalResourceIdContextKeyValuePair

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

Class PropertyDifference

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Class PublishTypeRequest

Container for the parameters to the PublishType operation. Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Class PublishTypeResponse

This is the response object from the PublishType operation.

Class RecordHandlerProgressRequest

Container for the parameters to the RecordHandlerProgress operation. Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

Class RecordHandlerProgressResponse

This is the response object from the RecordHandlerProgress operation.

Class RegisterPublisherRequest

Container for the parameters to the RegisterPublisher operation. Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

Class RegisterPublisherResponse

This is the response object from the RegisterPublisher operation.

Class RegisterTypeRequest

Container for the parameters to the RegisterType operation. Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

  • Validating the extension schema.

  • Determining which handlers, if any, have been specified for the extension.

  • Making the extension available for use in your account.

For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Class RegisterTypeResponse

This is the response object from the RegisterType operation.

Class RequiredActivatedType

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

For more information, see Activating public modules for use in your account in the CloudFormation User Guide.

Class ResourceChange

The ResourceChange structure describes the resource and the action that 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 CloudFormation will make to that resource.

Class ResourceIdentifierSummary

Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.

Class ResourceTargetDefinition

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

Class ResourceToImport

Describes the target resource of an import operation.

Class RollbackConfiguration

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

Rollback triggers enable you to have 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 more information, see Monitor and Roll Back Stack Operations.

Class RollbackStackRequest

Container for the parameters to the RollbackStack operation. When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE

  • UPDATE_COMPLETE

  • UPDATE_ROLLBACK_COMPLETE

  • IMPORT_COMPLETE

  • IMPORT_ROLLBACK_COMPLETE

Class RollbackStackResponse

This is the response object from the RollbackStack operation.

Class RollbackTrigger

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM 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 SetTypeConfigurationRequest

Container for the parameters to the SetTypeConfiguration operation. Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.

Class SetTypeConfigurationResponse

This is the response object from the SetTypeConfiguration operation.

Class SetTypeDefaultVersionRequest

Container for the parameters to the SetTypeDefaultVersion operation. Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

Class SetTypeDefaultVersionResponse

This is the response object from the SetTypeDefaultVersion 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 operation in conjunction with a creation policy or update policy. 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 operation 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 StackDriftInformation

Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.

Class StackDriftInformationSummary

Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.

Class StackEvent

The StackEvent data type.

Class StackInstance

An 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, in addition to the ID of the actual stack and the stack status.

Class StackInstanceComprehensiveStatus

The detailed status of the stack instance.

Class StackInstanceFilter

The status that stack instances are filtered by.

Class StackInstanceNotFoundException

The specified stack instance doesn't exist.

Class StackInstanceSummary

The structure that contains summary information about a stack instance.

Class StackNotFoundException

The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.

Class StackResource

The StackResource data type.

Class StackResourceDetail

Contains detailed information about the specified stack resource.

Class StackResourceDrift

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that don't currently support drift detection can't be checked. 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 resources in a given stack that support drift detection.

Class StackResourceDriftInformation

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

Class StackResourceDriftInformationSummary

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

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 Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

Class StackSetDriftDetectionDetails

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress isn't included.

For stack set operations, includes information about drift operations currently being performed on the stack set.

For more information, see Detecting unmanaged changes in stack sets in the CloudFormation User Guide.

Class StackSetNotEmptyException

You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.

Class StackSetNotFoundException

The specified stack set doesn't exist.

Class StackSetOperation

The structure that contains information about a stack set operation.

Class StackSetOperationPreferences

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

For more information about 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

Another operation has been performed on this stack set since the specified operation was performed.

Class StopStackSetOperationRequest

Container for the parameters to the StopStackSetOperation operation. Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

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 CloudFormation stack.

Class TemplateParameter

The TemplateParameter data type.

Class TestTypeRequest

Container for the parameters to the TestType operation. Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

  • For resource types, this includes passing all contracts tests defined for the type.

  • For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.

Once you've initiated testing on an extension using TestType, you can use DescribeType to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

Class TestTypeResponse

This is the response object from the TestType operation.

Class TokenAlreadyExistsException

A client request token already exists.

Class TypeConfigurationDetails

Detailed information concerning the specification of a CloudFormation extension in a given account and region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Class TypeConfigurationIdentifier

Identifying information for the configuration of a CloudFormation extension.

Class TypeConfigurationNotFoundException

The specified extension configuration can't be found.

Class TypeFilters

Filter criteria to use in determining which extensions to return.

Class TypeNotFoundException

The specified extension doesn't exist in the CloudFormation registry.

Class TypeSummary

Contains summary information about the specified CloudFormation extension.

Class TypeVersionSummary

Contains summary information about a specific version of a CloudFormation extension.

Class UpdateStackInstancesRequest

Container for the parameters to the UpdateStackInstances operation. Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services 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 aren't 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.

Class UpdateStackInstancesResponse

This is the response object from the UpdateStackInstances operation.

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 associated stack instances in the specified accounts and Amazon Web Services 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.

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 CloudFormation User Guide.

For nested stacks, termination protection is set on the root stack and can't 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. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.

Class ValidateTemplateResponse

The output for ValidateTemplate action.

Interfaces

NameDescription
Interface ICloudFormationPaginatorFactory

Paginators for the CloudFormation service

Interface IDescribeAccountLimitsPaginator

Paginator for the DescribeAccountLimits operation

Interface IDescribeStackEventsPaginator

Paginator for the DescribeStackEvents operation

Interface IDescribeStackResourceDriftsPaginator

Paginator for the DescribeStackResourceDrifts operation

Interface IDescribeStacksPaginator

Paginator for the DescribeStacks operation

Interface IListChangeSetsPaginator

Paginator for the ListChangeSets operation

Interface IListExportsPaginator

Paginator for the ListExports operation

Interface IListImportsPaginator

Paginator for the ListImports operation

Interface IListStackInstancesPaginator

Paginator for the ListStackInstances operation

Interface IListStackResourcesPaginator

Paginator for the ListStackResources operation

Interface IListStackSetOperationResultsPaginator

Paginator for the ListStackSetOperationResults operation

Interface IListStackSetOperationsPaginator

Paginator for the ListStackSetOperations operation

Interface IListStackSetsPaginator

Paginator for the ListStackSets operation

Interface IListStacksPaginator

Paginator for the ListStacks operation

Interface IListTypeRegistrationsPaginator

Paginator for the ListTypeRegistrations operation

Interface IListTypesPaginator

Paginator for the ListTypes operation

Interface IListTypeVersionsPaginator

Paginator for the ListTypeVersions operation