|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.cloudformation.AmazonCloudFormationClient
com.amazonaws.services.cloudformation.AmazonCloudFormationAsyncClient
public class AmazonCloudFormationAsyncClient
Client for accessing AmazonCloudFormation. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed. 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 the 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/ .
Constructor Summary | |
---|---|
AmazonCloudFormationAsyncClient()
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation. |
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials. |
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials, executor service, and client configuration options. |
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials and executor service. |
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider. |
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider, executor service, and client configuration options. |
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider and executor service. |
|
AmazonCloudFormationAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation. |
Method Summary | |
---|---|
Future<CreateStackResult> |
createStackAsync(CreateStackRequest createStackRequest)
Creates a stack as specified in the template. |
Future<Void> |
deleteStackAsync(DeleteStackRequest deleteStackRequest)
Deletes a specified stack. |
Future<DescribeStackEventsResult> |
describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
Returns all the stack related events for the AWS account. |
Future<DescribeStackResourceResult> |
describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack. |
Future<DescribeStackResourcesResult> |
describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks. |
Future<DescribeStacksResult> |
describeStacksAsync(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. |
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template. |
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute requests. |
Future<GetTemplateResult> |
getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack name. |
Future<ListStackResourcesResult> |
listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack. |
Future<ListStacksResult> |
listStacksAsync(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter. |
void |
shutdown()
Shuts down the client, releasing all managed resources. |
Future<UpdateStackResult> |
updateStackAsync(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template. |
Future<ValidateTemplateResult> |
validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template. |
Methods inherited from class com.amazonaws.services.cloudformation.AmazonCloudFormationClient |
---|
createStack, deleteStack, describeStackEvents, describeStackEvents, describeStackResource, describeStackResources, describeStackResources, describeStacks, describeStacks, estimateTemplateCost, estimateTemplateCost, getCachedResponseMetadata, getTemplate, listStackResources, listStacks, listStacks, setEndpoint, updateStack, validateTemplate |
Methods inherited from class com.amazonaws.AmazonWebServiceClient |
---|
addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amazonaws.services.cloudformation.AmazonCloudFormation |
---|
createStack, deleteStack, describeStackEvents, describeStackEvents, describeStackResource, describeStackResources, describeStackResources, describeStacks, describeStacks, estimateTemplateCost, estimateTemplateCost, getCachedResponseMetadata, getTemplate, listStackResources, listStacks, listStacks, setEndpoint, updateStack, validateTemplate |
Constructor Detail |
---|
public AmazonCloudFormationAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AmazonCloudFormationAsyncClient(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.).DefaultAWSCredentialsProvider
public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.Method Detail |
---|
public ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface AmazonCloudFormation
shutdown
in class AmazonWebServiceClient
public Future<ListStacksResult> listStacksAsync(ListStacksRequest listStacksRequest) 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).
listStacksAsync
in interface AmazonCloudFormationAsync
listStacksRequest
- Container for the necessary parameters to
execute the ListStacks operation 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 Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE: Currently, the limit for stacks is 20 stacks per account per region.
createStackAsync
in interface AmazonCloudFormationAsync
createStackRequest
- Container for the necessary parameters to
execute the CreateStack operation 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 Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest) throws AmazonServiceException, AmazonClientException
Validates a specified template.
validateTemplateAsync
in interface AmazonCloudFormationAsync
validateTemplateRequest
- Container for the necessary parameters
to execute the ValidateTemplate operation 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 Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest) 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.
estimateTemplateCostAsync
in interface AmazonCloudFormationAsync
estimateTemplateCostRequest
- Container for the necessary
parameters to execute the EstimateTemplateCost operation 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 Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest describeStacksRequest) 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.
describeStacksAsync
in interface AmazonCloudFormationAsync
describeStacksRequest
- Container for the necessary parameters to
execute the DescribeStacks operation 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 Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest) throws AmazonServiceException, AmazonClientException
Returns all the stack related events for the AWS account. If
StackName
is specified, returns events related to all the
stacks with the given name. If StackName
is not
specified, returns all the events for the account. For more
information about a stack's event history, go to the
AWS CloudFormation User Guide .
NOTE:Events are returned, even if the stack never existed or has been successfully deleted.
describeStackEventsAsync
in interface AmazonCloudFormationAsync
describeStackEventsRequest
- Container for the necessary
parameters to execute the DescribeStackEvents operation 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 Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest) throws AmazonServiceException, AmazonClientException
Returns the template body for a specified stack name. 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.
getTemplateAsync
in interface AmazonCloudFormationAsync
getTemplateRequest
- Container for the necessary parameters to
execute the GetTemplate operation 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 Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest) throws AmazonServiceException, AmazonClientException
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.
describeStackResourceAsync
in interface AmazonCloudFormationAsync
describeStackResourceRequest
- Container for the necessary
parameters to execute the DescribeStackResource operation 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 Future<Void> deleteStackAsync(DeleteStackRequest deleteStackRequest) throws AmazonServiceException, AmazonClientException
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.
deleteStackAsync
in interface AmazonCloudFormationAsync
deleteStackRequest
- Container for the necessary parameters to
execute the DeleteStack operation 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 Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest) throws AmazonServiceException, AmazonClientException
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.
listStackResourcesAsync
in interface AmazonCloudFormationAsync
listStackResourcesRequest
- Container for the necessary
parameters to execute the ListStackResources operation 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 Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest) throws AmazonServiceException, AmazonClientException
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, all the associated resources of the stack the resource
belongs to are returned.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
If you do not provide either a stack or resource id, information for all stacks and resources will be returned, up to a limit of 100 records.
NOTE: To list more than 100 resources use ListStackResources instead.
You can 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.
describeStackResourcesAsync
in interface AmazonCloudFormationAsync
describeStackResourcesRequest
- Container for the necessary
parameters to execute the DescribeStackResources operation 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 Future<UpdateStackResult> updateStackAsync(UpdateStackRequest updateStackRequest) throws AmazonServiceException, AmazonClientException
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 .
updateStackAsync
in interface AmazonCloudFormationAsync
updateStackRequest
- Container for the necessary parameters to
execute the UpdateStack operation 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.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |