|
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
public class AmazonCloudFormationClient
Client for accessing AmazonCloudFormation. All service calls made using this client are blocking, and will not return until the service call completes.
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 | |
---|---|
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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonCloudFormation. |
Method Summary | |
---|---|
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()
Returns all the stack related events for the AWS account. |
DescribeStackEventsResult |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all the stack related events for the AWS account. |
DescribeStackResourceResult |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack. |
DescribeStackResourcesResult |
describeStackResources()
Returns AWS resource descriptions for running and deleted stacks. |
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. |
GetTemplateResult |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack name. |
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 |
setEndpoint(String endpoint,
String serviceName,
String regionId)
Overrides the default endpoint for this client ("https://cloudformation.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. |
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template. |
ValidateTemplateResult |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template. |
Methods inherited from class com.amazonaws.AmazonWebServiceClient |
---|
addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset |
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 |
---|
setEndpoint, setRegion, shutdown |
Constructor Detail |
---|
public AmazonCloudFormationClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
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.).DefaultAWSCredentialsProvider
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.).Method Detail |
---|
public ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest) throws AmazonServiceException, AmazonClientException
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) 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
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) 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.
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 ListStacksResult listStacks(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).
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) 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.
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 EstimateTemplateCostResult estimateTemplateCost(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.
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) 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.
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) 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.
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) throws AmazonServiceException, AmazonClientException
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 void deleteStack(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.
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) 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.
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 DescribeStackResourcesResult describeStackResources(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, 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 UpdateStackResult updateStack(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 .
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 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 DescribeStackEventsResult describeStackEvents() 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.
describeStackEvents
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 DescribeStackResourcesResult describeStackResources() 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, 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
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 setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints 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.
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
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.serviceName
- The name of the AWS service to use when signing requests.regionId
- The ID of the region in which this service resides.
IllegalArgumentException
- If any problems are detected with the specified endpoint.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 request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |