public class AmazonCloudFormationClient extends AmazonWebServiceClient implements AmazonCloudFormation
AWS CloudFormation
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about this product, go to the CloudFormation Product Page .
Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/ .
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonCloudFormation exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonCloudFormationClient()
Constructs a new client to invoke service methods on
AmazonCloudFormation.
|
AmazonCloudFormationClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCloudFormation using the specified AWS account credentials.
|
AmazonCloudFormationClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudFormation using the specified AWS account credentials
and client configuration options.
|
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCloudFormation using the specified AWS account credentials provider.
|
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudFormation using the specified AWS account credentials
provider and client configuration options.
|
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonCloudFormation using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonCloudFormationClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCloudFormation.
|
Modifier and Type | Method and Description |
---|---|
void |
cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
CreateStackResult |
createStack(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
void |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
DescribeStackEventsResult |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack.
|
DescribeStackResourceResult |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified
stack.
|
DescribeStackResourcesResult |
describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
DescribeStacksResult |
describeStacks()
Returns the description for the specified stack; if no stack name was
specified, then it returns the description for all the stacks created.
|
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.
|
EstimateTemplateCostResult |
estimateTemplateCost()
Returns the estimated monthly cost of a template.
|
EstimateTemplateCostResult |
estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
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 getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
GetTemplateResult |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
ListStackResourcesResult |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
ListStacksResult |
listStacks()
Returns the summary information for stacks whose status matches the
specified StackStatusFilter.
|
ListStacksResult |
listStacks(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the
specified StackStatusFilter.
|
void |
setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
ValidateTemplateResult |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonCloudFormationClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonCloudFormationClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonCloudFormation
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonCloudFormationClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonCloudFormationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonCloudFormation
(ex: proxy settings, retry counts, etc.).public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonCloudFormation
(ex: proxy settings, retry counts, etc.).public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonCloudFormation
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
validateTemplate
in interface AmazonCloudFormation
validateTemplateRequest
- Container for the necessary parameters
to execute the ValidateTemplate service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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.
describeStacks
in interface AmazonCloudFormation
describeStacksRequest
- Container for the necessary parameters to
execute the DescribeStacks service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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.
NOTE: If the template does not exist, a ValidationError is returned.
getTemplate
in interface AmazonCloudFormation
getTemplateRequest
- Container for the necessary parameters to
execute the GetTemplate service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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.
getStackPolicy
in interface AmazonCloudFormation
getStackPolicyRequest
- Container for the necessary parameters to
execute the GetStackPolicy service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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).
listStacks
in interface AmazonCloudFormation
listStacksRequest
- Container for the necessary parameters to
execute the ListStacks service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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 via the DescribeStacks API.
createStack
in interface AmazonCloudFormation
createStackRequest
- Container for the necessary parameters to
execute the CreateStack service method on AmazonCloudFormation.AlreadyExistsException
LimitExceededException
InsufficientCapabilitiesException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public void setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicy
in interface AmazonCloudFormation
setStackPolicyRequest
- Container for the necessary parameters to
execute the SetStackPolicy service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
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
estimateTemplateCostRequest
- Container for the necessary
parameters to execute the EstimateTemplateCost service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
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.
NOTE: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
describeStackEventsRequest
- Container for the necessary
parameters to execute the DescribeStackEvents service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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.
describeStackResource
in interface AmazonCloudFormation
describeStackResourceRequest
- Container for the necessary
parameters to execute the DescribeStackResource service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public void cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.
NOTE:Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.
cancelUpdateStack
in interface AmazonCloudFormation
cancelUpdateStackRequest
- Container for the necessary parameters
to execute the CancelUpdateStack service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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 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
updateStackRequest
- Container for the necessary parameters to
execute the UpdateStack service method on AmazonCloudFormation.InsufficientCapabilitiesException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
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.
NOTE: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
.
NOTE:A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
describeStackResources
in interface AmazonCloudFormation
describeStackResourcesRequest
- Container for the necessary
parameters to execute the DescribeStackResources service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public void deleteStack(DeleteStackRequest deleteStackRequest)
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
deleteStackRequest
- Container for the necessary parameters to
execute the DeleteStack service method on AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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.
listStackResources
in interface AmazonCloudFormation
listStackResourcesRequest
- Container for the necessary
parameters to execute the ListStackResources service method on
AmazonCloudFormation.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public DescribeStacksResult describeStacks() throws AmazonServiceException, AmazonClientException
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
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public ListStacksResult listStacks() throws AmazonServiceException, AmazonClientException
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
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public EstimateTemplateCostResult estimateTemplateCost() throws AmazonServiceException, AmazonClientException
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
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudFormation indicating
either a problem with the data in the request, or a server side issue.public 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 the request.
getCachedResponseMetadata
in interface AmazonCloudFormation
request
- The originally executed requestCopyright © 2014. All rights reserved.