@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 for a stack.
|
CreateStackResult |
createStack(CreateStackRequest request)
Creates a stack as specified in the template.
|
DeleteChangeSetResult |
deleteChangeSet(DeleteChangeSetRequest request)
Deletes the specified change set.
|
DeleteStackResult |
deleteStack(DeleteStackRequest request)
Deletes a specified stack.
|
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.
|
DescribeStackEventsResult |
describeStackEvents(DescribeStackEventsRequest request)
Returns all stack related events for a specified stack in reverse chronological order.
|
DescribeStackResourceResult |
describeStackResource(DescribeStackResourceRequest request)
Returns a description of the specified resource 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.
|
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.
|
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.
|
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.
|
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.
|
UpdateStackResult |
updateStack(UpdateStackRequest request)
Updates a stack as specified in the template.
|
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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 AmazonCloudFormationendpoint - 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)
AmazonCloudFormationAmazonCloudFormation.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 AmazonCloudFormationregion - 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)
AmazonCloudFormationCancels 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 AmazonCloudFormationrequest - 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 AmazonCloudFormationrequest - The input for the ContinueUpdateRollback action.public CreateChangeSetResult createChangeSet(CreateChangeSetRequest request)
AmazonCloudFormationCreates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.
AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.
After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.
createChangeSet in interface AmazonCloudFormationrequest - The input for the CreateChangeSet action.public CreateStackResult createStack(CreateStackRequest request)
AmazonCloudFormationCreates 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 AmazonCloudFormationrequest - The input for CreateStack action.public DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest request)
AmazonCloudFormationDeletes 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 AmazonCloudFormationrequest - The input for the DeleteChangeSet action.public DeleteStackResult deleteStack(DeleteStackRequest request)
AmazonCloudFormationDeletes 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 AmazonCloudFormationrequest - The input for DeleteStack action.public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
AmazonCloudFormationRetrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
describeAccountLimits in interface AmazonCloudFormationrequest - The input for the DescribeAccountLimits action.public DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for the DescribeChangeSet action.public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for DescribeStackEvents action.public DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for DescribeStackResource action.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 AmazonCloudFormationrequest - The input for DescribeStackResources action.public DescribeStacksResult describeStacks(DescribeStacksRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for DescribeStacks action.public DescribeStacksResult describeStacks()
AmazonCloudFormationdescribeStacks in interface AmazonCloudFormationAmazonCloudFormation.describeStacks(DescribeStacksRequest)public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for an EstimateTemplateCost action.public EstimateTemplateCostResult estimateTemplateCost()
AmazonCloudFormationestimateTemplateCost in interface AmazonCloudFormationAmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)public ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest request)
AmazonCloudFormationUpdates 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 AmazonCloudFormationrequest - The input for the ExecuteChangeSet action.public GetStackPolicyResult getStackPolicy(GetStackPolicyRequest request)
AmazonCloudFormationReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicy in interface AmazonCloudFormationrequest - The input for the GetStackPolicy action.public GetTemplateResult getTemplate(GetTemplateRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - 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.
You can use the GetTemplateSummary action when you submit a template, or you can get template
information for 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 AmazonCloudFormationrequest - The input for the GetTemplateSummary action.public GetTemplateSummaryResult getTemplateSummary()
AmazonCloudFormationgetTemplateSummary in interface AmazonCloudFormationAmazonCloudFormation.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 AmazonCloudFormationrequest - 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 AmazonCloudFormationpublic ListImportsResult listImports(ListImportsRequest request)
AmazonCloudFormationLists 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 AmazonCloudFormationpublic ListStackResourcesResult listStackResources(ListStackResourcesRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for the ListStackResource action.public ListStacksResult listStacks(ListStacksRequest request)
AmazonCloudFormationReturns 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 AmazonCloudFormationrequest - The input for ListStacks action.public ListStacksResult listStacks()
AmazonCloudFormationlistStacks in interface AmazonCloudFormationAmazonCloudFormation.listStacks(ListStacksRequest)public SetStackPolicyResult setStackPolicy(SetStackPolicyRequest request)
AmazonCloudFormationSets a stack policy for a specified stack.
setStackPolicy in interface AmazonCloudFormationrequest - The input for the SetStackPolicy action.public SignalResourceResult signalResource(SignalResourceRequest request)
AmazonCloudFormationSends 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 AmazonCloudFormationrequest - The input for the SignalResource action.public UpdateStackResult updateStack(UpdateStackRequest request)
AmazonCloudFormationUpdates 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 AmazonCloudFormationrequest - The input for an UpdateStack action.public ValidateTemplateResult validateTemplate(ValidateTemplateRequest request)
AmazonCloudFormationValidates 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 AmazonCloudFormationrequest - The input for ValidateTemplate action.public void shutdown()
AmazonCloudFormationshutdown in interface AmazonCloudFormationpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudFormationResponse 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 AmazonCloudFormationrequest - The originally executed request.public AmazonCloudFormationWaiters waiters()
waiters in interface AmazonCloudFormationCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.