AbstractAmazonCloudFormation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.AbstractAmazonCloudFormation

All Implemented Interfaces:

AmazonCloudFormation

Direct Known Subclasses:

AbstractAmazonCloudFormationAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCloudFormation
extends Object
implements AmazonCloudFormation
```
Abstract implementation of AmazonCloudFormation. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudformation.AmazonCloudFormation
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivateTypeResult`	`activateType(ActivateTypeRequest request)` Activates a public third-party extension, making it available for use in stack templates.
`BatchDescribeTypeConfigurationsResult`	`batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest request)` Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.
`CancelUpdateStackResult`	`cancelUpdateStack(CancelUpdateStackRequest request)` Cancels an update on the specified stack.
`ContinueUpdateRollbackResult`	`continueUpdateRollback(ContinueUpdateRollbackRequest request)` For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state, continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
`CreateChangeSetResult`	`createChangeSet(CreateChangeSetRequest request)` Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
`CreateStackResult`	`createStack(CreateStackRequest request)` Creates a stack as specified in the template.
`CreateStackInstancesResult`	`createStackInstances(CreateStackInstancesRequest request)` Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
`CreateStackSetResult`	`createStackSet(CreateStackSetRequest request)` Creates a stack set.
`DeactivateTypeResult`	`deactivateType(DeactivateTypeRequest request)` Deactivates a public extension that was previously activated in this account and region.
`DeleteChangeSetResult`	`deleteChangeSet(DeleteChangeSetRequest request)` Deletes the specified change set.
`DeleteStackResult`	`deleteStack(DeleteStackRequest request)` Deletes a specified stack.
`DeleteStackInstancesResult`	`deleteStackInstances(DeleteStackInstancesRequest request)` Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
`DeleteStackSetResult`	`deleteStackSet(DeleteStackSetRequest request)` Deletes a stack set.
`DeregisterTypeResult`	`deregisterType(DeregisterTypeRequest request)` Marks an extension or extension version as `DEPRECATED` in the CloudFormation registry, removing it from active use.
`DescribeAccountLimitsResult`	`describeAccountLimits(DescribeAccountLimitsRequest request)` Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.
`DescribeChangeSetResult`	`describeChangeSet(DescribeChangeSetRequest request)` Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.
`DescribeChangeSetHooksResult`	`describeChangeSetHooks(DescribeChangeSetHooksRequest request)` Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
`DescribePublisherResult`	`describePublisher(DescribePublisherRequest request)` Returns information about a CloudFormation extension publisher.
`DescribeStackDriftDetectionStatusResult`	`describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest request)` Returns information about a stack drift detection operation.
`DescribeStackEventsResult`	`describeStackEvents(DescribeStackEventsRequest request)` Returns all stack related events for a specified stack in reverse chronological order.
`DescribeStackInstanceResult`	`describeStackInstance(DescribeStackInstanceRequest request)` Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
`DescribeStackResourceResult`	`describeStackResource(DescribeStackResourceRequest request)` Returns a description of the specified resource in the specified stack.
`DescribeStackResourceDriftsResult`	`describeStackResourceDrifts(DescribeStackResourceDriftsRequest request)` Returns drift information for the resources that have been checked for drift in the specified stack.
`DescribeStackResourcesResult`	`describeStackResources(DescribeStackResourcesRequest request)` Returns Amazon Web Services resource descriptions for running and deleted stacks.
`DescribeStacksResult`	`describeStacks()` Simplified method form for invoking the DescribeStacks operation.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest request)` Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
`DescribeStackSetResult`	`describeStackSet(DescribeStackSetRequest request)` Returns the description of the specified stack set.
`DescribeStackSetOperationResult`	`describeStackSetOperation(DescribeStackSetOperationRequest request)` Returns the description of the specified stack set operation.
`DescribeTypeResult`	`describeType(DescribeTypeRequest request)` Returns detailed information about an extension that has been registered.
`DescribeTypeRegistrationResult`	`describeTypeRegistration(DescribeTypeRegistrationRequest request)` Returns information about an extension's registration, including its current status and type and version identifiers.
`DetectStackDriftResult`	`detectStackDrift(DetectStackDriftRequest request)` 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.
`DetectStackResourceDriftResult`	`detectStackResourceDrift(DetectStackResourceDriftRequest request)` 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.
`DetectStackSetDriftResult`	`detectStackSetDrift(DetectStackSetDriftRequest request)` Detect drift on a stack set.
`EstimateTemplateCostResult`	`estimateTemplateCost()` Simplified method form for invoking the EstimateTemplateCost operation.
`EstimateTemplateCostResult`	`estimateTemplateCost(EstimateTemplateCostRequest request)` Returns the estimated monthly cost of a template.
`ExecuteChangeSetResult`	`executeChangeSet(ExecuteChangeSetRequest request)` Updates a stack using the input information that was provided when the specified change set was created.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetStackPolicyResult`	`getStackPolicy(GetStackPolicyRequest request)` Returns the stack policy for a specified stack.
`GetTemplateResult`	`getTemplate(GetTemplateRequest request)` Returns the template body for a specified stack.
`GetTemplateSummaryResult`	`getTemplateSummary()` Simplified method form for invoking the GetTemplateSummary operation.
`GetTemplateSummaryResult`	`getTemplateSummary(GetTemplateSummaryRequest request)` Returns information about a new or existing template.
`ImportStacksToStackSetResult`	`importStacksToStackSet(ImportStacksToStackSetRequest request)` Import existing stacks into a new stack sets.
`ListChangeSetsResult`	`listChangeSets(ListChangeSetsRequest request)` Returns the ID and status of each active change set for a stack.
`ListExportsResult`	`listExports(ListExportsRequest request)` Lists all exported output values in the account and Region in which you call this action.
`ListImportsResult`	`listImports(ListImportsRequest request)` Lists all stacks that are importing an exported output value.
`ListStackInstancesResult`	`listStackInstances(ListStackInstancesRequest request)` Returns summary information about stack instances that are associated with the specified stack set.
`ListStackResourcesResult`	`listStackResources(ListStackResourcesRequest request)` Returns descriptions of all resources of the specified stack.
`ListStacksResult`	`listStacks()` Simplified method form for invoking the ListStacks operation.
`ListStacksResult`	`listStacks(ListStacksRequest request)` Returns the summary information for stacks whose status matches the specified StackStatusFilter.
`ListStackSetOperationResultsResult`	`listStackSetOperationResults(ListStackSetOperationResultsRequest request)` Returns summary information about the results of a stack set operation.
`ListStackSetOperationsResult`	`listStackSetOperations(ListStackSetOperationsRequest request)` Returns summary information about operations performed on a stack set.
`ListStackSetsResult`	`listStackSets(ListStackSetsRequest request)` Returns summary information about stack sets that are associated with the user.
`ListTypeRegistrationsResult`	`listTypeRegistrations(ListTypeRegistrationsRequest request)` Returns a list of registration tokens for the specified extension(s).
`ListTypesResult`	`listTypes(ListTypesRequest request)` Returns summary information about extension that have been registered with CloudFormation.
`ListTypeVersionsResult`	`listTypeVersions(ListTypeVersionsRequest request)` Returns summary information about the versions of an extension.
`PublishTypeResult`	`publishType(PublishTypeRequest request)` Publishes the specified extension to the CloudFormation registry as a public extension in this region.
`RecordHandlerProgressResult`	`recordHandlerProgress(RecordHandlerProgressRequest request)` Reports progress of a resource handler to CloudFormation.
`RegisterPublisherResult`	`registerPublisher(RegisterPublisherRequest request)` Registers your account as a publisher of public extensions in the CloudFormation registry.
`RegisterTypeResult`	`registerType(RegisterTypeRequest request)` Registers an extension with the CloudFormation service.
`RollbackStackResult`	`rollbackStack(RollbackStackRequest request)` When specifying `RollbackStack`, you preserve the state of previously provisioned resources when an operation fails.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://cloudformation.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonCloudFormation.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`SetStackPolicyResult`	`setStackPolicy(SetStackPolicyRequest request)` Sets a stack policy for a specified stack.
`SetTypeConfigurationResult`	`setTypeConfiguration(SetTypeConfigurationRequest request)` Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
`SetTypeDefaultVersionResult`	`setTypeDefaultVersion(SetTypeDefaultVersionRequest request)` Specify the default version of an extension.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SignalResourceResult`	`signalResource(SignalResourceRequest request)` Sends a signal to the specified resource with a success or failure status.
`StopStackSetOperationResult`	`stopStackSetOperation(StopStackSetOperationRequest request)` Stops an in-progress operation on a stack set and its associated stack instances.
`TestTypeResult`	`testType(TestTypeRequest request)` Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
`UpdateStackResult`	`updateStack(UpdateStackRequest request)` Updates a stack as specified in the template.
`UpdateStackInstancesResult`	`updateStackInstances(UpdateStackInstancesRequest request)` Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.
`UpdateStackSetResult`	`updateStackSet(UpdateStackSetRequest request)` Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
`UpdateTerminationProtectionResult`	`updateTerminationProtection(UpdateTerminationProtectionRequest request)` Updates termination protection for the specified stack.
`ValidateTemplateResult`	`validateTemplate(ValidateTemplateRequest request)` Validates a specified template.
`AmazonCloudFormationWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonCloudFormation
    
    Overrides the default endpoint for this client ("https://cloudformation.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "cloudformation.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudformation.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonCloudFormation
    
    Parameters:
    
    endpoint - The endpoint (ex: "cloudformation.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudformation.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCloudFormation
    
    An alternative to AmazonCloudFormation.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonCloudFormation
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - activateType
```
public ActivateTypeResult activateType(ActivateTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    activateType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ActivateType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDescribeTypeConfigurations
```
public BatchDescribeTypeConfigurationsResult batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    batchDescribeTypeConfigurations in interface AmazonCloudFormation
    
    Returns:
    
    Result of the BatchDescribeTypeConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelUpdateStack
```
public CancelUpdateStackResult cancelUpdateStack(CancelUpdateStackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    cancelUpdateStack in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the CancelUpdateStack action.
    
    Returns:
    
    Result of the CancelUpdateStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - continueUpdateRollback
```
public ContinueUpdateRollbackResult continueUpdateRollback(ContinueUpdateRollbackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    continueUpdateRollback in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the ContinueUpdateRollback action.
    
    Returns:
    
    Result of the ContinueUpdateRollback operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChangeSet
```
public CreateChangeSetResult createChangeSet(CreateChangeSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    createChangeSet in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the CreateChangeSet action.
    
    Returns:
    
    Result of the CreateChangeSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
public CreateStackResult createStack(CreateStackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    createStack in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for CreateStack action.
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStackInstances
```
public CreateStackInstancesResult createStackInstances(CreateStackInstancesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    createStackInstances in interface AmazonCloudFormation
    
    Returns:
    
    Result of the CreateStackInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStackSet
```
public CreateStackSetResult createStackSet(CreateStackSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Creates a stack set.
    
    Specified by:
    
    createStackSet in interface AmazonCloudFormation
    
    Returns:
    
    Result of the CreateStackSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deactivateType
```
public DeactivateTypeResult deactivateType(DeactivateTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    deactivateType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DeactivateType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChangeSet
```
public DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    deleteChangeSet in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the DeleteChangeSet action.
    
    Returns:
    
    Result of the DeleteChangeSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
public DeleteStackResult deleteStack(DeleteStackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    deleteStack in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for DeleteStack action.
    
    Returns:
    
    Result of the DeleteStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStackInstances
```
public DeleteStackInstancesResult deleteStackInstances(DeleteStackInstancesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
    
    Specified by:
    
    deleteStackInstances in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DeleteStackInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStackSet
```
public DeleteStackSetResult deleteStackSet(DeleteStackSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    deleteStackSet in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DeleteStackSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterType
```
public DeregisterTypeResult deregisterType(DeregisterTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    deregisterType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DeregisterType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccountLimits
```
public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeAccountLimits in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the DescribeAccountLimits action.
    
    Returns:
    
    Result of the DescribeAccountLimits operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeChangeSet
```
public DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeChangeSet in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the DescribeChangeSet action.
    
    Returns:
    
    Result of the DescribeChangeSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeChangeSetHooks
```
public DescribeChangeSetHooksResult describeChangeSetHooks(DescribeChangeSetHooksRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
    
    Specified by:
    
    describeChangeSetHooks in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeChangeSetHooks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePublisher
```
public DescribePublisherResult describePublisher(DescribePublisherRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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 on registering as a publisher, see:
    - RegisterPublisher
    - Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
    Specified by:
    
    describePublisher in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribePublisher operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackDriftDetectionStatus
```
public DescribeStackDriftDetectionStatusResult describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
    
    Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
    
    Specified by:
    
    describeStackDriftDetectionStatus in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeStackDriftDetectionStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackEvents
```
public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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).
    
    Specified by:
    
    describeStackEvents in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for DescribeStackEvents action.
    
    Returns:
    
    Result of the DescribeStackEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackInstance
```
public DescribeStackInstanceResult describeStackInstance(DescribeStackInstanceRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeStackInstance in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeStackInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackResource
```
public DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeStackResource in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for DescribeStackResource action.
    
    Returns:
    
    Result of the DescribeStackResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackResourceDrifts
```
public DescribeStackResourceDriftsResult describeStackResourceDrifts(DescribeStackResourceDriftsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeStackResourceDrifts in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeStackResourceDrifts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackResources
```
public DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeStackResources in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for DescribeStackResources action.
    
    Returns:
    
    Result of the DescribeStackResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackSet
```
public DescribeStackSetResult describeStackSet(DescribeStackSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns the description of the specified stack set.
    
    Specified by:
    
    describeStackSet in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeStackSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStackSetOperation
```
public DescribeStackSetOperationResult describeStackSetOperation(DescribeStackSetOperationRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns the description of the specified stack set operation.
    
    Specified by:
    
    describeStackSetOperation in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeStackSetOperation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
public DescribeStacksResult describeStacks(DescribeStacksRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeStacks in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for DescribeStacks action.
    
    Returns:
    
    Result of the DescribeStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
public DescribeStacksResult describeStacks()
```
    Description copied from interface: AmazonCloudFormation
    
    Simplified method form for invoking the DescribeStacks operation.
    
    Specified by:
    
    describeStacks in interface AmazonCloudFormation
    
    See Also:
    
    AmazonCloudFormation.describeStacks(DescribeStacksRequest)
  - describeType
```
public DescribeTypeResult describeType(DescribeTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTypeRegistration
```
public DescribeTypeRegistrationResult describeTypeRegistration(DescribeTypeRegistrationRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    describeTypeRegistration in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DescribeTypeRegistration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectStackDrift
```
public DetectStackDriftResult detectStackDrift(DetectStackDriftRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    detectStackDrift in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DetectStackDrift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectStackResourceDrift
```
public DetectStackResourceDriftResult detectStackResourceDrift(DetectStackResourceDriftRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    detectStackResourceDrift in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DetectStackResourceDrift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectStackSetDrift
```
public DetectStackSetDriftResult detectStackSetDrift(DetectStackSetDriftRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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 on 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 .
    Specified by:
    
    detectStackSetDrift in interface AmazonCloudFormation
    
    Returns:
    
    Result of the DetectStackSetDrift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - estimateTemplateCost
```
public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    estimateTemplateCost in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for an EstimateTemplateCost action.
    
    Returns:
    
    Result of the EstimateTemplateCost operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - estimateTemplateCost
```
public EstimateTemplateCostResult estimateTemplateCost()
```
    Description copied from interface: AmazonCloudFormation
    
    Simplified method form for invoking the EstimateTemplateCost operation.
    
    Specified by:
    
    estimateTemplateCost in interface AmazonCloudFormation
    
    See Also:
    
    AmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)
  - executeChangeSet
```
public ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    executeChangeSet in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the ExecuteChangeSet action.
    
    Returns:
    
    Result of the ExecuteChangeSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStackPolicy
```
public GetStackPolicyResult getStackPolicy(GetStackPolicyRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
    
    Specified by:
    
    getStackPolicy in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the GetStackPolicy action.
    
    Returns:
    
    Result of the GetStackPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTemplate
```
public GetTemplateResult getTemplate(GetTemplateRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    getTemplate in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for a GetTemplate action.
    
    Returns:
    
    Result of the GetTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTemplateSummary
```
public GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    getTemplateSummary in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the GetTemplateSummary action.
    
    Returns:
    
    Result of the GetTemplateSummary operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTemplateSummary
```
public GetTemplateSummaryResult getTemplateSummary()
```
    Description copied from interface: AmazonCloudFormation
    
    Simplified method form for invoking the GetTemplateSummary operation.
    
    Specified by:
    
    getTemplateSummary in interface AmazonCloudFormation
    
    See Also:
    
    AmazonCloudFormation.getTemplateSummary(GetTemplateSummaryRequest)
  - importStacksToStackSet
```
public ImportStacksToStackSetResult importStacksToStackSet(ImportStacksToStackSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    importStacksToStackSet in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ImportStacksToStackSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChangeSets
```
public ListChangeSetsResult listChangeSets(ListChangeSetsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    listChangeSets in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the ListChangeSets action.
    
    Returns:
    
    Result of the ListChangeSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExports
```
public ListExportsResult listExports(ListExportsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    listExports in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListExports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImports
```
public ListImportsResult listImports(ListImportsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    listImports in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListImports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStackInstances
```
public ListStackInstancesResult listStackInstances(ListStackInstancesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    listStackInstances in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListStackInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStackResources
```
public ListStackResourcesResult listStackResources(ListStackResourcesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    listStackResources in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the ListStackResource action.
    
    Returns:
    
    Result of the ListStackResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStackSetOperationResults
```
public ListStackSetOperationResultsResult listStackSetOperationResults(ListStackSetOperationResultsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns summary information about the results of a stack set operation.
    
    Specified by:
    
    listStackSetOperationResults in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListStackSetOperationResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStackSetOperations
```
public ListStackSetOperationsResult listStackSetOperations(ListStackSetOperationsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns summary information about operations performed on a stack set.
    
    Specified by:
    
    listStackSetOperations in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListStackSetOperations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStackSets
```
public ListStackSetsResult listStackSets(ListStackSetsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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.
    Specified by:
    
    listStackSets in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListStackSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStacks
```
public ListStacksResult listStacks(ListStacksRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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).
    
    Specified by:
    
    listStacks in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for ListStacks action.
    
    Returns:
    
    Result of the ListStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStacks
```
public ListStacksResult listStacks()
```
    Description copied from interface: AmazonCloudFormation
    
    Simplified method form for invoking the ListStacks operation.
    
    Specified by:
    
    listStacks in interface AmazonCloudFormation
    
    See Also:
    
    AmazonCloudFormation.listStacks(ListStacksRequest)
  - listTypeRegistrations
```
public ListTypeRegistrationsResult listTypeRegistrations(ListTypeRegistrationsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns a list of registration tokens for the specified extension(s).
    
    Specified by:
    
    listTypeRegistrations in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListTypeRegistrations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTypeVersions
```
public ListTypeVersionsResult listTypeVersions(ListTypeVersionsRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns summary information about the versions of an extension.
    
    Specified by:
    
    listTypeVersions in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListTypeVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTypes
```
public ListTypesResult listTypes(ListTypesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns summary information about extension that have been registered with CloudFormation.
    
    Specified by:
    
    listTypes in interface AmazonCloudFormation
    
    Returns:
    
    Result of the ListTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - publishType
```
public PublishTypeResult publishType(PublishTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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 on 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.
    
    Specified by:
    
    publishType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the PublishType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - recordHandlerProgress
```
public RecordHandlerProgressResult recordHandlerProgress(RecordHandlerProgressRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Reports progress of a resource handler to CloudFormation.
    
    Reserved for use by the CloudFormation CLI. Don't use this API in your code.
    
    Specified by:
    
    recordHandlerProgress in interface AmazonCloudFormation
    
    Returns:
    
    Result of the RecordHandlerProgress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerPublisher
```
public RegisterPublisherResult registerPublisher(RegisterPublisherRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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 on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
    
    Specified by:
    
    registerPublisher in interface AmazonCloudFormation
    
    Returns:
    
    Result of the RegisterPublisher operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerType
```
public RegisterTypeResult registerType(RegisterTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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 on 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.
    Specified by:
    
    registerType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the RegisterType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rollbackStack
```
public RollbackStackResult rollbackStack(RollbackStackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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
    Specified by:
    
    rollbackStack in interface AmazonCloudFormation
    
    Returns:
    
    Result of the RollbackStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setStackPolicy
```
public SetStackPolicyResult setStackPolicy(SetStackPolicyRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Sets a stack policy for a specified stack.
    
    Specified by:
    
    setStackPolicy in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the SetStackPolicy action.
    
    Returns:
    
    Result of the SetStackPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setTypeConfiguration
```
public SetTypeConfigurationResult setTypeConfiguration(SetTypeConfigurationRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    setTypeConfiguration in interface AmazonCloudFormation
    
    Returns:
    
    Result of the SetTypeConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setTypeDefaultVersion
```
public SetTypeDefaultVersionResult setTypeDefaultVersion(SetTypeDefaultVersionRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
    
    Specified by:
    
    setTypeDefaultVersion in interface AmazonCloudFormation
    
    Returns:
    
    Result of the SetTypeDefaultVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - signalResource
```
public SignalResourceResult signalResource(SignalResourceRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    signalResource in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for the SignalResource action.
    
    Returns:
    
    Result of the SignalResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopStackSetOperation
```
public StopStackSetOperationResult stopStackSetOperation(StopStackSetOperationRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    stopStackSetOperation in interface AmazonCloudFormation
    
    Returns:
    
    Result of the StopStackSetOperation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testType
```
public TestTypeResult testType(TestTypeRequest request)
```
    Description copied from interface: AmazonCloudFormation
    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.
    Specified by:
    
    testType in interface AmazonCloudFormation
    
    Returns:
    
    Result of the TestType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
public UpdateStackResult updateStack(UpdateStackRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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 through the DescribeStacks action.
    
    To get a copy of the template for an existing stack, you can use the GetTemplate action.
    
    For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
    
    Specified by:
    
    updateStack in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for an UpdateStack action.
    
    Returns:
    
    Result of the UpdateStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStackInstances
```
public UpdateStackInstancesResult updateStackInstances(UpdateStackInstancesRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    updateStackInstances in interface AmazonCloudFormation
    
    Returns:
    
    Result of the UpdateStackInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStackSet
```
public UpdateStackSetResult updateStackSet(UpdateStackSetRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    updateStackSet in interface AmazonCloudFormation
    
    Returns:
    
    Result of the UpdateStackSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTerminationProtection
```
public UpdateTerminationProtectionResult updateTerminationProtection(UpdateTerminationProtectionRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    updateTerminationProtection in interface AmazonCloudFormation
    
    Returns:
    
    Result of the UpdateTerminationProtection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - validateTemplate
```
public ValidateTemplateResult validateTemplate(ValidateTemplateRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    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.
    
    Specified by:
    
    validateTemplate in interface AmazonCloudFormation
    
    Parameters:
    
    request - The input for ValidateTemplate action.
    
    Returns:
    
    Result of the ValidateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCloudFormation
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonCloudFormation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCloudFormation
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudFormation
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonCloudFormationWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonCloudFormation

Did this page help you?

Class AbstractAmazonCloudFormation

Field Summary

Fields inherited from interface com.amazonaws.services.cloudformation.AmazonCloudFormation

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

activateType

batchDescribeTypeConfigurations

cancelUpdateStack

continueUpdateRollback

createChangeSet

createStack

createStackInstances

createStackSet

deactivateType

deleteChangeSet

deleteStack

deleteStackInstances

deleteStackSet

deregisterType

describeAccountLimits

describeChangeSet

describeChangeSetHooks

describePublisher

describeStackDriftDetectionStatus

describeStackEvents

describeStackInstance

describeStackResource

describeStackResourceDrifts

describeStackResources

describeStackSet

describeStackSetOperation

describeStacks

describeStacks

describeType

describeTypeRegistration

detectStackDrift

detectStackResourceDrift

detectStackSetDrift

estimateTemplateCost

estimateTemplateCost

executeChangeSet

getStackPolicy

getTemplate

getTemplateSummary

getTemplateSummary

importStacksToStackSet

listChangeSets

listExports

listImports

listStackInstances

listStackResources

listStackSetOperationResults

listStackSetOperations

listStackSets

listStacks

listStacks

listTypeRegistrations

listTypeVersions

listTypes

publishType

recordHandlerProgress

registerPublisher

registerType

rollbackStack

setStackPolicy

setTypeConfiguration

setTypeDefaultVersion

signalResource

stopStackSetOperation

testType

updateStack

updateStackInstances

updateStackSet

updateTerminationProtection

validateTemplate

shutdown