public class AmazonCloudFormationClient extends AmazonWebServiceClient implements AmazonCloudFormation
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/.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AmazonCloudFormationClient()
Constructs a new client to invoke service methods on AWS CloudFormation.
|
AmazonCloudFormationClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWS CloudFormation
using the specified AWS account credentials.
|
AmazonCloudFormationClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS CloudFormation
using the specified AWS account credentials and client configuration
options.
|
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWS CloudFormation
using the specified AWS account credentials provider.
|
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS CloudFormation
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 AWS CloudFormation
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 AWS CloudFormation.
|
| 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.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum
number of stacks that you can create in your account.
|
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()
Simplified method form for invoking the DescribeStacks operation.
|
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()
Simplified method form for invoking the EstimateTemplateCost operation.
|
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.
|
GetTemplateSummaryResult |
getTemplateSummary()
Simplified method form for invoking the GetTemplateSummary operation.
|
GetTemplateSummaryResult |
getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
ListStackResourcesResult |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
ListStacksResult |
listStacks()
Simplified method form for invoking the ListStacks operation.
|
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.
|
void |
signalResource(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure
status.
|
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
ValidateTemplateResult |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AmazonCloudFormationClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic 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 AWS CloudFormation (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChainpublic 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 AWS CloudFormation (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 AWS CloudFormation (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 AWS CloudFormation (ex: proxy settings, retry counts,
etc.).requestMetricCollector - optional request metric collectorpublic void cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
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 AmazonCloudFormationcancelUpdateStackRequest - The input for the CancelUpdateStack action.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 AmazonCloudFormationcreateStackRequest - The input for CreateStack action.LimitExceededException - Quota for the resource has already been reached.AlreadyExistsException - Resource with the name requested already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that were not
specified in the Capabilities parameter.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 AmazonCloudFormationdeleteStackRequest - The input for DeleteStack action.public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
describeAccountLimits in interface AmazonCloudFormationdescribeAccountLimitsRequest - The input for the DescribeAccountLimits action.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.
describeStackEvents in interface AmazonCloudFormationdescribeStackEventsRequest - The input for DescribeStackEvents action.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 AmazonCloudFormationdescribeStackResourceRequest - The input for DescribeStackResource action.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.
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 AmazonCloudFormationdescribeStackResourcesRequest - The input for DescribeStackResources action.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 AmazonCloudFormationdescribeStacksRequest - The input for DescribeStacks action.public DescribeStacksResult describeStacks()
AmazonCloudFormationdescribeStacks in interface AmazonCloudFormationAmazonCloudFormation.describeStacks(DescribeStacksRequest)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 AmazonCloudFormationestimateTemplateCostRequest - public EstimateTemplateCostResult estimateTemplateCost()
AmazonCloudFormationestimateTemplateCost in interface AmazonCloudFormationAmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)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 AmazonCloudFormationgetStackPolicyRequest - The input for the GetStackPolicy action.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.
ValidationError is
returned. getTemplate in interface AmazonCloudFormationgetTemplateRequest - The input for a GetTemplate action.public GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
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 AmazonCloudFormationgetTemplateSummaryRequest - The input for the GetTemplateSummary action.public GetTemplateSummaryResult getTemplateSummary()
AmazonCloudFormationgetTemplateSummary in interface AmazonCloudFormationAmazonCloudFormation.getTemplateSummary(GetTemplateSummaryRequest)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 AmazonCloudFormationlistStackResourcesRequest - The input for the ListStackResource action.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 AmazonCloudFormationlistStacksRequest - The input for ListStacks action.public ListStacksResult listStacks()
AmazonCloudFormationlistStacks in interface AmazonCloudFormationAmazonCloudFormation.listStacks(ListStacksRequest)public void setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicy in interface AmazonCloudFormationsetStackPolicyRequest - The input for the SetStackPolicy action.public void signalResource(SignalResourceRequest signalResourceRequest)
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 AmazonCloudFormationsignalResourceRequest - The input for the SignalResource action.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 AmazonCloudFormationupdateStackRequest - The input for UpdateStack action.InsufficientCapabilitiesException - The template contains resources with capabilities that were not
specified in the Capabilities parameter.public ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
validateTemplate in interface AmazonCloudFormationvalidateTemplateRequest - The input for ValidateTemplate action.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 AmazonCloudFormationrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.