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
.Modifier and Type | Method and Description |
---|---|
void |
cancelUpdateStack(CancelUpdateStackRequest request)
Cancels an update on the specified stack.
|
CreateStackResult |
createStack(CreateStackRequest request)
Creates a stack as specified in the template.
|
void |
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.
|
DescribeStackEventsResult |
describeStackEvents(DescribeStackEventsRequest request)
Returns all stack related events for a specified stack.
|
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.
|
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.
|
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. |
void |
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.
|
void |
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.
|
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 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 void 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.
cancelUpdateStack
in interface AmazonCloudFormation
request
- The input for the CancelUpdateStack 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 void 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 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.
describeAccountLimits
in interface AmazonCloudFormation
request
- The input for the DescribeAccountLimits action.public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest request)
AmazonCloudFormation
Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
describeStackEvents
in interface AmazonCloudFormation
request
- The input for DescribeStackEvents action.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 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.
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.
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 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.
describeStacks
in interface AmazonCloudFormation
request
- The input for DescribeStacks action.public DescribeStacksResult describeStacks()
AmazonCloudFormation
describeStacks
in interface AmazonCloudFormation
AmazonCloudFormation.describeStacks(DescribeStacksRequest)
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
public EstimateTemplateCostResult estimateTemplateCost()
AmazonCloudFormation
estimateTemplateCost
in interface AmazonCloudFormation
AmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)
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.
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.
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 AmazonCloudFormation
request
- The input for the GetTemplateSummary action.public GetTemplateSummaryResult getTemplateSummary()
AmazonCloudFormation
getTemplateSummary
in interface AmazonCloudFormation
AmazonCloudFormation.getTemplateSummary(GetTemplateSummaryRequest)
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 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 void setStackPolicy(SetStackPolicyRequest request)
AmazonCloudFormation
Sets a stack policy for a specified stack.
setStackPolicy
in interface AmazonCloudFormation
request
- The input for the SetStackPolicy action.public void 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 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.
Tags that were associated with this stack during creation time will still
be associated with the stack after an UpdateStack
operation.
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 UpdateStack action.public ValidateTemplateResult validateTemplate(ValidateTemplateRequest request)
AmazonCloudFormation
Validates a specified template.
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.