@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudFormation extends Object implements AmazonCloudFormation
AmazonCloudFormation
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CancelUpdateStackResult |
cancelUpdateStack(CancelUpdateStackRequest request)
Cancels an update on the specified stack.
|
ContinueUpdateRollbackResult |
continueUpdateRollback(ContinueUpdateRollbackRequest request)
For a specified stack that is 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 Regions.
|
CreateStackSetResult |
createStackSet(CreateStackSetRequest request)
Creates a stack set.
|
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 Regions.
|
DeleteStackSetResult |
deleteStackSet(DeleteStackSetRequest request)
Deletes a stack set.
|
DeregisterTypeResult |
deregisterType(DeregisterTypeRequest request)
Removes a type or type version from active use in the CloudFormation registry.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest request)
Retrieves your account's AWS 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 AWS CloudFormation will make if you execute the
change set.
|
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, AWS 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 AWS 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 a type that has been registered.
|
DescribeTypeRegistrationResult |
describeTypeRegistration(DescribeTypeRegistrationRequest request)
Returns information about a type'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.
|
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 type(s).
|
ListTypesResult |
listTypes(ListTypesRequest request)
Returns summary information about types that have been registered with CloudFormation.
|
ListTypeVersionsResult |
listTypeVersions(ListTypeVersionsRequest request)
Returns summary information about the versions of a type.
|
RecordHandlerProgressResult |
recordHandlerProgress(RecordHandlerProgressRequest request)
Reports progress of a resource handler to CloudFormation.
|
RegisterTypeResult |
registerType(RegisterTypeRequest request)
Registers a type with the CloudFormation service.
|
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.
|
SetTypeDefaultVersionResult |
setTypeDefaultVersion(SetTypeDefaultVersionRequest request)
Specify the default version of a type.
|
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.
|
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 Regions.
|
UpdateStackSetResult |
updateStackSet(UpdateStackSetRequest request)
Updates the stack set, and associated stack instances in the specified accounts and Regions.
|
UpdateTerminationProtectionResult |
updateTerminationProtection(UpdateTerminationProtectionRequest request)
Updates termination protection for the specified stack.
|
ValidateTemplateResult |
validateTemplate(ValidateTemplateRequest request)
Validates a specified template.
|
AmazonCloudFormationWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonCloudFormation
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.
setEndpoint
in interface AmazonCloudFormation
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.public void setRegion(Region region)
AmazonCloudFormation
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.
setRegion
in interface AmazonCloudFormation
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)
public CancelUpdateStackResult cancelUpdateStack(CancelUpdateStackRequest request)
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.
cancelUpdateStack
in interface AmazonCloudFormation
request
- The input for the CancelUpdateStack action.public ContinueUpdateRollbackResult continueUpdateRollback(ContinueUpdateRollbackRequest request)
AmazonCloudFormation
For a specified stack that is in the UPDATE_ROLLBACK_FAILED
state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE
state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working
state (the UPDATE_ROLLBACK_COMPLETE
state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED
state when AWS CloudFormation cannot roll back all
changes after a failed stack update. For example, you might have a stack that is rolling back to an old database
instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was
deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
rollback to fail.
continueUpdateRollback
in interface AmazonCloudFormation
request
- The input for the ContinueUpdateRollback action.public CreateChangeSetResult createChangeSet(CreateChangeSetRequest request)
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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the ChangeSetType
parameter, specify
CREATE
. To create a change set for an existing stack, specify UPDATE
for the
ChangeSetType
parameter. To create a change set for an import operation, specify IMPORT
for the ChangeSetType
parameter. After the CreateChangeSet
call successfully completes,
AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
createChangeSet
in interface AmazonCloudFormation
request
- The input for the CreateChangeSet action.public CreateStackResult createStack(CreateStackRequest request)
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 via the DescribeStacks API.
createStack
in interface AmazonCloudFormation
request
- The input for CreateStack action.public CreateStackInstancesResult createStackInstances(CreateStackInstancesRequest request)
AmazonCloudFormation
Creates stack instances for the specified accounts, within the specified 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
.
createStackInstances
in interface AmazonCloudFormation
public CreateStackSetResult createStackSet(CreateStackSetRequest request)
AmazonCloudFormation
Creates a stack set.
createStackSet
in interface AmazonCloudFormation
public DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest request)
AmazonCloudFormation
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
deleteChangeSet
in interface AmazonCloudFormation
request
- The input for the DeleteChangeSet action.public DeleteStackResult deleteStack(DeleteStackRequest request)
AmazonCloudFormation
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
deleteStack
in interface AmazonCloudFormation
request
- The input for DeleteStack action.public DeleteStackInstancesResult deleteStackInstances(DeleteStackInstancesRequest request)
AmazonCloudFormation
Deletes stack instances for the specified accounts, in the specified Regions.
deleteStackInstances
in interface AmazonCloudFormation
public DeleteStackSetResult deleteStackSet(DeleteStackSetRequest request)
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.
deleteStackSet
in interface AmazonCloudFormation
public DeregisterTypeResult deregisterType(DeregisterTypeRequest request)
AmazonCloudFormation
Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations.
To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered.
You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.
deregisterType
in interface AmazonCloudFormation
public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
AmazonCloudFormation
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
describeAccountLimits
in interface AmazonCloudFormation
request
- The input for the DescribeAccountLimits action.public DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest request)
AmazonCloudFormation
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
describeChangeSet
in interface AmazonCloudFormation
request
- The input for the DescribeChangeSet action.public DescribeStackDriftDetectionStatusResult describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest request)
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.
describeStackDriftDetectionStatus
in interface AmazonCloudFormation
public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest request)
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 AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
describeStackEvents
in interface AmazonCloudFormation
request
- The input for DescribeStackEvents action.public DescribeStackInstanceResult describeStackInstance(DescribeStackInstanceRequest request)
AmazonCloudFormation
Returns the stack instance that's associated with the specified stack set, AWS account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
describeStackInstance
in interface AmazonCloudFormation
public DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest request)
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.
describeStackResource
in interface AmazonCloudFormation
request
- The input for DescribeStackResource action.public DescribeStackResourceDriftsResult describeStackResourceDrifts(DescribeStackResourceDriftsRequest request)
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 AWS 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 have not yet been checked for drift are not included. Resources that do not
currently support drift detection are not 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.
describeStackResourceDrifts
in interface AmazonCloudFormation
public DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest request)
AmazonCloudFormation
Returns AWS resource descriptions for running and deleted stacks. If StackName
is specified, all the
associated resources that are part of the stack are returned. If PhysicalResourceId
is specified,
the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use
ListStackResources
instead.
For deleted stacks, DescribeStackResources
returns resource information for up to 90 days after the
stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not both. In addition, you
can specify LogicalResourceId
to filter the returned result. For more information about resources,
the LogicalResourceId
and PhysicalResourceId
, go to the AWS CloudFormation User Guide.
A ValidationError
is returned if you specify both StackName
and
PhysicalResourceId
in the same request.
describeStackResources
in interface AmazonCloudFormation
request
- The input for DescribeStackResources action.public DescribeStackSetResult describeStackSet(DescribeStackSetRequest request)
AmazonCloudFormation
Returns the description of the specified stack set.
describeStackSet
in interface AmazonCloudFormation
public DescribeStackSetOperationResult describeStackSetOperation(DescribeStackSetOperationRequest request)
AmazonCloudFormation
Returns the description of the specified stack set operation.
describeStackSetOperation
in interface AmazonCloudFormation
public DescribeStacksResult describeStacks(DescribeStacksRequest request)
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 does not exist, an AmazonCloudFormationException
is returned.
describeStacks
in interface AmazonCloudFormation
request
- The input for DescribeStacks action.public DescribeStacksResult describeStacks()
AmazonCloudFormation
describeStacks
in interface AmazonCloudFormation
AmazonCloudFormation.describeStacks(DescribeStacksRequest)
public DescribeTypeResult describeType(DescribeTypeRequest request)
AmazonCloudFormation
Returns detailed information about a type that has been registered.
If you specify a VersionId
, DescribeType
returns information about that specific type
version. Otherwise, it returns information about the default type version.
describeType
in interface AmazonCloudFormation
public DescribeTypeRegistrationResult describeTypeRegistration(DescribeTypeRegistrationRequest request)
AmazonCloudFormation
Returns information about a type'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
informaiton about a type.
describeTypeRegistration
in interface AmazonCloudFormation
public DetectStackDriftResult detectStackDrift(DetectStackDriftRequest request)
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, AWS 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, AWS CloudFormation does not detect drift on any nested stacks belonging to that
stack. Perform DetectStackDrift
directly on the nested stack itself.
detectStackDrift
in interface AmazonCloudFormation
public DetectStackResourceDriftResult detectStackResourceDrift(DetectStackResourceDriftRequest request)
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 AWS 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 do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
detectStackResourceDrift
in interface AmazonCloudFormation
public DetectStackSetDriftResult detectStackSetDrift(DetectStackSetDriftRequest request)
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, as well as 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 informaiton 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 is not 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
.
detectStackSetDrift
in interface AmazonCloudFormation
public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest request)
AmazonCloudFormation
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
estimateTemplateCost
in interface AmazonCloudFormation
request
- The input for an EstimateTemplateCost action.public EstimateTemplateCostResult estimateTemplateCost()
AmazonCloudFormation
estimateTemplateCost
in interface AmazonCloudFormation
AmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)
public ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest request)
AmazonCloudFormation
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
executeChangeSet
in interface AmazonCloudFormation
request
- The input for the ExecuteChangeSet action.public GetStackPolicyResult getStackPolicy(GetStackPolicyRequest request)
AmazonCloudFormation
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicy
in interface AmazonCloudFormation
request
- The input for the GetStackPolicy action.public GetTemplateResult getTemplate(GetTemplateRequest request)
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 does not exist, a ValidationError
is returned.
getTemplate
in interface AmazonCloudFormation
request
- The input for a GetTemplate action.public GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest request)
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 does not exist, a ValidationError
is returned.
getTemplateSummary
in interface AmazonCloudFormation
request
- The input for the GetTemplateSummary action.public GetTemplateSummaryResult getTemplateSummary()
AmazonCloudFormation
getTemplateSummary
in interface AmazonCloudFormation
AmazonCloudFormation.getTemplateSummary(GetTemplateSummaryRequest)
public ListChangeSetsResult listChangeSets(ListChangeSetsRequest request)
AmazonCloudFormation
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change
sets that are in the CREATE_IN_PROGRESS
or CREATE_PENDING
state.
listChangeSets
in interface AmazonCloudFormation
request
- The input for the ListChangeSets action.public ListExportsResult listExports(ListExportsRequest request)
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 AWS CloudFormation Export Stack Output Values.
listExports
in interface AmazonCloudFormation
public ListImportsResult listImports(ListImportsRequest request)
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.
listImports
in interface AmazonCloudFormation
public ListStackInstancesResult listStackInstances(ListStackInstancesRequest request)
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 AWS account name or Region, or that have a specific status.
listStackInstances
in interface AmazonCloudFormation
public ListStackResourcesResult listStackResources(ListStackResourcesRequest request)
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.
listStackResources
in interface AmazonCloudFormation
request
- The input for the ListStackResource action.public ListStackSetOperationResultsResult listStackSetOperationResults(ListStackSetOperationResultsRequest request)
AmazonCloudFormation
Returns summary information about the results of a stack set operation.
listStackSetOperationResults
in interface AmazonCloudFormation
public ListStackSetOperationsResult listStackSetOperations(ListStackSetOperationsRequest request)
AmazonCloudFormation
Returns summary information about operations performed on a stack set.
listStackSetOperations
in interface AmazonCloudFormation
public ListStackSetsResult listStackSets(ListStackSetsRequest request)
AmazonCloudFormation
Returns summary information about stack sets that are associated with the user.
listStackSets
in interface AmazonCloudFormation
public ListStacksResult listStacks(ListStacksRequest request)
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).
listStacks
in interface AmazonCloudFormation
request
- The input for ListStacks action.public ListStacksResult listStacks()
AmazonCloudFormation
listStacks
in interface AmazonCloudFormation
AmazonCloudFormation.listStacks(ListStacksRequest)
public ListTypeRegistrationsResult listTypeRegistrations(ListTypeRegistrationsRequest request)
AmazonCloudFormation
Returns a list of registration tokens for the specified type(s).
listTypeRegistrations
in interface AmazonCloudFormation
public ListTypeVersionsResult listTypeVersions(ListTypeVersionsRequest request)
AmazonCloudFormation
Returns summary information about the versions of a type.
listTypeVersions
in interface AmazonCloudFormation
public ListTypesResult listTypes(ListTypesRequest request)
AmazonCloudFormation
Returns summary information about types that have been registered with CloudFormation.
listTypes
in interface AmazonCloudFormation
public RecordHandlerProgressResult recordHandlerProgress(RecordHandlerProgressRequest request)
AmazonCloudFormation
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Do not use this API in your code.
recordHandlerProgress
in interface AmazonCloudFormation
public RegisterTypeResult registerType(RegisterTypeRequest request)
AmazonCloudFormation
Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:
Validating the resource schema
Determining which handlers have been specified for the resource
Making the resource type available for use in your account
For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific resource type versions if necessary.
Once you have initiated a registration request using RegisterType
, you can use
DescribeTypeRegistration
to monitor the progress of the registration request.
registerType
in interface AmazonCloudFormation
public SetStackPolicyResult setStackPolicy(SetStackPolicyRequest request)
AmazonCloudFormation
Sets a stack policy for a specified stack.
setStackPolicy
in interface AmazonCloudFormation
request
- The input for the SetStackPolicy action.public SetTypeDefaultVersionResult setTypeDefaultVersion(SetTypeDefaultVersionRequest request)
AmazonCloudFormation
Specify the default version of a type. The default version of a type will be used in CloudFormation operations.
setTypeDefaultVersion
in interface AmazonCloudFormation
public SignalResourceResult signalResource(SignalResourceRequest request)
AmazonCloudFormation
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
signalResource
in interface AmazonCloudFormation
request
- The input for the SignalResource action.public StopStackSetOperationResult stopStackSetOperation(StopStackSetOperationRequest request)
AmazonCloudFormation
Stops an in-progress operation on a stack set and its associated stack instances.
stopStackSetOperation
in interface AmazonCloudFormation
public UpdateStackResult updateStack(UpdateStackRequest request)
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 via 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.
updateStack
in interface AmazonCloudFormation
request
- The input for an UpdateStack action.public UpdateStackInstancesResult updateStackInstances(UpdateStackInstancesRequest request)
AmazonCloudFormation
Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in 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 are not 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
.
updateStackInstances
in interface AmazonCloudFormation
public UpdateStackSetResult updateStackSet(UpdateStackSetRequest request)
AmazonCloudFormation
Updates the stack set, and associated stack instances in the specified accounts and 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.
updateStackSet
in interface AmazonCloudFormation
public UpdateTerminationProtectionResult updateTerminationProtection(UpdateTerminationProtectionRequest request)
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 AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
updateTerminationProtection
in interface AmazonCloudFormation
public ValidateTemplateResult validateTemplate(ValidateTemplateRequest request)
AmazonCloudFormation
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
validateTemplate
in interface AmazonCloudFormation
request
- The input for ValidateTemplate action.public void shutdown()
AmazonCloudFormation
shutdown
in interface AmazonCloudFormation
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudFormation
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.
getCachedResponseMetadata
in interface AmazonCloudFormation
request
- The originally executed request.public AmazonCloudFormationWaiters waiters()
waiters
in interface AmazonCloudFormation