forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAmazonCloudFormationClient.java
More file actions
895 lines (843 loc) · 40.8 KB
/
AmazonCloudFormationClient.java
File metadata and controls
895 lines (843 loc) · 40.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
/*
* Copyright 2010-2013 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.Node;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map.Entry;
import com.amazonaws.*;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.HandlerChainFactory;
import com.amazonaws.handlers.RequestHandler;
import com.amazonaws.http.StaxResponseHandler;
import com.amazonaws.http.DefaultErrorResponseHandler;
import com.amazonaws.http.ExecutionContext;
import com.amazonaws.internal.StaticCredentialsProvider;
import com.amazonaws.transform.Unmarshaller;
import com.amazonaws.transform.StaxUnmarshallerContext;
import com.amazonaws.transform.StandardErrorUnmarshaller;
import com.amazonaws.services.cloudformation.model.*;
import com.amazonaws.services.cloudformation.model.transform.*;
/**
* Client for accessing AmazonCloudFormation. All service calls made
* using this client are blocking, and will not return until the service call
* completes.
* <p>
* AWS CloudFormation <p>
* 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.
* </p>
* <p>
* 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.
* </p>
* <p>
* For more information about this product, go to the <a href="http://aws.amazon.com/cloudformation/"> CloudFormation Product Page </a> .
* </p>
* <p>
* 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 <a href="http://aws.amazon.com/documentation/"> http://aws.amazon.com/documentation/ </a> .
* </p>
*/
public class AmazonCloudFormationClient extends AmazonWebServiceClient implements AmazonCloudFormation {
/** Provider for AWS credentials. */
private AWSCredentialsProvider awsCredentialsProvider;
/**
* List of exception unmarshallers for all AmazonCloudFormation exceptions.
*/
protected final List<Unmarshaller<AmazonServiceException, Node>> exceptionUnmarshallers
= new ArrayList<Unmarshaller<AmazonServiceException, Node>>();
/** AWS signer for authenticating requests. */
private AWS4Signer signer;
/**
* Constructs a new client to invoke service methods on
* AmazonCloudFormation. A credentials provider chain will be used
* that searches for credentials in this order:
* <ul>
* <li> Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY </li>
* <li> Java System Properties - aws.accessKeyId and aws.secretKey </li>
* <li> Instance profile credentials delivered through the Amazon EC2 metadata service </li>
* </ul>
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @see DefaultAWSCredentialsProvider
*/
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:
* <ul>
* <li> Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY </li>
* <li> Java System Properties - aws.accessKeyId and aws.secretKey </li>
* <li> Instance profile credentials delivered through the Amazon EC2 metadata service </li>
* </ul>
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudFormation
* (ex: proxy settings, retry counts, etc.).
*
* @see DefaultAWSCredentialsProvider
*/
public AmazonCloudFormationClient(ClientConfiguration clientConfiguration) {
this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudFormation using the specified AWS account credentials.
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
*/
public AmazonCloudFormationClient(AWSCredentials awsCredentials) {
this(awsCredentials, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudFormation using the specified AWS account credentials
* and client configuration options.
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudFormation
* (ex: proxy settings, retry counts, etc.).
*/
public AmazonCloudFormationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
init();
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudFormation using the specified AWS account credentials provider.
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
*/
public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudFormation using the specified AWS account credentials
* provider and client configuration options.
*
* <p>
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudFormation
* (ex: proxy settings, retry counts, etc.).
*/
public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = awsCredentialsProvider;
init();
}
private void init() {
exceptionUnmarshallers.add(new AlreadyExistsExceptionUnmarshaller());
exceptionUnmarshallers.add(new InsufficientCapabilitiesExceptionUnmarshaller());
exceptionUnmarshallers.add(new LimitExceededExceptionUnmarshaller());
exceptionUnmarshallers.add(new StandardErrorUnmarshaller());
setEndpoint("cloudformation.us-east-1.amazonaws.com");
signer = new AWS4Signer();
signer.setServiceName("cloudformation");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandlers.addAll(chainFactory.newRequestHandlerChain(
"/com/amazonaws/services/cloudformation/request.handlers"));
}
/**
* <p>
* Validates a specified template.
* </p>
*
* @param validateTemplateRequest Container for the necessary parameters
* to execute the ValidateTemplate service method on
* AmazonCloudFormation.
*
* @return The response from the ValidateTemplate service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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)
throws AmazonServiceException, AmazonClientException {
Request<ValidateTemplateRequest> request = new ValidateTemplateRequestMarshaller().marshall(validateTemplateRequest);
return invoke(request, new ValidateTemplateResultStaxUnmarshaller());
}
/**
* <p>
* Returns the description for the specified stack; if no stack name was
* specified, then it returns the description for all the stacks created.
* </p>
*
* @param describeStacksRequest Container for the necessary parameters to
* execute the DescribeStacks service method on AmazonCloudFormation.
*
* @return The response from the DescribeStacks service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<DescribeStacksRequest> request = new DescribeStacksRequestMarshaller().marshall(describeStacksRequest);
return invoke(request, new DescribeStacksResultStaxUnmarshaller());
}
/**
* <p>
* Returns the template body for a specified stack name. You can get the
* template for running or deleted stacks.
* </p>
* <p>
* For deleted stacks, GetTemplate returns the template for up to 90 days
* after the stack has been deleted.
* </p>
* <p>
* <b>NOTE:</b> If the template does not exist, a ValidationError is
* returned.
* </p>
*
* @param getTemplateRequest Container for the necessary parameters to
* execute the GetTemplate service method on AmazonCloudFormation.
*
* @return The response from the GetTemplate service method, as returned
* by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<GetTemplateRequest> request = new GetTemplateRequestMarshaller().marshall(getTemplateRequest);
return invoke(request, new GetTemplateResultStaxUnmarshaller());
}
/**
* <p>
* 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).
* </p>
*
* @param listStacksRequest Container for the necessary parameters to
* execute the ListStacks service method on AmazonCloudFormation.
*
* @return The response from the ListStacks service method, as returned
* by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<ListStacksRequest> request = new ListStacksRequestMarshaller().marshall(listStacksRequest);
return invoke(request, new ListStacksResultStaxUnmarshaller());
}
/**
* <p>
* 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.
* </p>
* <p>
* <b>NOTE:</b> Currently, the limit for stacks is 20 stacks per account
* per region.
* </p>
*
* @param createStackRequest Container for the necessary parameters to
* execute the CreateStack service method on AmazonCloudFormation.
*
* @return The response from the CreateStack service method, as returned
* by AmazonCloudFormation.
*
* @throws AlreadyExistsException
* @throws LimitExceededException
* @throws InsufficientCapabilitiesException
*
* @throws 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.
* @throws 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 {
Request<CreateStackRequest> request = new CreateStackRequestMarshaller().marshall(createStackRequest);
return invoke(request, new CreateStackResultStaxUnmarshaller());
}
/**
* <p>
* 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.
* </p>
*
* @param estimateTemplateCostRequest Container for the necessary
* parameters to execute the EstimateTemplateCost service method on
* AmazonCloudFormation.
*
* @return The response from the EstimateTemplateCost service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<EstimateTemplateCostRequest> request = new EstimateTemplateCostRequestMarshaller().marshall(estimateTemplateCostRequest);
return invoke(request, new EstimateTemplateCostResultStaxUnmarshaller());
}
/**
* <p>
* Returns all the stack related events for the AWS account. If
* <code>StackName</code> is specified, returns events related to all the
* stacks with the given name. If <code>StackName</code> is not
* specified, returns all the events for the account. For more
* information about a stack's event history, go to the <a
* http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">
* AWS CloudFormation User Guide </a> .
* </p>
* <p>
* <b>NOTE:</b>Events are returned, even if the stack never existed or
* has been successfully deleted.
* </p>
*
* @param describeStackEventsRequest Container for the necessary
* parameters to execute the DescribeStackEvents service method on
* AmazonCloudFormation.
*
* @return The response from the DescribeStackEvents service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<DescribeStackEventsRequest> request = new DescribeStackEventsRequestMarshaller().marshall(describeStackEventsRequest);
return invoke(request, new DescribeStackEventsResultStaxUnmarshaller());
}
/**
* <p>
* Returns a description of the specified resource in the specified
* stack.
* </p>
* <p>
* For deleted stacks, DescribeStackResource returns resource information
* for up to 90 days after the stack has been deleted.
* </p>
*
* @param describeStackResourceRequest Container for the necessary
* parameters to execute the DescribeStackResource service method on
* AmazonCloudFormation.
*
* @return The response from the DescribeStackResource service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<DescribeStackResourceRequest> request = new DescribeStackResourceRequestMarshaller().marshall(describeStackResourceRequest);
return invoke(request, new DescribeStackResourceResultStaxUnmarshaller());
}
/**
* <p>
* 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.
* </p>
* <p>
* <b>NOTE:</b>Only stacks that are in the UPDATE_IN_PROGRESS state can
* be canceled.
* </p>
*
* @param cancelUpdateStackRequest Container for the necessary parameters
* to execute the CancelUpdateStack service method on
* AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<CancelUpdateStackRequest> request = new CancelUpdateStackRequestMarshaller().marshall(cancelUpdateStackRequest);
invoke(request, null);
}
/**
* <p>
* 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.
* </p>
*
* @param deleteStackRequest Container for the necessary parameters to
* execute the DeleteStack service method on AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<DeleteStackRequest> request = new DeleteStackRequestMarshaller().marshall(deleteStackRequest);
invoke(request, null);
}
/**
* <p>
* Returns descriptions of all resources of the specified stack.
* </p>
* <p>
* For deleted stacks, ListStackResources returns resource information
* for up to 90 days after the stack has been deleted.
* </p>
*
* @param listStackResourcesRequest Container for the necessary
* parameters to execute the ListStackResources service method on
* AmazonCloudFormation.
*
* @return The response from the ListStackResources service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<ListStackResourcesRequest> request = new ListStackResourcesRequestMarshaller().marshall(listStackResourcesRequest);
return invoke(request, new ListStackResourcesResultStaxUnmarshaller());
}
/**
* <p>
* Returns AWS resource descriptions for running and deleted stacks. If
* <code>StackName</code> is specified, all the associated resources that
* are part of the stack are returned. If <code>PhysicalResourceId</code>
* is specified, the associated resources of the stack that the resource
* belongs to are returned.
* </p>
* <p>
* <b>NOTE:</b>Only the first 100 resources will be returned. If your
* stack has more resources than this, you should use ListStackResources
* instead.
* </p>
* <p>
* For deleted stacks, <code>DescribeStackResources</code> returns
* resource information for up to 90 days after the stack has been
* deleted.
* </p>
* <p>
* You must specify either <code>StackName</code> or
* <code>PhysicalResourceId</code> , but not both. In addition, you can
* specify <code>LogicalResourceId</code> to filter the returned result.
* For more information about resources, the
* <code>LogicalResourceId</code> and <code>PhysicalResourceId</code> ,
* go to the <a
* href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide">
* AWS CloudFormation User Guide </a> .
* </p>
* <p>
* <b>NOTE:</b>A ValidationError is returned if you specify both
* StackName and PhysicalResourceId in the same request.
* </p>
*
* @param describeStackResourcesRequest Container for the necessary
* parameters to execute the DescribeStackResources service method on
* AmazonCloudFormation.
*
* @return The response from the DescribeStackResources service method,
* as returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
Request<DescribeStackResourcesRequest> request = new DescribeStackResourcesRequestMarshaller().marshall(describeStackResourcesRequest);
return invoke(request, new DescribeStackResourcesResultStaxUnmarshaller());
}
/**
* <p>
* 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.
* </p>
* <p>
* To get a copy of the template for an existing stack, you can use the
* GetTemplate action.
* </p>
* <p>
* Tags that were associated with this stack during creation time will
* still be associated with the stack after an <code>UpdateStack</code>
* operation.
* </p>
* <p>
* For more information about creating an update template, updating a
* stack, and monitoring the progress of the update, see <a
* om/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">
* Updating a Stack </a> .
* </p>
*
* @param updateStackRequest Container for the necessary parameters to
* execute the UpdateStack service method on AmazonCloudFormation.
*
* @return The response from the UpdateStack service method, as returned
* by AmazonCloudFormation.
*
* @throws InsufficientCapabilitiesException
*
* @throws 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.
* @throws 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 {
Request<UpdateStackRequest> request = new UpdateStackRequestMarshaller().marshall(updateStackRequest);
return invoke(request, new UpdateStackResultStaxUnmarshaller());
}
/**
* <p>
* Returns the description for the specified stack; if no stack name was
* specified, then it returns the description for all the stacks created.
* </p>
*
* @return The response from the DescribeStacks service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
return describeStacks(new DescribeStacksRequest());
}
/**
* <p>
* 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).
* </p>
*
* @return The response from the ListStacks service method, as returned
* by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
return listStacks(new ListStacksRequest());
}
/**
* <p>
* 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.
* </p>
*
* @return The response from the EstimateTemplateCost service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
return estimateTemplateCost(new EstimateTemplateCostRequest());
}
/**
* <p>
* Returns all the stack related events for the AWS account. If
* <code>StackName</code> is specified, returns events related to all the
* stacks with the given name. If <code>StackName</code> is not
* specified, returns all the events for the account. For more
* information about a stack's event history, go to the <a
* http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">
* AWS CloudFormation User Guide </a> .
* </p>
* <p>
* <b>NOTE:</b>Events are returned, even if the stack never existed or
* has been successfully deleted.
* </p>
*
* @return The response from the DescribeStackEvents service method, as
* returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
return describeStackEvents(new DescribeStackEventsRequest());
}
/**
* <p>
* Returns AWS resource descriptions for running and deleted stacks. If
* <code>StackName</code> is specified, all the associated resources that
* are part of the stack are returned. If <code>PhysicalResourceId</code>
* is specified, the associated resources of the stack that the resource
* belongs to are returned.
* </p>
* <p>
* <b>NOTE:</b>Only the first 100 resources will be returned. If your
* stack has more resources than this, you should use ListStackResources
* instead.
* </p>
* <p>
* For deleted stacks, <code>DescribeStackResources</code> returns
* resource information for up to 90 days after the stack has been
* deleted.
* </p>
* <p>
* You must specify either <code>StackName</code> or
* <code>PhysicalResourceId</code> , but not both. In addition, you can
* specify <code>LogicalResourceId</code> to filter the returned result.
* For more information about resources, the
* <code>LogicalResourceId</code> and <code>PhysicalResourceId</code> ,
* go to the <a
* href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide">
* AWS CloudFormation User Guide </a> .
* </p>
* <p>
* <b>NOTE:</b>A ValidationError is returned if you specify both
* StackName and PhysicalResourceId in the same request.
* </p>
*
* @return The response from the DescribeStackResources service method,
* as returned by AmazonCloudFormation.
*
*
* @throws 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.
* @throws 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 {
return describeStackResources(new DescribeStackResourcesRequest());
}
/**
* 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. In almost all cases, this region ID and service name
* are automatically determined from the endpoint, and callers should use the simpler
* one-argument form of setEndpoint instead of this method.
* <p>
* <b>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.</b>
* <p>
* 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
* {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* 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:
* <a href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
*
* @param 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.
* @param serviceName
* The name of the AWS service to use when signing requests.
* @param regionId
* The ID of the region in which this service resides.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException {
setEndpoint(endpoint);
signer.setServiceName(serviceName);
signer.setRegionName(regionId);
}
@Override
protected String getServiceAbbreviation() {
return "cloudformation";
}
/**
* 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.
* <p>
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
private <X, Y extends AmazonWebServiceRequest> X invoke(Request<Y> request, Unmarshaller<X, StaxUnmarshallerContext> unmarshaller) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
for (Entry<String, String> entry : request.getOriginalRequest().copyPrivateRequestParameters().entrySet()) {
request.addParameter(entry.getKey(), entry.getValue());
}
AWSCredentials credentials = awsCredentialsProvider.getCredentials();
AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
if (originalRequest != null && originalRequest.getRequestCredentials() != null) {
credentials = originalRequest.getRequestCredentials();
}
ExecutionContext executionContext = createExecutionContext();
executionContext.setSigner(signer);
executionContext.setCredentials(credentials);
StaxResponseHandler<X> responseHandler = new StaxResponseHandler<X>(unmarshaller);
DefaultErrorResponseHandler errorResponseHandler = new DefaultErrorResponseHandler(exceptionUnmarshallers);
return (X)client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
}