Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.cloudformation;
  
  import org.w3c.dom.*;
  
  import java.net.*;
  import java.util.*;
  
  import com.amazonaws.*;
  
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 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/ .

  
  public class AmazonCloudFormationClient extends AmazonWebServiceClient implements AmazonCloudFormation {

    
Provider for AWS credentials.
  
      private AWSCredentialsProvider awsCredentialsProvider;

    
List of exception unmarshallers for all AmazonCloudFormation exceptions.
  
              = new ArrayList<Unmarshaller<AmazonServiceExceptionNode>>();

    
Constructs a new client to invoke service methods on AmazonCloudFormation. A credentials provider chain will be used that searches for credentials in this order:
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

  
      public AmazonCloudFormationClient() {
          this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
      }

    
Constructs a new client to invoke service methods on AmazonCloudFormation. A credentials provider chain will be used that searches for credentials in this order:
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration The client configuration options controlling how this client connects to AmazonCloudFormation (ex: proxy settings, retry counts, etc.).
See also:
com.amazonaws.auth.DefaultAWSCredentialsProviderChain
 
     public AmazonCloudFormationClient(ClientConfiguration clientConfiguration) {
         this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
     }

    
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
 
     public AmazonCloudFormationClient(AWSCredentials awsCredentials) {
         this(awsCredentialsnew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
         super(clientConfiguration);
         this. = new StaticCredentialsProvider(awsCredentials);
         init();
     }

    
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
 
     public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider) {
         this(awsCredentialsProvidernew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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 awsCredentialsProviderClientConfiguration clientConfiguration) {
         this(awsCredentialsProviderclientConfigurationnull);
     }

    
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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 collector
 
     public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration,
             RequestMetricCollector requestMetricCollector) {
         super(clientConfigurationrequestMetricCollector);
         this. = awsCredentialsProvider;
         init();
     }
 
     private void init() {
         
         
         // calling this.setEndPoint(...) will also modify the signer accordingly
         this.setEndpoint("cloudformation.us-east-1.amazonaws.com");
         
         HandlerChainFactory chainFactory = new HandlerChainFactory();
         .addAll(chainFactory.newRequestHandlerChain(
                 "/com/amazonaws/services/cloudformation/request.handlers"));
         .addAll(chainFactory.newRequestHandler2Chain(
                 "/com/amazonaws/services/cloudformation/request.handler2s"));
     }

    

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.

Parameters:
getTemplateSummaryRequest Container for the necessary parameters to execute the GetTemplateSummary service method on AmazonCloudFormation.
Returns:
The response from the GetTemplateSummary service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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 GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) {
         ExecutionContext executionContext = createExecutionContext(getTemplateSummaryRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<GetTemplateSummaryRequestrequest = null;
         Response<GetTemplateSummaryResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new GetTemplateSummaryRequestMarshaller().marshall(super.beforeMarshalling(getTemplateSummaryRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew GetTemplateSummaryResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

Validates a specified template.

Parameters:
validateTemplateRequest Container for the necessary parameters to execute the ValidateTemplate service method on AmazonCloudFormation.
Returns:
The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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 ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest) {
         ExecutionContext executionContext = createExecutionContext(validateTemplateRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<ValidateTemplateRequestrequest = null;
         Response<ValidateTemplateResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new ValidateTemplateRequestMarshaller().marshall(super.beforeMarshalling(validateTemplateRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew ValidateTemplateResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Parameters:
describeStacksRequest Container for the necessary parameters to execute the DescribeStacks service method on AmazonCloudFormation.
Returns:
The response from the DescribeStacks service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(describeStacksRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeStacksRequestrequest = null;
         Response<DescribeStacksResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeStacksRequestMarshaller().marshall(super.beforeMarshalling(describeStacksRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew DescribeStacksResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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.

Parameters:
getTemplateRequest Container for the necessary parameters to execute the GetTemplate service method on AmazonCloudFormation.
Returns:
The response from the GetTemplate service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(getTemplateRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<GetTemplateRequestrequest = null;
         Response<GetTemplateResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new GetTemplateRequestMarshaller().marshall(super.beforeMarshalling(getTemplateRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew GetTemplateResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Parameters:
getStackPolicyRequest Container for the necessary parameters to execute the GetStackPolicy service method on AmazonCloudFormation.
Returns:
The response from the GetStackPolicy service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(getStackPolicyRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<GetStackPolicyRequestrequest = null;
         Response<GetStackPolicyResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new GetStackPolicyRequestMarshaller().marshall(super.beforeMarshalling(getStackPolicyRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew GetStackPolicyResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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).

Parameters:
listStacksRequest Container for the necessary parameters to execute the ListStacks service method on AmazonCloudFormation.
Returns:
The response from the ListStacks service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(listStacksRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<ListStacksRequestrequest = null;
         Response<ListStacksResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new ListStacksRequestMarshaller().marshall(super.beforeMarshalling(listStacksRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew ListStacksResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

Sets a stack policy for a specified stack.

Parameters:
setStackPolicyRequest Container for the necessary parameters to execute the SetStackPolicy service method on AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(setStackPolicyRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         Request<SetStackPolicyRequestrequest = null;
         awsRequestMetrics.startEvent(.);
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new SetStackPolicyRequestMarshaller().marshall(super.beforeMarshalling(setStackPolicyRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             invoke(requestnullexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

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.

Parameters:
createStackRequest Container for the necessary parameters to execute the CreateStack service method on AmazonCloudFormation.
Returns:
The response from the CreateStack service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.services.cloudformation.model.AlreadyExistsException
com.amazonaws.services.cloudformation.model.LimitExceededException
com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(createStackRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateStackRequestrequest = null;
         Response<CreateStackResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateStackRequestMarshaller().marshall(super.beforeMarshalling(createStackRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew CreateStackResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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.

Parameters:
estimateTemplateCostRequest Container for the necessary parameters to execute the EstimateTemplateCost service method on AmazonCloudFormation.
Returns:
The response from the EstimateTemplateCost service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(estimateTemplateCostRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<EstimateTemplateCostRequestrequest = null;
         Response<EstimateTemplateCostResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new EstimateTemplateCostRequestMarshaller().marshall(super.beforeMarshalling(estimateTemplateCostRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew EstimateTemplateCostResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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).

Parameters:
describeStackEventsRequest Container for the necessary parameters to execute the DescribeStackEvents service method on AmazonCloudFormation.
Returns:
The response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(describeStackEventsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeStackEventsRequestrequest = null;
         Response<DescribeStackEventsResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeStackEventsRequestMarshaller().marshall(super.beforeMarshalling(describeStackEventsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew DescribeStackEventsResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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.

Parameters:
describeStackResourceRequest Container for the necessary parameters to execute the DescribeStackResource service method on AmazonCloudFormation.
Returns:
The response from the DescribeStackResource service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(describeStackResourceRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeStackResourceRequestrequest = null;
         Response<DescribeStackResourceResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeStackResourceRequestMarshaller().marshall(super.beforeMarshalling(describeStackResourceRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew DescribeStackResourceResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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.

Parameters:
signalResourceRequest Container for the necessary parameters to execute the SignalResource service method on AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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 signalResource(SignalResourceRequest signalResourceRequest) {
         ExecutionContext executionContext = createExecutionContext(signalResourceRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         Request<SignalResourceRequestrequest = null;
         awsRequestMetrics.startEvent(.);
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new SignalResourceRequestMarshaller().marshall(super.beforeMarshalling(signalResourceRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             invoke(requestnullexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

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.

Parameters:
cancelUpdateStackRequest Container for the necessary parameters to execute the CancelUpdateStack service method on AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(cancelUpdateStackRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         Request<CancelUpdateStackRequestrequest = null;
         awsRequestMetrics.startEvent(.);
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CancelUpdateStackRequestMarshaller().marshall(super.beforeMarshalling(cancelUpdateStackRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             invoke(requestnullexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

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 .

Parameters:
updateStackRequest Container for the necessary parameters to execute the UpdateStack service method on AmazonCloudFormation.
Returns:
The response from the UpdateStack service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException
com.amazonaws.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.
com.amazonaws.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) {
         ExecutionContext executionContext = createExecutionContext(updateStackRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<UpdateStackRequestrequest = null;
         Response<UpdateStackResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new UpdateStackRequestMarshaller().marshall(super.beforeMarshalling(updateStackRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             response = invoke(requestnew UpdateStackResultStaxUnmarshaller(), executionContext);
             return response.getAwsResponse();
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }
    
    

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.

Parameters:
describeStackResourcesRequest Container for the necessary parameters to execute the DescribeStackResources service method on AmazonCloudFormation.
Returns:
The response from the DescribeStackResources service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.
        ExecutionContext executionContext = createExecutionContext(describeStackResourcesRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeStackResourcesRequestrequest = null;
        Response<DescribeStackResourcesResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeStackResourcesRequestMarshaller().marshall(super.beforeMarshalling(describeStackResourcesRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew DescribeStackResourcesResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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.

Parameters:
listStackResourcesRequest Container for the necessary parameters to execute the ListStackResources service method on AmazonCloudFormation.
Returns:
The response from the ListStackResources service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
        ExecutionContext executionContext = createExecutionContext(listStackResourcesRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListStackResourcesRequestrequest = null;
        Response<ListStackResourcesResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListStackResourcesRequestMarshaller().marshall(super.beforeMarshalling(listStackResourcesRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew ListStackResourcesResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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.

Parameters:
deleteStackRequest Container for the necessary parameters to execute the DeleteStack service method on AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.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) {
        ExecutionContext executionContext = createExecutionContext(deleteStackRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        Request<DeleteStackRequestrequest = null;
        awsRequestMetrics.startEvent(.);
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DeleteStackRequestMarshaller().marshall(super.beforeMarshalling(deleteStackRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            invoke(requestnullexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

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.

Returns:
The response from the GetTemplateSummary service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.
        return getTemplateSummary(new GetTemplateSummaryRequest());
    }
    
    

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Returns:
The response from the DescribeStacks service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.
        return describeStacks(new DescribeStacksRequest());
    }
    
    

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).

Returns:
The response from the ListStacks service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.
        return listStacks(new ListStacksRequest());
    }
    
    

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.

Returns:
The response from the EstimateTemplateCost service method, as returned by AmazonCloudFormation.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.
        return estimateTemplateCost(new EstimateTemplateCostRequest());
    }

    
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:
request The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
        return .getResponseMetadataForRequest(request);
    }
    private <X, Y extends AmazonWebServiceRequestResponse<X> invoke(Request<Y> request,
            Unmarshaller<X, StaxUnmarshallerContextunmarshaller,
            ExecutionContext executionContext)
    {
        request.setEndpoint();
        request.setTimeOffset();
        AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
        for (Entry<StringStringentry : originalRequest.copyPrivateRequestParameters().entrySet()) {
            request.addParameter(entry.getKey(), entry.getValue());
        }
        AWSCredentials credentials = .getCredentials();
        if (originalRequest.getRequestCredentials() != null) {
            credentials = originalRequest.getRequestCredentials();
        }
        executionContext.setCredentials(credentials);
        
        StaxResponseHandler<X> responseHandler = new StaxResponseHandler<X>(unmarshaller);
        return .execute(requestresponseHandlererrorResponseHandlerexecutionContext);
    }
}
        
New to GrepCode? Check out our FAQ X