forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCreateInstanceRequest.java
More file actions
1239 lines (1154 loc) · 56.9 KB
/
CreateInstanceRequest.java
File metadata and controls
1239 lines (1154 loc) · 56.9 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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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.opsworks.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.opsworks.AWSOpsWorks#createInstance(CreateInstanceRequest) CreateInstance operation}.
* <p>
* Creates an instance in a specified stack. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> Adding an Instance to a Layer </a> .
* </p>
*
* @see com.amazonaws.services.opsworks.AWSOpsWorks#createInstance(CreateInstanceRequest)
*/
public class CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The stack ID.
*/
private String stackId;
/**
* An array that contains the instance layer IDs.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag<String> layerIds;
/**
* The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*/
private String instanceType;
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*/
private String autoScalingType;
/**
* The instance host name.
*/
private String hostname;
/**
* The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*/
private String os;
/**
* A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*/
private String amiId;
/**
* The instance SSH key name.
*/
private String sshKeyName;
/**
* The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*/
private String availabilityZone;
/**
* The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*/
private String subnetId;
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*/
private String architecture;
/**
* The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>ebs, instance-store
*/
private String rootDeviceType;
/**
* Whether to install operating system and package updates when the
* instance boots. The default value is <code>true</code>. To control
* when updates are installed, set this value to <code>false</code>. You
* must then update your instances manually by using
* <a>CreateDeployment</a> to run the <code>update_dependencies</code>
* stack command or manually running <code>yum</code> (Amazon Linux) or
* <code>apt-get</code> (Ubuntu) on the instances. <note>We strongly
* recommend using the default value of <code>true</code>, to ensure that
* your instances have the latest security updates.</note>
*/
private Boolean installUpdatesOnBoot;
/**
* The stack ID.
*
* @return The stack ID.
*/
public String getStackId() {
return stackId;
}
/**
* The stack ID.
*
* @param stackId The stack ID.
*/
public void setStackId(String stackId) {
this.stackId = stackId;
}
/**
* The stack ID.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param stackId The stack ID.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withStackId(String stackId) {
this.stackId = stackId;
return this;
}
/**
* An array that contains the instance layer IDs.
*
* @return An array that contains the instance layer IDs.
*/
public java.util.List<String> getLayerIds() {
if (layerIds == null) {
layerIds = new com.amazonaws.internal.ListWithAutoConstructFlag<String>();
layerIds.setAutoConstruct(true);
}
return layerIds;
}
/**
* An array that contains the instance layer IDs.
*
* @param layerIds An array that contains the instance layer IDs.
*/
public void setLayerIds(java.util.Collection<String> layerIds) {
if (layerIds == null) {
this.layerIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag<String> layerIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<String>(layerIds.size());
layerIdsCopy.addAll(layerIds);
this.layerIds = layerIdsCopy;
}
/**
* An array that contains the instance layer IDs.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param layerIds An array that contains the instance layer IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withLayerIds(String... layerIds) {
if (getLayerIds() == null) setLayerIds(new java.util.ArrayList<String>(layerIds.length));
for (String value : layerIds) {
getLayerIds().add(value);
}
return this;
}
/**
* An array that contains the instance layer IDs.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param layerIds An array that contains the instance layer IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withLayerIds(java.util.Collection<String> layerIds) {
if (layerIds == null) {
this.layerIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag<String> layerIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<String>(layerIds.size());
layerIdsCopy.addAll(layerIds);
this.layerIds = layerIdsCopy;
}
return this;
}
/**
* The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*
* @return The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*/
public String getInstanceType() {
return instanceType;
}
/**
* The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*
* @param instanceType The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
* The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceType The instance type. AWS OpsWorks supports all instance types except
* Cluster Compute, Cluster GPU, and High Memory Cluster. For more
* information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>. The parameter values that you use to specify
* the various types are in the API Name column of the Available Instance
* Types table.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withInstanceType(String instanceType) {
this.instanceType = instanceType;
return this;
}
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*
* @return The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
*
* @see AutoScalingType
*/
public String getAutoScalingType() {
return autoScalingType;
}
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*
* @param autoScalingType The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
*
* @see AutoScalingType
*/
public void setAutoScalingType(String autoScalingType) {
this.autoScalingType = autoScalingType;
}
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*
* @param autoScalingType The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AutoScalingType
*/
public CreateInstanceRequest withAutoScalingType(String autoScalingType) {
this.autoScalingType = autoScalingType;
return this;
}
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*
* @param autoScalingType The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
*
* @see AutoScalingType
*/
public void setAutoScalingType(AutoScalingType autoScalingType) {
this.autoScalingType = autoScalingType.toString();
}
/**
* The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>load, timer
*
* @param autoScalingType The instance auto scaling type, which has three possible values: <ul>
* <li><b>AlwaysRunning</b>: A 24/7 instance, which is not affected by
* auto scaling.</li> <li><b>TimeBasedAutoScaling</b>: A time-based auto
* scaling instance, which is started and stopped based on a specified
* schedule. To specify the schedule, call
* <a>SetTimeBasedAutoScaling</a>.</li> <li><b>LoadBasedAutoScaling</b>:
* A load-based auto scaling instance, which is started and stopped based
* on load metrics. To use load-based auto scaling, you must enable it
* for the instance layer and configure the thresholds by calling
* <a>SetLoadBasedAutoScaling</a>.</li> </ul>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AutoScalingType
*/
public CreateInstanceRequest withAutoScalingType(AutoScalingType autoScalingType) {
this.autoScalingType = autoScalingType.toString();
return this;
}
/**
* The instance host name.
*
* @return The instance host name.
*/
public String getHostname() {
return hostname;
}
/**
* The instance host name.
*
* @param hostname The instance host name.
*/
public void setHostname(String hostname) {
this.hostname = hostname;
}
/**
* The instance host name.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param hostname The instance host name.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withHostname(String hostname) {
this.hostname = hostname;
return this;
}
/**
* The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*
* @return The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*/
public String getOs() {
return os;
}
/**
* The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*
* @param os The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*/
public void setOs(String os) {
this.os = os;
}
/**
* The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param os The instance operating system, which must be set to one of the
* following. <ul> <li>Standard operating systems: <code>Amazon
* Linux</code> or <code>Ubuntu 12.04 LTS</code></li> <li>Custom AMIs:
* <code>Custom</code></li> </ul> <p>The default option is <code>Amazon
* Linux</code>. If you set this parameter to <code>Custom</code>, you
* must use the <a>CreateInstance</a> action's AmiId parameter to specify
* the custom AMI that you want to use. For more information on the
* standard operating systems, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating
* Systems</a>For more information on how to use custom AMIs with
* OpsWorks, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using
* Custom AMIs</a>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withOs(String os) {
this.os = os;
return this;
}
/**
* A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*
* @return A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*/
public String getAmiId() {
return amiId;
}
/**
* A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*
* @param amiId A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*/
public void setAmiId(String amiId) {
this.amiId = amiId;
}
/**
* A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param amiId A custom AMI ID to be used to create the instance. The AMI should be
* based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu
* 12.04 LTS. For more information, see <a
* href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html">Instances</a>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withAmiId(String amiId) {
this.amiId = amiId;
return this;
}
/**
* The instance SSH key name.
*
* @return The instance SSH key name.
*/
public String getSshKeyName() {
return sshKeyName;
}
/**
* The instance SSH key name.
*
* @param sshKeyName The instance SSH key name.
*/
public void setSshKeyName(String sshKeyName) {
this.sshKeyName = sshKeyName;
}
/**
* The instance SSH key name.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param sshKeyName The instance SSH key name.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withSshKeyName(String sshKeyName) {
this.sshKeyName = sshKeyName;
return this;
}
/**
* The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*
* @return The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*/
public String getAvailabilityZone() {
return availabilityZone;
}
/**
* The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*
* @param availabilityZone The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
* The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param availabilityZone The instance Availability Zone. For more information, see <a
* href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions
* and Endpoints</a>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
return this;
}
/**
* The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*
* @return The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*/
public String getSubnetId() {
return subnetId;
}
/**
* The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*
* @param subnetId The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*/
public void setSubnetId(String subnetId) {
this.subnetId = subnetId;
}
/**
* The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param subnetId The ID of the instance's subnet. If the stack is running in a VPC, you
* can use this parameter to override the stack's default subnet ID value
* and direct AWS OpsWorks to launch the instance in a different subnet.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateInstanceRequest withSubnetId(String subnetId) {
this.subnetId = subnetId;
return this;
}
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*
* @return The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
*
* @see Architecture
*/
public String getArchitecture() {
return architecture;
}
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*
* @param architecture The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
*
* @see Architecture
*/
public void setArchitecture(String architecture) {
this.architecture = architecture;
}
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*
* @param architecture The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see Architecture
*/
public CreateInstanceRequest withArchitecture(String architecture) {
this.architecture = architecture;
return this;
}
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*
* @param architecture The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
*
* @see Architecture
*/
public void setArchitecture(Architecture architecture) {
this.architecture = architecture.toString();
}
/**
* The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>x86_64, i386
*
* @param architecture The instance architecture. Instance types do not necessarily support
* both architectures. For a list of the architectures that are supported
* by the different instance types, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* Families and Types</a>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see Architecture
*/
public CreateInstanceRequest withArchitecture(Architecture architecture) {
this.architecture = architecture.toString();
return this;
}
/**
* The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>ebs, instance-store
*
* @return The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
*
* @see RootDeviceType
*/
public String getRootDeviceType() {
return rootDeviceType;
}
/**
* The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>ebs, instance-store
*
* @param rootDeviceType The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
*
* @see RootDeviceType
*/
public void setRootDeviceType(String rootDeviceType) {
this.rootDeviceType = rootDeviceType;
}
/**
* The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>ebs, instance-store
*
* @param rootDeviceType The instance root device type. For more information, see <a
* href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage
* for the Root Device</a>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see RootDeviceType
*/
public CreateInstanceRequest withRootDeviceType(String rootDeviceType) {
this.rootDeviceType = rootDeviceType;
return this;
}