@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudFormation
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudFormation instead.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ActivateOrganizationsAccessResult |
activateOrganizationsAccess(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest)
Activate trusted access with Organizations.
|
ActivateTypeResult |
activateType(ActivateTypeRequest activateTypeRequest)
Activates a public third-party extension, making it available for use in stack templates.
|
BatchDescribeTypeConfigurationsResult |
batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the
account and Region.
|
CancelUpdateStackResult |
cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
ContinueUpdateRollbackResult |
continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
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 createChangeSetRequest)
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 createStackRequest)
Creates a stack as specified in the template.
|
CreateStackInstancesResult |
createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
|
CreateStackSetResult |
createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
|
DeactivateOrganizationsAccessResult |
deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest)
Deactivates trusted access with Organizations.
|
DeactivateTypeResult |
deactivateType(DeactivateTypeRequest deactivateTypeRequest)
Deactivates a public extension that was previously activated in this account and Region.
|
DeleteChangeSetResult |
deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
DeleteStackResult |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
DeleteStackInstancesResult |
deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
|
DeleteStackSetResult |
deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set.
|
DeregisterTypeResult |
deregisterType(DeregisterTypeRequest deregisterTypeRequest)
Marks an extension or extension version as
DEPRECATED in the CloudFormation registry, removing it
from active use. |
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
DescribeChangeSetResult |
describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
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 describeChangeSetHooksRequest)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run
the change set.
|
DescribeOrganizationsAccessResult |
describeOrganizationsAccess(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest)
Retrieves information about the account's
OrganizationAccess status. |
DescribePublisherResult |
describePublisher(DescribePublisherRequest describePublisherRequest)
Returns information about a CloudFormation extension publisher.
|
DescribeStackDriftDetectionStatusResult |
describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest)
Returns information about a stack drift detection operation.
|
DescribeStackEventsResult |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
DescribeStackInstanceResult |
describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon
Web Services Region.
|
DescribeStackResourceResult |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
DescribeStackResourceDriftsResult |
describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
DescribeStackResourcesResult |
describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns Amazon Web Services resource descriptions for running and deleted stacks.
|
DescribeStacksResult |
describeStacks()
Simplified method form for invoking the DescribeStacks operation.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest describeStacksRequest)
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 describeStackSetRequest)
Returns the description of the specified StackSet.
|
DescribeStackSetOperationResult |
describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified StackSet operation.
|
DescribeTypeResult |
describeType(DescribeTypeRequest describeTypeRequest)
Returns detailed information about an extension that has been registered.
|
DescribeTypeRegistrationResult |
describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)
Returns information about an extension's registration, including its current status and type and version
identifiers.
|
DetectStackDriftResult |
detectStackDrift(DetectStackDriftRequest detectStackDriftRequest)
Detects whether a 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.
|
DetectStackResourceDriftResult |
detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest)
Returns information about whether a resource's actual configuration differs, or has drifted, from its
expected configuration, as defined in the stack template and any values specified as template parameters.
|
DetectStackSetDriftResult |
detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest)
Detect drift on a stack set.
|
EstimateTemplateCostResult |
estimateTemplateCost()
Simplified method form for invoking the EstimateTemplateCost operation.
|
EstimateTemplateCostResult |
estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
ExecuteChangeSetResult |
executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
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 getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
GetTemplateResult |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
GetTemplateSummaryResult |
getTemplateSummary()
Simplified method form for invoking the GetTemplateSummary operation.
|
GetTemplateSummaryResult |
getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
ImportStacksToStackSetResult |
importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest)
Import existing stacks into a new stack sets.
|
ListChangeSetsResult |
listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
ListExportsResult |
listExports(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
ListImportsResult |
listImports(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
ListStackInstanceResourceDriftsResult |
listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest)
Returns drift information for resources in a stack instance.
|
ListStackInstancesResult |
listStackInstances(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
ListStackResourcesResult |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
ListStacksResult |
listStacks()
Simplified method form for invoking the ListStacks operation.
|
ListStacksResult |
listStacks(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
ListStackSetOperationResultsResult |
listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
ListStackSetOperationsResult |
listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
ListStackSetsResult |
listStackSets(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
ListTypeRegistrationsResult |
listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
ListTypesResult |
listTypes(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
ListTypeVersionsResult |
listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
PublishTypeResult |
publishType(PublishTypeRequest publishTypeRequest)
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
|
RecordHandlerProgressResult |
recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
|
RegisterPublisherResult |
registerPublisher(RegisterPublisherRequest registerPublisherRequest)
Registers your account as a publisher of public extensions in the CloudFormation registry.
|
RegisterTypeResult |
registerType(RegisterTypeRequest registerTypeRequest)
Registers an extension with the CloudFormation service.
|
RollbackStackResult |
rollbackStack(RollbackStackRequest rollbackStackRequest)
When specifying
RollbackStack, you preserve the state of previously provisioned resources when an
operation fails. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetStackPolicyResult |
setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
SetTypeConfigurationResult |
setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest)
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
|
SetTypeDefaultVersionResult |
setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest)
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 signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
StopStackSetOperationResult |
stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
TestTypeResult |
testType(TestTypeRequest testTypeRequest)
Tests a registered extension to make sure it meets all necessary requirements for being published in the
CloudFormation registry.
|
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
UpdateStackInstancesResult |
updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest)
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web
Services Regions.
|
UpdateStackSetResult |
updateStackSet(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
|
UpdateTerminationProtectionResult |
updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
ValidateTemplateResult |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
AmazonCloudFormationWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)ActivateOrganizationsAccessResult activateOrganizationsAccess(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest)
Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
activateOrganizationsAccessRequest - InvalidOperationException - The specified operation isn't valid.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.ActivateTypeResult activateType(ActivateTypeRequest activateTypeRequest)
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.
activateTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.BatchDescribeTypeConfigurationsResult batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest)
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.
batchDescribeTypeConfigurationsRequest - TypeConfigurationNotFoundException - The specified extension configuration can't be found.CFNRegistryException - An error occurred during a CloudFormation registry operation.CancelUpdateStackResult cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
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.
cancelUpdateStackRequest - The input for the CancelUpdateStack action.TokenAlreadyExistsException - A client request token already exists.ContinueUpdateRollbackResult continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
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.
continueUpdateRollbackRequest - The input for the ContinueUpdateRollback action.TokenAlreadyExistsException - A client request token already exists.CreateChangeSetResult createChangeSet(CreateChangeSetRequest createChangeSetRequest)
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.
createChangeSetRequest - The input for the CreateChangeSet action.AlreadyExistsException - The resource with the name requested already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.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.
CreateStackResult createStack(CreateStackRequest createStackRequest)
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 DescribeStacks operation.
createStackRequest - The input for CreateStack action.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.
AlreadyExistsException - The resource with the name requested already exists.TokenAlreadyExistsException - A client request token already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.CreateStackInstancesResult createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
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.
createStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.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.
CreateStackSetResult createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
createStackSetRequest - NameAlreadyExistsException - The specified name is already in use.CreatedButModifiedException - The specified resource exists, but has been changed.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.
DeactivateOrganizationsAccessResult deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest)
Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
deactivateOrganizationsAccessRequest - InvalidOperationException - The specified operation isn't valid.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.DeactivateTypeResult deactivateType(DeactivateTypeRequest deactivateTypeRequest)
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.
deactivateTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
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.
deleteChangeSetRequest - The input for the DeleteChangeSet action.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.DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
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.
deleteStackRequest - The input for DeleteStack action.TokenAlreadyExistsException - A client request token already exists.DeleteStackInstancesResult deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
deleteStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.DeleteStackSetResult deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
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.
deleteStackSetRequest - 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.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.DeregisterTypeResult deregisterType(DeregisterTypeRequest deregisterTypeRequest)
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.
deregisterTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
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.
describeAccountLimitsRequest - The input for the DescribeAccountLimits action.DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
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.
describeChangeSetRequest - The input for the DescribeChangeSet action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets operation.DescribeChangeSetHooksResult describeChangeSetHooks(DescribeChangeSetHooksRequest describeChangeSetHooksRequest)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
describeChangeSetHooksRequest - ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets operation.DescribeOrganizationsAccessResult describeOrganizationsAccess(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest)
Retrieves information about the account's OrganizationAccess status. This API can be called either
by the management account or the delegated administrator by using the CallAs parameter. This API can
also be called without the CallAs parameter by the management account.
describeOrganizationsAccessRequest - InvalidOperationException - The specified operation isn't valid.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.DescribePublisherResult describePublisher(DescribePublisherRequest describePublisherRequest)
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:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
describePublisherRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.DescribeStackDriftDetectionStatusResult describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest)
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 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. 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.
describeStackDriftDetectionStatusRequest - DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
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).
describeStackEventsRequest - The input for DescribeStackEvents action.DescribeStackInstanceResult describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
describeStackInstanceRequest - StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
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.
describeStackResourceRequest - The input for DescribeStackResource action.DescribeStackResourceDriftsResult describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
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.
describeStackResourceDriftsRequest - DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
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.
describeStackResourcesRequest - The input for DescribeStackResources action.DescribeStackSetResult describeStackSet(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified StackSet.
describeStackSetRequest - StackSetNotFoundException - The specified stack set doesn't exist.DescribeStackSetOperationResult describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified StackSet operation.
describeStackSetOperationRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
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.
describeStacksRequest - The input for DescribeStacks action.DescribeStacksResult describeStacks()
describeStacks(DescribeStacksRequest)DescribeTypeResult describeType(DescribeTypeRequest describeTypeRequest)
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.
describeTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.DescribeTypeRegistrationResult describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)
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.
describeTypeRegistrationRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.DetectStackDriftResult detectStackDrift(DetectStackDriftRequest detectStackDriftRequest)
Detects whether a 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. 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.
detectStackDriftRequest - DetectStackResourceDriftResult detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest)
Returns information about whether a resource's actual configuration differs, or has drifted, from its 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.
detectStackResourceDriftRequest - DetectStackSetDriftResult detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest)
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.
detectStackSetDriftRequest - InvalidOperationException - The specified operation isn't valid.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.StackSetNotFoundException - The specified stack set doesn't exist.EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
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.
estimateTemplateCostRequest - The input for an EstimateTemplateCost action.EstimateTemplateCostResult estimateTemplateCost()
ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
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.
executeChangeSetRequest - The input for the ExecuteChangeSet action.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.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets operation.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.GetStackPolicyResult getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest - The input for the GetStackPolicy action.GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
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.
getTemplateRequest - The input for a GetTemplate action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets operation.GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
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.
getTemplateSummaryRequest - The input for the GetTemplateSummary action.StackSetNotFoundException - The specified stack set doesn't exist.GetTemplateSummaryResult getTemplateSummary()
ImportStacksToStackSetResult importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest)
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.
importStacksToStackSetRequest - 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.
StackSetNotFoundException - The specified stack set doesn't exist.InvalidOperationException - The specified operation isn't valid.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StackNotFoundException - The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.ListChangeSetsResult listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
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.
listChangeSetsRequest - The input for the ListChangeSets action.ListExportsResult listExports(ListExportsRequest listExportsRequest)
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.
listExportsRequest - ListImportsResult listImports(ListImportsRequest listImportsRequest)
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.
listImportsRequest - ListStackInstanceResourceDriftsResult listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest)
Returns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts returns drift information for the most recent drift detection
operation. If an operation is in progress, it may only return partial results.
listStackInstanceResourceDriftsRequest - StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.ListStackInstancesResult listStackInstances(ListStackInstancesRequest listStackInstancesRequest)
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.
listStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.ListStackResourcesResult listStackResources(ListStackResourcesRequest listStackResourcesRequest)
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.
listStackResourcesRequest - The input for the ListStackResource action.ListStackSetOperationResultsResult listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.ListStackSetOperationsResult listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest - StackSetNotFoundException - The specified stack set doesn't exist.ListStackSetsResult listStackSets(ListStackSetsRequest listStackSetsRequest)
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.
listStackSetsRequest - ListStacksResult listStacks(ListStacksRequest listStacksRequest)
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).
listStacksRequest - The input for ListStacks action.ListStacksResult listStacks()
listStacks(ListStacksRequest)ListTypeRegistrationsResult listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
listTypeRegistrationsRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.ListTypeVersionsResult listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
listTypeVersionsRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.ListTypesResult listTypes(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
listTypesRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.PublishTypeResult publishType(PublishTypeRequest publishTypeRequest)
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.
publishTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.RecordHandlerProgressResult recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
recordHandlerProgressRequest - InvalidStateTransitionException - Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.OperationStatusCheckFailedException - Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.RegisterPublisherResult registerPublisher(RegisterPublisherRequest registerPublisherRequest)
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.
registerPublisherRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.RegisterTypeResult registerType(RegisterTypeRequest registerTypeRequest)
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.
registerTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.RollbackStackResult rollbackStack(RollbackStackRequest rollbackStackRequest)
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
rollbackStackRequest - TokenAlreadyExistsException - A client request token already exists.SetStackPolicyResult setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicyRequest - The input for the SetStackPolicy action.SetTypeConfigurationResult setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest)
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.
setTypeConfigurationRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.SetTypeDefaultVersionResult setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest)
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.SignalResourceResult signalResource(SignalResourceRequest signalResourceRequest)
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.
signalResourceRequest - The input for the SignalResource action.StopStackSetOperationResult stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
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.
stopStackSetOperationRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.InvalidOperationException - The specified operation isn't valid.TestTypeResult testType(TestTypeRequest testTypeRequest)
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 pass the returned
TypeVersionArn into 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.
testTypeRequest - CFNRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension doesn't exist in the CloudFormation registry.UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
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.
updateStackRequest - The input for an UpdateStack action.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.UpdateStackInstancesResult updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest)
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.
updateStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.UpdateStackSetResult updateStackSet(UpdateStackSetRequest updateStackSetRequest)
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.
updateStackSetRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.StackInstanceNotFoundException - The specified stack instance doesn't exist.UpdateTerminationProtectionResult updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
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.
updateTerminationProtectionRequest - ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)
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.
validateTemplateRequest - The input for ValidateTemplate action.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AmazonCloudFormationWaiters waiters()