forked from amazonwebservices/aws-sdk-for-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ec2.class.php
3995 lines (3636 loc) · 244 KB
/
ec2.class.php
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
<?php
/*
* Copyright 2010-2011 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.
*/
/**
*
* Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides resizable compute capacity in the cloud. It is
* designed to make web-scale computing easier for developers.
*
* Amazon EC2's simple web service interface allows you to obtain and configure capacity with minimal friction. It
* provides you with complete control of your computing resources and lets you run on Amazon's proven computing
* environment. Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to
* quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of
* computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to
* build failure resilient applications and isolate themselves from common failure scenarios.
*
* Visit <a href="http://aws.amazon.com/ec2/">http://aws.amazon.com/ec2/</a> for more information.
*
* @version Fri Mar 25 13:14:50 PDT 2011
* @license See the included NOTICE.md file for complete information.
* @copyright See the included NOTICE.md file for complete information.
* @link http://aws.amazon.com/ec2/Amazon Elastic Compute Cloud
* @link http://aws.amazon.com/documentation/ec2/Amazon Elastic Compute Cloud documentation
*/
class AmazonEC2 extends CFRuntime
{
/*%******************************************************************************************%*/
// CLASS CONSTANTS
/**
* Specify the default queue URL.
*/
const DEFAULT_URL = 'ec2.amazonaws.com';
/**
* Specify the queue URL for the US-East (Northern Virginia) Region.
*/
const REGION_US_E1 = 'us-east-1';
/**
* Specify the queue URL for the US-West (Northern California) Region.
*/
const REGION_US_W1 = 'us-west-1';
/**
* Specify the queue URL for the EU (Ireland) Region.
*/
const REGION_EU_W1 = 'eu-west-1';
/**
* Specify the queue URL for the Asia Pacific (Singapore) Region.
*/
const REGION_APAC_SE1 = 'ap-southeast-1';
/**
* Specify the queue URL for the Asia Pacific (Japan) Region.
*/
const REGION_APAC_NE1 = 'ap-northeast-1';
/**
* The "pending" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_PENDING = 0;
/**
* The "running" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_RUNNING = 16;
/**
* The "shutting-down" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_SHUTTING_DOWN = 32;
/**
* The "terminated" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_TERMINATED = 48;
/**
* The "stopping" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_STOPPING = 64;
/**
* The "stopped" state code of an EC2 instance. Useful for conditionals.
*/
const STATE_STOPPED = 80;
/*%******************************************************************************************%*/
// SETTERS
/**
* This allows you to explicitly sets the region for the service to use.
*
* @param string $region (Required) The region to explicitly set. Available options are <REGION_US_E1>, <REGION_US_W1>, <REGION_EU_W1>, or <REGION_APAC_SE1>.
* @return $this A reference to the current instance.
*/
public function set_region($region)
{
$this->set_hostname('http://ec2.'. $region .'.amazonaws.com');
return $this;
}
/*%******************************************************************************************%*/
// CONSTRUCTOR
/**
* Constructs a new instance of <AmazonEC2>.
*
* @param string $key (Optional) Your Amazon API Key. If blank, it will look for the <code>AWS_KEY</code> constant.
* @param string $secret_key (Optional) Your Amazon API Secret Key. If blank, it will look for the <code>AWS_SECRET_KEY</code> constant.
* @return boolean false if no valid values are set, otherwise true.
*/
public function __construct($key = null, $secret_key = null)
{
$this->api_version = '2011-01-01';
$this->hostname = self::DEFAULT_URL;
if (!$key && !defined('AWS_KEY'))
{
throw new EC2_Exception('No account key was passed into the constructor, nor was it set in the AWS_KEY constant.');
}
if (!$secret_key && !defined('AWS_SECRET_KEY'))
{
throw new EC2_Exception('No account secret was passed into the constructor, nor was it set in the AWS_SECRET_KEY constant.');
}
return parent::__construct($key, $secret_key);
}
/*%******************************************************************************************%*/
// SERVICE METHODS
/**
*
* The RebootInstances operation requests a reboot of one or more instances. This operation is asynchronous; it only
* queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong
* to the user. Requests to reboot terminated instances are ignored.
*
* @param string|array $instance_id (Required) The list of instances to terminate. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function reboot_instances($instance_id, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'InstanceId' => (is_array($instance_id) ? $instance_id : array($instance_id))
)));
return $this->authenticate('RebootInstances', $opt, $this->hostname);
}
/**
*
* The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>ReservedInstancesId</code> - <code>string|array</code> - Optional - The optional list of Reserved Instance IDs to describe. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for ReservedInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_reserved_instances($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['ReservedInstancesId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'ReservedInstancesId' => (is_array($opt['ReservedInstancesId']) ? $opt['ReservedInstancesId'] : array($opt['ReservedInstancesId']))
)));
unset($opt['ReservedInstancesId']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeReservedInstances', $opt, $this->hostname);
}
/**
*
* The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and
* their states.
*
* Availability zones are not the same across accounts. The availability zone <code>us-east-1a</code> for account A is not
* necessarily the same as <code>us-east-1a</code> for account B. Zone assignments are mapped independently for each
* account.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>ZoneName</code> - <code>string|array</code> - Optional - A list of the availability zone names to describe. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for AvailabilityZones. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_availability_zones($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['ZoneName']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'ZoneName' => (is_array($opt['ZoneName']) ? $opt['ZoneName'] : array($opt['ZoneName']))
)));
unset($opt['ZoneName']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeAvailabilityZones', $opt, $this->hostname);
}
/**
*
* Detach a previously attached volume from a running instance.
*
* @param string $volume_id (Required) The ID of the volume to detach.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>InstanceId</code> - <code>string</code> - Optional - The ID of the instance from which to detach the the specified volume. </li>
* <li><code>Device</code> - <code>string</code> - Optional - The device name to which the volume is attached on the specified instance. </li>
* <li><code>Force</code> - <code>boolean</code> - Optional - Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function detach_volume($volume_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['VolumeId'] = $volume_id;
return $this->authenticate('DetachVolume', $opt, $this->hostname);
}
/**
*
* The DeleteKeyPair operation deletes a key pair.
*
* @param string $key_name (Required) The name of the Amazon EC2 key pair to delete.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function delete_key_pair($key_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['KeyName'] = $key_name;
return $this->authenticate('DeleteKeyPair', $opt, $this->hostname);
}
/**
*
* Disables monitoring for a running instance.
*
* @param string|array $instance_id (Required) The list of Amazon EC2 instances on which to disable monitoring. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function unmonitor_instances($instance_id, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'InstanceId' => (is_array($instance_id) ? $instance_id : array($instance_id))
)));
return $this->authenticate('UnmonitorInstances', $opt, $this->hostname);
}
/**
*
* Attaches a VPN gateway to a VPC. This is the last step required to get your VPC fully connected to your data center
* before launching instances in it. For more information, go to Process for Using Amazon VPC in the Amazon Virtual Private
* Cloud Developer Guide.
*
* @param string $vpn_gateway_id (Required) The ID of the VPN gateway to attach to the VPC.
* @param string $vpc_id (Required) The ID of the VPC to attach to the VPN gateway.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function attach_vpn_gateway($vpn_gateway_id, $vpc_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['VpnGatewayId'] = $vpn_gateway_id;
$opt['VpcId'] = $vpc_id;
return $this->authenticate('AttachVpnGateway', $opt, $this->hostname);
}
/**
*
* Creates an Amazon EBS-backed AMI from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot
* faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance
* failure, and can be stopped and started.
*
* @param string $instance_id (Required) The ID of the instance from which to create the new image.
* @param string $name (Required) The name for the new AMI being created.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>Description</code> - <code>string</code> - Optional - The description for the new AMI being created. </li>
* <li><code>NoReboot</code> - <code>boolean</code> - Optional - By default this property is set to <code>false</code>, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true, Amazon EC2 will not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed. </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function create_image($instance_id, $name, $opt = null)
{
if (!$opt) $opt = array();
$opt['InstanceId'] = $instance_id;
$opt['Name'] = $name;
return $this->authenticate('CreateImage', $opt, $this->hostname);
}
/**
*
* The DeleteSecurityGroup operation deletes a security group.
*
* If you attempt to delete a security group that contains instances, a fault is returned.
*
* If you attempt to delete a security group that is referenced by another security group, a fault is returned. For
* example, if security group B has a rule that allows access from security group A, security group A cannot be deleted
* until the allow rule is removed.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>GroupName</code> - <code>string</code> - Optional - The name of the Amazon EC2 security group to delete. </li>
* <li><code>GroupId</code> - <code>string</code> - Optional - The ID of the Amazon EC2 security group to delete. </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function delete_security_group($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DeleteSecurityGroup', $opt, $this->hostname);
}
/**
*
* This action applies only to security groups in a VPC; it's not supported for EC2 security groups. For information about
* Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide.
*
* The action adds one or more egress rules to a VPC security group. Specifically, this permits instances in a security
* group to send traffic to either one or more destination CIDR IP address ranges, or to one or more destination security
* groups in the same VPC.
*
* Each rule consists of the protocol (e.g., TCP), plus either a CIDR range, or a source group. For the TCP and UDP
* protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the
* ICMP type and code. You can use <code>-1</code> as a wildcard for the ICMP type or code.
*
* Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might
* occur.
*
* <b>Important: </b> For VPC security groups: You can have up to 50 rules total per group (covering both ingress and
* egress).
*
* @param string $group_id (Required) ID of the VPC security group to modify.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>IpPermissions</code> - <code>array</code> - Optional - List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>IpProtocol</code> - <code>string</code> - Optional - The IP protocol of this permission. Valid protocol values: <code>tcp</code>, <code>udp</code>, <code>icmp</code> </li>
* <li><code>FromPort</code> - <code>integer</code> - Optional - Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of <code>-1</code> indicates a wildcard (i.e., any ICMP type number). </li>
* <li><code>ToPort</code> - <code>integer</code> - Optional - End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of <code>-1</code> indicates a wildcard (i.e., any ICMP code). </li>
* <li><code>Groups</code> - <code>array</code> - Optional - The list of AWS user IDs and groups included in this permission. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>UserId</code> - <code>string</code> - Optional - The AWS user ID of an account. </li>
* <li><code>GroupName</code> - <code>string</code> - Optional - Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range. </li>
* <li><code>GroupId</code> - <code>string</code> - Optional - ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range. </li>
* </ul></li>
* </ul></li>
* <li><code>IpRanges</code> - <code>string|array</code> - Optional - The list of CIDR IP ranges included in this permission. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function authorize_security_group_egress($group_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['GroupId'] = $group_id;
// Optional parameter
if (isset($opt['IpPermissions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'IpPermissions' => $opt['IpPermissions']
)));
unset($opt['IpPermissions']);
}
return $this->authenticate('AuthorizeSecurityGroupEgress', $opt, $this->hostname);
}
/**
* Retrieves the encrypted administrator password for the instances running Windows.
*
* The Windows password is only generated the first time an AMI is launched. It is not generated for
* rebundled AMIs or after the password is changed on an instance. The password is encrypted using the
* key pair that you provided.
*
* @param string $instance_id (Required) The ID of the instance for which you want the Windows administrator password.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>DecryptPasswordWithKey</code> - <code>string</code> - Optional - Enables the decryption of the Administrator password for the given Microsoft Windows instance. Specifies the RSA private key that is associated with the keypair ID which was used to launch the Microsoft Windows instance.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This is useful for manually-managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function get_password_data($instance_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['InstanceId'] = $instance_id;
// Unless DecryptPasswordWithKey is set, simply return the response.
if (!isset($opt['DecryptPasswordWithKey']))
{
return $this->authenticate('GetPasswordData', $opt, $this->hostname);
}
// Otherwise, decrypt the password.
else
{
// Get a resource representing the private key.
$private_key = openssl_pkey_get_private($opt['DecryptPasswordWithKey']);
unset($opt['DecryptPasswordWithKey']);
// Fetch the encrypted password.
$response = $this->authenticate('GetPasswordData', $opt, $this->hostname);
$data = trim((string) $response->body->passwordData);
// If it's Base64-encoded...
if ($this->util->is_base64($data))
{
// Base64-decode it, and decrypt it with the private key.
if (openssl_private_decrypt(base64_decode($data), $decrypted, $private_key))
{
// Replace the previous password data with the decrypted value.
$response->body->passwordData = $decrypted;
}
}
return $response;
}
}
/**
*
* Associates a set of DHCP options (that you've previously created) with the specified VPC. Or, associates the default
* DHCP options with the VPC. The default set consists of the standard EC2 host name, no domain name, no DNS server, no NTP
* server, and no NetBIOS server or node type. After you associate the options with the VPC, any existing instances and all
* new instances that you launch in that VPC use the options. For more information about the supported DHCP options and
* using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer Guide.
*
* @param string $dhcp_options_id (Required) The ID of the DHCP options to associate with the VPC. Specify "default" to associate the default DHCP options with the VPC.
* @param string $vpc_id (Required) The ID of the VPC to associate the DHCP options with.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function associate_dhcp_options($dhcp_options_id, $vpc_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['DhcpOptionsId'] = $dhcp_options_id;
$opt['VpcId'] = $vpc_id;
return $this->authenticate('AssociateDhcpOptions', $opt, $this->hostname);
}
/**
*
* Stops an instance that uses an Amazon EBS volume as its root device. Instances that use Amazon EBS volumes as their
* root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you
* are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist
* your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.
*
* Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not
* preserve data stored in RAM.
*
* Performing this operation on an instance that uses an instance store as its root device returns an error.
*
* @param string|array $instance_id (Required) The list of Amazon EC2 instances to stop. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>Force</code> - <code>boolean</code> - Optional - Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function stop_instances($instance_id, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'InstanceId' => (is_array($instance_id) ? $instance_id : array($instance_id))
)));
return $this->authenticate('StopInstances', $opt, $this->hostname);
}
/**
* Imports the public key from an RSA key pair created with a third-party tool. This operation differs
* from CreateKeyPair as the private key is never transferred between the caller and AWS servers.
*
* RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the <code>ssh-keygen</code>
* command line tool provided with the standard OpenSSH installation. Standard library support for RSA
* key pair creation is also available for Java, Ruby, Python, and many other programming languages.
*
* The following formats are supported:
*
* <ul>
* <li>OpenSSH public key format.</li>
* <li>Base64 encoded DER format.</li>
* <li>SSH public key file format as specified in <a href="http://tools.ietf.org/html/rfc4716">RFC 4716</a>.</li>
* </ul>
*
* @param string $key_name (Required) The unique name for the key pair.
* @param string $public_key_material (Required) The public key portion of the key pair being imported.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This is useful for manually-managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function import_key_pair($key_name, $public_key_material, $opt = null)
{
if (!$opt) $opt = array();
$opt['KeyName'] = $key_name;
$opt['PublicKeyMaterial'] = $this->util->is_base64($public_key_material) ? $public_key_material : base64_encode($public_key_material);
return $this->authenticate('ImportKeyPair', $opt, $this->hostname);
}
/**
*
* The CreateSecurityGroup operation creates a new security group.
*
* Every instance is launched in a security group. If no security group is specified during launch, the instances are
* launched in the default security group. Instances within the same security group have unrestricted network access to
* each other. Instances will reject network access attempts from other instances in a different security group. As the
* owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and
* RevokeSecurityGroupIngress operations.
*
* @param string $group_name (Required) Name of the security group.
* @param string $group_description (Required) Description of the group. This is informational only.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>VpcId</code> - <code>string</code> - Optional - ID of the VPC. </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function create_security_group($group_name, $group_description, $opt = null)
{
if (!$opt) $opt = array();
$opt['GroupName'] = $group_name;
$opt['GroupDescription'] = $group_description;
return $this->authenticate('CreateSecurityGroup', $opt, $this->hostname);
}
/**
*
* Describes the Spot Price history.
*
* Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the
* current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current
* spot instance requests.
*
* For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon
* Elastic Compute Cloud User Guide.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>StartTime</code> - <code>string</code> - Optional - The start date and time of the Spot Instance price history data. May be passed as a number of seconds since UNIX Epoch, or any string compatible with <php:strtotime()>.</li>
* <li><code>EndTime</code> - <code>string</code> - Optional - The end date and time of the Spot Instance price history data. May be passed as a number of seconds since UNIX Epoch, or any string compatible with <php:strtotime()>.</li>
* <li><code>InstanceType</code> - <code>string|array</code> - Optional - Specifies the instance type to return. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>ProductDescription</code> - <code>string|array</code> - Optional - The description of the AMI. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for SpotPriceHistory. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_spot_price_history($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['StartTime']))
{
$opt['StartTime'] = $this->util->convert_date_to_iso8601($opt['StartTime']);
}
// Optional parameter
if (isset($opt['EndTime']))
{
$opt['EndTime'] = $this->util->convert_date_to_iso8601($opt['EndTime']);
}
// Optional parameter
if (isset($opt['InstanceType']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'InstanceType' => (is_array($opt['InstanceType']) ? $opt['InstanceType'] : array($opt['InstanceType']))
)));
unset($opt['InstanceType']);
}
// Optional parameter
if (isset($opt['ProductDescription']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'ProductDescription' => (is_array($opt['ProductDescription']) ? $opt['ProductDescription'] : array($opt['ProductDescription']))
)));
unset($opt['ProductDescription']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeSpotPriceHistory', $opt, $this->hostname);
}
/**
*
* The DescribeRegions operation describes regions zones that are currently available to the account.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>RegionName</code> - <code>string|array</code> - Optional - The optional list of regions to describe. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for Regions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_regions($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['RegionName']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'RegionName' => (is_array($opt['RegionName']) ? $opt['RegionName'] : array($opt['RegionName']))
)));
unset($opt['RegionName']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeRegions', $opt, $this->hostname);
}
/**
*
* Creates a set of DHCP options that you can then associate with one or more VPCs, causing all existing and new instances
* that you launch in those VPCs to use the set of DHCP options. The following table lists the individual DHCP options you
* can specify. For more information about the options, go to <a
* href="http://www.ietf.org/rfc/rfc2132.txt">http://www.ietf.org/rfc/rfc2132.txt</a>
*
* @param array $dhcp_configuration (Required) A set of one or more DHCP configurations. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Key</code> - <code>string</code> - Optional - Contains the name of a DHCP option. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains a set of values for a DHCP option. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul>
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function create_dhcp_options($dhcp_configuration, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'DhcpConfiguration' => (is_array($dhcp_configuration) ? $dhcp_configuration : array($dhcp_configuration))
)));
return $this->authenticate('CreateDhcpOptions', $opt, $this->hostname);
}
/**
*
* Resets permission settings for the specified snapshot.
*
* @param string $snapshot_id (Required) The ID of the snapshot whose attribute is being reset.
* @param string $attribute (Required) The name of the attribute being reset. Available attribute names: <code>createVolumePermission</code>
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function reset_snapshot_attribute($snapshot_id, $attribute, $opt = null)
{
if (!$opt) $opt = array();
$opt['SnapshotId'] = $snapshot_id;
$opt['Attribute'] = $attribute;
return $this->authenticate('ResetSnapshotAttribute', $opt, $this->hostname);
}
/**
*
* Deletes a route from a route table in a VPC. For more information about route tables, go to <a
* href="http://docs.amazonwebservices.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the Amazon
* Virtual Private Cloud User Guide.
*
* @param string $route_table_id (Required) The ID of the route table where the route will be deleted.
* @param string $destination_cidr_block (Required) The CIDR range for the route you want to delete. The value you specify must exactly match the CIDR for the route you want to delete.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function delete_route($route_table_id, $destination_cidr_block, $opt = null)
{
if (!$opt) $opt = array();
$opt['RouteTableId'] = $route_table_id;
$opt['DestinationCidrBlock'] = $destination_cidr_block;
return $this->authenticate('DeleteRoute', $opt, $this->hostname);
}
/**
*
* Gives you information about your Internet gateways. You can filter the results to return information only about
* Internet gateways that match criteria you specify. For example, you could get information only about gateways with
* particular tags. The Internet gateway must match at least one of the specified values for it to be included in the
* results.
*
* You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a
* particular value). The result includes information for a particular Internet gateway only if the gateway matches all
* your filters. If there's no match, no special message is returned; the response is simply empty.
*
* You can use wildcards with the filter values: an asterisk matches zero or more characters, and <code>?</code> matches
* exactly one character. You can escape special characters using a backslash before the character. For example, a value of
* <code>\*amazon\?\\</code> searches for the literal string <code>*amazon?\</code>.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>InternetGatewayId</code> - <code>string|array</code> - Optional - One or more Internet gateway IDs. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for Internet Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_internet_gateways($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['InternetGatewayId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'InternetGatewayId' => (is_array($opt['InternetGatewayId']) ? $opt['InternetGatewayId'] : array($opt['InternetGatewayId']))
)));
unset($opt['InternetGatewayId']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeInternetGateways', $opt, $this->hostname);
}
/**
*
* The DescribeSecurityGroups operation returns information about security groups that you own.
*
* If you specify security group names, information about those security group is returned. Otherwise, information for all
* security group is returned. If you specify a group that does not exist, a fault is returned.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>GroupName</code> - <code>string|array</code> - Optional - The optional list of Amazon EC2 security groups to describe. Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>GroupId</code> - <code>string|array</code> - Optional - Pass a string for a single value, or an indexed array for multiple values. </li>
* <li><code>Filter</code> - <code>array</code> - Optional - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Name</code> - <code>string</code> - Optional - Specifies the name of the filter. </li>
* <li><code>Value</code> - <code>string|array</code> - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_security_groups($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['GroupName']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'GroupName' => (is_array($opt['GroupName']) ? $opt['GroupName'] : array($opt['GroupName']))
)));
unset($opt['GroupName']);
}
// Optional parameter
if (isset($opt['GroupId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'GroupId' => (is_array($opt['GroupId']) ? $opt['GroupId'] : array($opt['GroupId']))
)));
unset($opt['GroupId']);
}
// Optional parameter
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeSecurityGroups', $opt, $this->hostname);
}
/**
*
* Detaches a VPN gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can
* confirm a VPN gateway has been completely detached from a VPC by describing the VPN gateway (any attachments to the VPN
* gateway are also described).
*
* You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC
* to the VPN gateway.
*
* @param string $vpn_gateway_id (Required) The ID of the VPN gateway to detach from the VPC.
* @param string $vpc_id (Required) The ID of the VPC to detach the VPN gateway from.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function detach_vpn_gateway($vpn_gateway_id, $vpc_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['VpnGatewayId'] = $vpn_gateway_id;
$opt['VpcId'] = $vpc_id;
return $this->authenticate('DetachVpnGateway', $opt, $this->hostname);
}
/**
*
* The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.
*
* @param string $image_id (Required) The ID of the AMI to deregister.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function deregister_image($image_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['ImageId'] = $image_id;
return $this->authenticate('DeregisterImage', $opt, $this->hostname);
}
/**
*
* Describes the data feed for Spot Instances.
*
* For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon
* Elastic Compute Cloud User Guide.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_spot_datafeed_subscription($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DescribeSpotDatafeedSubscription', $opt, $this->hostname);
}
/**
*
* Deletes tags from the specified Amazon EC2 resources.
*
* @param string|array $resource_id (Required) A list of one or more resource IDs. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>Tag</code> - <code>array</code> - Optional - The tags to delete from the specified resources. Each tag item consists of a key-value pair. If a tag is specified without a value, the tag and all of its values are deleted. <ul>
* <li><code>x</code> - <code>array</code> - This represents a simple array index. <ul>
* <li><code>Key</code> - <code>string</code> - Optional - The tag's key. </li>
* <li><code>Value</code> - <code>string</code> - Optional - The tag's value. </li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <php:curl_setopt()>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function delete_tags($resource_id, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'ResourceId' => (is_array($resource_id) ? $resource_id : array($resource_id))
)));
// Optional parameter
if (isset($opt['Tag']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Tag' => $opt['Tag']
)));
unset($opt['Tag']);