aws-sdk 1.11.2 → 1.11.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method cancel_job(options = {})
26
26
  # Calls the CancelJob API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:job_id` - *required* - (String)
29
30
  # @return [Core::Response]
30
31
  # The #data method of the response object returns
@@ -35,6 +36,7 @@ module AWS
35
36
  # @!method create_job(options = {})
36
37
  # Calls the CreateJob API operation.
37
38
  # @param [Hash] options
39
+ #
38
40
  # * `:job_type` - *required* - (String) Valid values include:
39
41
  # * `Import`
40
42
  # * `Export`
@@ -55,6 +57,7 @@ module AWS
55
57
  # @!method get_status(options = {})
56
58
  # Calls the GetStatus API operation.
57
59
  # @param [Hash] options
60
+ #
58
61
  # * `:job_id` - *required* - (String)
59
62
  # @return [Core::Response]
60
63
  # The #data method of the response object returns
@@ -80,6 +83,7 @@ module AWS
80
83
  # @!method list_jobs(options = {})
81
84
  # Calls the ListJobs API operation.
82
85
  # @param [Hash] options
86
+ #
83
87
  # * `:max_jobs` - (Integer)
84
88
  # * `:marker` - (String)
85
89
  # @return [Core::Response]
@@ -96,6 +100,7 @@ module AWS
96
100
  # @!method update_job(options = {})
97
101
  # Calls the UpdateJob API operation.
98
102
  # @param [Hash] options
103
+ #
99
104
  # * `:job_id` - *required* - (String)
100
105
  # * `:manifest` - *required* - (String)
101
106
  # * `:job_type` - *required* - (String) Valid values include:
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method attach_elastic_load_balancer(options = {})
26
26
  # Calls the AttachElasticLoadBalancer API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:elastic_load_balancer_name` - *required* - (String) The Elastic
29
30
  # Load Balancing instance's name.
30
31
  # * `:layer_id` - *required* - (String) The ID of the layer that the
@@ -34,6 +35,7 @@ module AWS
34
35
  # @!method clone_stack(options = {})
35
36
  # Calls the CloneStack API operation.
36
37
  # @param [Hash] options
38
+ #
37
39
  # * `:source_stack_id` - *required* - (String) The source stack ID.
38
40
  # * `:name` - (String) The cloned stack name.
39
41
  # * `:region` - (String) The cloned stack AWS region, such as
@@ -123,6 +125,7 @@ module AWS
123
125
  # @!method create_app(options = {})
124
126
  # Calls the CreateApp API operation.
125
127
  # @param [Hash] options
128
+ #
126
129
  # * `:stack_id` - *required* - (String) The stack ID.
127
130
  # * `:shortname` - (String) The app's short name.
128
131
  # * `:name` - *required* - (String) The app name.
@@ -182,6 +185,7 @@ module AWS
182
185
  # @!method create_deployment(options = {})
183
186
  # Calls the CreateDeployment API operation.
184
187
  # @param [Hash] options
188
+ #
185
189
  # * `:stack_id` - *required* - (String) The stack ID.
186
190
  # * `:app_id` - (String) The app ID. This parameter is required for app
187
191
  # deployments, but not for other deployment commands.
@@ -234,6 +238,7 @@ module AWS
234
238
  # @!method create_instance(options = {})
235
239
  # Calls the CreateInstance API operation.
236
240
  # @param [Hash] options
241
+ #
237
242
  # * `:stack_id` - *required* - (String) The stack ID.
238
243
  # * `:layer_ids` - *required* - (Array<String>) An array that contains
239
244
  # the instance layer IDs.
@@ -281,6 +286,7 @@ module AWS
281
286
  # @!method create_layer(options = {})
282
287
  # Calls the CreateLayer API operation.
283
288
  # @param [Hash] options
289
+ #
284
290
  # * `:stack_id` - *required* - (String) The layer stack ID.
285
291
  # * `:type` - *required* - (String) The layer type. A stack cannot have
286
292
  # more than one layer of the same type. This parameter must be set to
@@ -347,6 +353,7 @@ module AWS
347
353
  # @!method create_stack(options = {})
348
354
  # Calls the CreateStack API operation.
349
355
  # @param [Hash] options
356
+ #
350
357
  # * `:name` - *required* - (String) The stack name.
351
358
  # * `:region` - *required* - (String) The stack AWS region, such as
352
359
  # "us-east-1". For more information about Amazon regions, see Regions
@@ -425,6 +432,7 @@ module AWS
425
432
  # @!method create_user_profile(options = {})
426
433
  # Calls the CreateUserProfile API operation.
427
434
  # @param [Hash] options
435
+ #
428
436
  # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
429
437
  # * `:ssh_username` - (String) The user's SSH user name.
430
438
  # * `:ssh_public_key` - (String) The user's public SSH key.
@@ -437,12 +445,14 @@ module AWS
437
445
  # @!method delete_app(options = {})
438
446
  # Calls the DeleteApp API operation.
439
447
  # @param [Hash] options
448
+ #
440
449
  # * `:app_id` - *required* - (String) The app ID.
441
450
  # @return [Core::Response]
442
451
 
443
452
  # @!method delete_instance(options = {})
444
453
  # Calls the DeleteInstance API operation.
445
454
  # @param [Hash] options
455
+ #
446
456
  # * `:instance_id` - *required* - (String) The instance ID.
447
457
  # * `:delete_elastic_ip` - (Boolean) Whether to delete the instance
448
458
  # Elastic IP address.
@@ -453,24 +463,28 @@ module AWS
453
463
  # @!method delete_layer(options = {})
454
464
  # Calls the DeleteLayer API operation.
455
465
  # @param [Hash] options
466
+ #
456
467
  # * `:layer_id` - *required* - (String) The layer ID.
457
468
  # @return [Core::Response]
458
469
 
459
470
  # @!method delete_stack(options = {})
460
471
  # Calls the DeleteStack API operation.
461
472
  # @param [Hash] options
473
+ #
462
474
  # * `:stack_id` - *required* - (String) The stack ID.
463
475
  # @return [Core::Response]
464
476
 
465
477
  # @!method delete_user_profile(options = {})
466
478
  # Calls the DeleteUserProfile API operation.
467
479
  # @param [Hash] options
480
+ #
468
481
  # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
469
482
  # @return [Core::Response]
470
483
 
471
484
  # @!method describe_apps(options = {})
472
485
  # Calls the DescribeApps API operation.
473
486
  # @param [Hash] options
487
+ #
474
488
  # * `:stack_id` - (String) The app stack ID. If you use this parameter,
475
489
  # DescribeApps returns a description of the apps in the specified
476
490
  # stack.
@@ -508,6 +522,7 @@ module AWS
508
522
  # @!method describe_commands(options = {})
509
523
  # Calls the DescribeCommands API operation.
510
524
  # @param [Hash] options
525
+ #
511
526
  # * `:deployment_id` - (String) The deployment ID. If you include this
512
527
  # parameter, DescribeCommands returns a description of the commands
513
528
  # associated with the specified deployment.
@@ -537,6 +552,7 @@ module AWS
537
552
  # @!method describe_deployments(options = {})
538
553
  # Calls the DescribeDeployments API operation.
539
554
  # @param [Hash] options
555
+ #
540
556
  # * `:stack_id` - (String) The stack ID. If you include this parameter,
541
557
  # DescribeDeployments returns a description of the commands
542
558
  # associated with the specified stack.
@@ -571,6 +587,7 @@ module AWS
571
587
  # @!method describe_elastic_ips(options = {})
572
588
  # Calls the DescribeElasticIps API operation.
573
589
  # @param [Hash] options
590
+ #
574
591
  # * `:instance_id` - (String) The instance ID. If you include this
575
592
  # parameter, DescribeElasticIps returns a description of the Elastic
576
593
  # IP addresses associated with the specified instance.
@@ -590,6 +607,7 @@ module AWS
590
607
  # @!method describe_elastic_load_balancers(options = {})
591
608
  # Calls the DescribeElasticLoadBalancers API operation.
592
609
  # @param [Hash] options
610
+ #
593
611
  # * `:stack_id` - (String) A stack ID. The action describes the Elastic
594
612
  # Load Balancing instances for the stack.
595
613
  # * `:layer_ids` - (Array<String>) A list of layer IDs. The action
@@ -611,6 +629,7 @@ module AWS
611
629
  # @!method describe_instances(options = {})
612
630
  # Calls the DescribeInstances API operation.
613
631
  # @param [Hash] options
632
+ #
614
633
  # * `:stack_id` - (String) A stack ID. If you use this parameter,
615
634
  # DescribeInstances returns descriptions of the instances associated
616
635
  # with the specified stack.
@@ -655,6 +674,7 @@ module AWS
655
674
  # @!method describe_layers(options = {})
656
675
  # Calls the DescribeLayers API operation.
657
676
  # @param [Hash] options
677
+ #
658
678
  # * `:stack_id` - *required* - (String) The stack ID.
659
679
  # * `:layer_ids` - (Array<String>) An array of layer IDs that specify
660
680
  # the layers to be described. If you omit this parameter,
@@ -699,6 +719,7 @@ module AWS
699
719
  # @!method describe_load_based_auto_scaling(options = {})
700
720
  # Calls the DescribeLoadBasedAutoScaling API operation.
701
721
  # @param [Hash] options
722
+ #
702
723
  # * `:layer_ids` - *required* - (Array<String>) An array of layer IDs.
703
724
  # @return [Core::Response]
704
725
  # The #data method of the response object returns
@@ -725,6 +746,7 @@ module AWS
725
746
  # @!method describe_permissions(options = {})
726
747
  # Calls the DescribePermissions API operation.
727
748
  # @param [Hash] options
749
+ #
728
750
  # * `:iam_user_arn` - *required* - (String) The user's IAM ARN. For
729
751
  # more information about IAM ARNs, see Using Identifiers.
730
752
  # * `:stack_id` - *required* - (String) The stack ID.
@@ -741,6 +763,7 @@ module AWS
741
763
  # @!method describe_raid_arrays(options = {})
742
764
  # Calls the DescribeRaidArrays API operation.
743
765
  # @param [Hash] options
766
+ #
744
767
  # * `:instance_id` - (String) The instance ID. If you use this
745
768
  # parameter, DescribeRaidArrays returns descriptions of the RAID
746
769
  # arrays associated with the specified instance.
@@ -767,6 +790,7 @@ module AWS
767
790
  # @!method describe_service_errors(options = {})
768
791
  # Calls the DescribeServiceErrors API operation.
769
792
  # @param [Hash] options
793
+ #
770
794
  # * `:stack_id` - (String) The stack ID. If you use this parameter,
771
795
  # DescribeServiceErrors returns descriptions of the errors associated
772
796
  # with the specified stack.
@@ -792,6 +816,7 @@ module AWS
792
816
  # @!method describe_stacks(options = {})
793
817
  # Calls the DescribeStacks API operation.
794
818
  # @param [Hash] options
819
+ #
795
820
  # * `:stack_ids` - (Array<String>) An array of stack IDs that specify
796
821
  # the stacks to be described. If you omit this parameter,
797
822
  # DescribeStacks returns a description of every stack.
@@ -825,6 +850,7 @@ module AWS
825
850
  # @!method describe_time_based_auto_scaling(options = {})
826
851
  # Calls the DescribeTimeBasedAutoScaling API operation.
827
852
  # @param [Hash] options
853
+ #
828
854
  # * `:instance_ids` - *required* - (Array<String>) An array of instance
829
855
  # IDs.
830
856
  # @return [Core::Response]
@@ -845,6 +871,7 @@ module AWS
845
871
  # @!method describe_user_profiles(options = {})
846
872
  # Calls the DescribeUserProfiles API operation.
847
873
  # @param [Hash] options
874
+ #
848
875
  # * `:iam_user_arns` - *required* - (Array<String>) An array of IAM
849
876
  # user ARNs that identify the users to be described.
850
877
  # @return [Core::Response]
@@ -860,6 +887,7 @@ module AWS
860
887
  # @!method describe_volumes(options = {})
861
888
  # Calls the DescribeVolumes API operation.
862
889
  # @param [Hash] options
890
+ #
863
891
  # * `:instance_id` - (String) The instance ID. If you use this
864
892
  # parameter, DescribeVolumes returns descriptions of the volumes
865
893
  # associated with the specified instance.
@@ -890,6 +918,7 @@ module AWS
890
918
  # @!method detach_elastic_load_balancer(options = {})
891
919
  # Calls the DetachElasticLoadBalancer API operation.
892
920
  # @param [Hash] options
921
+ #
893
922
  # * `:elastic_load_balancer_name` - *required* - (String) The Elastic
894
923
  # Load Balancing instance's name.
895
924
  # * `:layer_id` - *required* - (String) The ID of the layer that the
@@ -899,6 +928,7 @@ module AWS
899
928
  # @!method get_hostname_suggestion(options = {})
900
929
  # Calls the GetHostnameSuggestion API operation.
901
930
  # @param [Hash] options
931
+ #
902
932
  # * `:layer_id` - *required* - (String) The layer ID.
903
933
  # @return [Core::Response]
904
934
  # The #data method of the response object returns
@@ -910,12 +940,14 @@ module AWS
910
940
  # @!method reboot_instance(options = {})
911
941
  # Calls the RebootInstance API operation.
912
942
  # @param [Hash] options
943
+ #
913
944
  # * `:instance_id` - *required* - (String) The instance ID.
914
945
  # @return [Core::Response]
915
946
 
916
947
  # @!method set_load_based_auto_scaling(options = {})
917
948
  # Calls the SetLoadBasedAutoScaling API operation.
918
949
  # @param [Hash] options
950
+ #
919
951
  # * `:layer_id` - *required* - (String) The layer ID.
920
952
  # * `:enable` - (Boolean) Enables load-based auto scaling for the
921
953
  # layer.
@@ -974,6 +1006,7 @@ module AWS
974
1006
  # @!method set_permission(options = {})
975
1007
  # Calls the SetPermission API operation.
976
1008
  # @param [Hash] options
1009
+ #
977
1010
  # * `:stack_id` - *required* - (String) The stack ID.
978
1011
  # * `:iam_user_arn` - *required* - (String) The user's IAM ARN.
979
1012
  # * `:allow_ssh` - (Boolean) The user is allowed to use SSH to
@@ -985,6 +1018,7 @@ module AWS
985
1018
  # @!method set_time_based_auto_scaling(options = {})
986
1019
  # Calls the SetTimeBasedAutoScaling API operation.
987
1020
  # @param [Hash] options
1021
+ #
988
1022
  # * `:instance_id` - *required* - (String) The instance ID.
989
1023
  # * `:auto_scaling_schedule` - (Hash) An AutoScalingSchedule with the
990
1024
  # instance schedule.
@@ -1000,30 +1034,35 @@ module AWS
1000
1034
  # @!method start_instance(options = {})
1001
1035
  # Calls the StartInstance API operation.
1002
1036
  # @param [Hash] options
1037
+ #
1003
1038
  # * `:instance_id` - *required* - (String) The instance ID.
1004
1039
  # @return [Core::Response]
1005
1040
 
1006
1041
  # @!method start_stack(options = {})
1007
1042
  # Calls the StartStack API operation.
1008
1043
  # @param [Hash] options
1044
+ #
1009
1045
  # * `:stack_id` - *required* - (String) The stack ID.
1010
1046
  # @return [Core::Response]
1011
1047
 
1012
1048
  # @!method stop_instance(options = {})
1013
1049
  # Calls the StopInstance API operation.
1014
1050
  # @param [Hash] options
1051
+ #
1015
1052
  # * `:instance_id` - *required* - (String) The instance ID.
1016
1053
  # @return [Core::Response]
1017
1054
 
1018
1055
  # @!method stop_stack(options = {})
1019
1056
  # Calls the StopStack API operation.
1020
1057
  # @param [Hash] options
1058
+ #
1021
1059
  # * `:stack_id` - *required* - (String) The stack ID.
1022
1060
  # @return [Core::Response]
1023
1061
 
1024
1062
  # @!method update_app(options = {})
1025
1063
  # Calls the UpdateApp API operation.
1026
1064
  # @param [Hash] options
1065
+ #
1027
1066
  # * `:app_id` - *required* - (String) The app ID.
1028
1067
  # * `:name` - (String) The app name.
1029
1068
  # * `:description` - (String) A description of the app.
@@ -1074,6 +1113,7 @@ module AWS
1074
1113
  # @!method update_instance(options = {})
1075
1114
  # Calls the UpdateInstance API operation.
1076
1115
  # @param [Hash] options
1116
+ #
1077
1117
  # * `:instance_id` - *required* - (String) The instance ID.
1078
1118
  # * `:layer_ids` - (Array<String>) The instance's layer IDs.
1079
1119
  # * `:instance_type` - (String) The instance type. OpsWorks supports
@@ -1105,6 +1145,7 @@ module AWS
1105
1145
  # @!method update_layer(options = {})
1106
1146
  # Calls the UpdateLayer API operation.
1107
1147
  # @param [Hash] options
1148
+ #
1108
1149
  # * `:layer_id` - *required* - (String) The layer ID.
1109
1150
  # * `:name` - (String) The layer name, which is used by the console.
1110
1151
  # * `:shortname` - (String) The layer short name, which is used
@@ -1150,6 +1191,7 @@ module AWS
1150
1191
  # @!method update_stack(options = {})
1151
1192
  # Calls the UpdateStack API operation.
1152
1193
  # @param [Hash] options
1194
+ #
1153
1195
  # * `:stack_id` - *required* - (String) The stack ID.
1154
1196
  # * `:name` - (String) The stack's new name.
1155
1197
  # * `:attributes` - (Hash<String,String>) One or more user-defined
@@ -1225,6 +1267,7 @@ module AWS
1225
1267
  # @!method update_user_profile(options = {})
1226
1268
  # Calls the UpdateUserProfile API operation.
1227
1269
  # @param [Hash] options
1270
+ #
1228
1271
  # * `:iam_user_arn` - *required* - (String) The user IAM ARN.
1229
1272
  # * `:ssh_username` - (String) The user's new SSH user name.
1230
1273
  # * `:ssh_public_key` - (String) The user's new SSH public key.
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method add_source_identifier_to_subscription(options = {})
26
26
  # Calls the AddSourceIdentifierToSubscription API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:subscription_name` - *required* - (String) The name of the RDS
29
30
  # event notification subscription you want to add a source identifier
30
31
  # to.
@@ -55,6 +56,7 @@ module AWS
55
56
  # @!method add_tags_to_resource(options = {})
56
57
  # Calls the AddTagsToResource API operation.
57
58
  # @param [Hash] options
59
+ #
58
60
  # * `:resource_name` - *required* - (String) The DB Instance the tags
59
61
  # will be added to.
60
62
  # * `:tags` - *required* - (Array<Hash>) The tags to be assigned to the
@@ -76,6 +78,7 @@ module AWS
76
78
  # @!method authorize_db_security_group_ingress(options = {})
77
79
  # Calls the AuthorizeDBSecurityGroupIngress API operation.
78
80
  # @param [Hash] options
81
+ #
79
82
  # * `:db_security_group_name` - *required* - (String) The name of the
80
83
  # DB Security Group to authorize.
81
84
  # * `:cidrip` - (String) The IP range to authorize.
@@ -108,6 +111,7 @@ module AWS
108
111
  # @!method copy_db_snapshot(options = {})
109
112
  # Calls the CopyDBSnapshot API operation.
110
113
  # @param [Hash] options
114
+ #
111
115
  # * `:source_db_snapshot_identifier` - *required* - (String) The
112
116
  # identifier for the source DB snapshot. Constraints: Must be the
113
117
  # identifier for a valid automated snapshot in the "available" state.
@@ -141,6 +145,7 @@ module AWS
141
145
  # @!method create_db_instance(options = {})
142
146
  # Calls the CreateDBInstance API operation.
143
147
  # @param [Hash] options
148
+ #
144
149
  # * `:db_name` - (String) The name of the database to create when the
145
150
  # DB Instance is created. If this parameter is not specified, no
146
151
  # database is created in the DB Instance.
@@ -280,6 +285,7 @@ module AWS
280
285
  # @!method create_db_instance_read_replica(options = {})
281
286
  # Calls the CreateDBInstanceReadReplica API operation.
282
287
  # @param [Hash] options
288
+ #
283
289
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
284
290
  # identifier of the Read Replica. This is the unique key that
285
291
  # identifies a DB Instance. This parameter is stored as a lowercase
@@ -390,6 +396,7 @@ module AWS
390
396
  # @!method create_db_parameter_group(options = {})
391
397
  # Calls the CreateDBParameterGroup API operation.
392
398
  # @param [Hash] options
399
+ #
393
400
  # * `:db_parameter_group_name` - *required* - (String) The name of the
394
401
  # DB Parameter Group.
395
402
  # * `:db_parameter_group_family` - *required* - (String) The name of
@@ -408,6 +415,7 @@ module AWS
408
415
  # @!method create_db_security_group(options = {})
409
416
  # Calls the CreateDBSecurityGroup API operation.
410
417
  # @param [Hash] options
418
+ #
411
419
  # * `:db_security_group_name` - *required* - (String) The name for the
412
420
  # DB Security Group. This value is stored as a lowercase string.
413
421
  # * `:db_security_group_description` - *required* - (String) The
@@ -432,6 +440,7 @@ module AWS
432
440
  # @!method create_db_snapshot(options = {})
433
441
  # Calls the CreateDBSnapshot API operation.
434
442
  # @param [Hash] options
443
+ #
435
444
  # * `:db_snapshot_identifier` - *required* - (String) The identifier
436
445
  # for the DB Snapshot.
437
446
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
@@ -461,6 +470,7 @@ module AWS
461
470
  # @!method create_db_subnet_group(options = {})
462
471
  # Calls the CreateDBSubnetGroup API operation.
463
472
  # @param [Hash] options
473
+ #
464
474
  # * `:db_subnet_group_name` - *required* - (String) The name for the DB
465
475
  # Subnet Group. This value is stored as a lowercase string.
466
476
  # Constraints: Must contain no more than 255 alphanumeric characters
@@ -487,6 +497,7 @@ module AWS
487
497
  # @!method create_event_subscription(options = {})
488
498
  # Calls the CreateEventSubscription API operation.
489
499
  # @param [Hash] options
500
+ #
490
501
  # * `:subscription_name` - *required* - (String) The name of the
491
502
  # subscription. Constraints: The name must be less than 255
492
503
  # characters.
@@ -536,6 +547,7 @@ module AWS
536
547
  # @!method create_option_group(options = {})
537
548
  # Calls the CreateOptionGroup API operation.
538
549
  # @param [Hash] options
550
+ #
539
551
  # * `:option_group_name` - *required* - (String) Specifies the name of
540
552
  # the option group to be created. Constraints: Must be 1 to 255
541
553
  # alphanumeric characters or hyphens First character must be a letter
@@ -583,6 +595,7 @@ module AWS
583
595
  # @!method delete_db_instance(options = {})
584
596
  # Calls the DeleteDBInstance API operation.
585
597
  # @param [Hash] options
598
+ #
586
599
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
587
600
  # identifier for the DB Instance to be deleted. This parameter isn't
588
601
  # case sensitive.
@@ -658,6 +671,7 @@ module AWS
658
671
  # @!method delete_db_parameter_group(options = {})
659
672
  # Calls the DeleteDBParameterGroup API operation.
660
673
  # @param [Hash] options
674
+ #
661
675
  # * `:db_parameter_group_name` - *required* - (String) The name of the
662
676
  # DB Parameter Group. The specified database security group must not
663
677
  # be associated with any DB instances.
@@ -666,6 +680,7 @@ module AWS
666
680
  # @!method delete_db_security_group(options = {})
667
681
  # Calls the DeleteDBSecurityGroup API operation.
668
682
  # @param [Hash] options
683
+ #
669
684
  # * `:db_security_group_name` - *required* - (String) The name of the
670
685
  # database security group to delete.
671
686
  # @return [Core::Response]
@@ -673,6 +688,7 @@ module AWS
673
688
  # @!method delete_db_snapshot(options = {})
674
689
  # Calls the DeleteDBSnapshot API operation.
675
690
  # @param [Hash] options
691
+ #
676
692
  # * `:db_snapshot_identifier` - *required* - (String) The DBSnapshot
677
693
  # identifier.
678
694
  # @return [Core::Response]
@@ -699,6 +715,7 @@ module AWS
699
715
  # @!method delete_db_subnet_group(options = {})
700
716
  # Calls the DeleteDBSubnetGroup API operation.
701
717
  # @param [Hash] options
718
+ #
702
719
  # * `:db_subnet_group_name` - *required* - (String) The name of the
703
720
  # database subnet group to delete. You cannot delete the default
704
721
  # subnet group. Constraints: Must be 1 to 255 alphanumeric characters
@@ -709,6 +726,7 @@ module AWS
709
726
  # @!method delete_event_subscription(options = {})
710
727
  # Calls the DeleteEventSubscription API operation.
711
728
  # @param [Hash] options
729
+ #
712
730
  # * `:subscription_name` - *required* - (String) The name of the RDS
713
731
  # event notification subscription you want to delete.
714
732
  # @return [Core::Response]
@@ -728,6 +746,7 @@ module AWS
728
746
  # @!method delete_option_group(options = {})
729
747
  # Calls the DeleteOptionGroup API operation.
730
748
  # @param [Hash] options
749
+ #
731
750
  # * `:option_group_name` - *required* - (String) The name of the option
732
751
  # group to be deleted. You cannot delete default Option Groups.
733
752
  # @return [Core::Response]
@@ -735,6 +754,7 @@ module AWS
735
754
  # @!method describe_db_engine_versions(options = {})
736
755
  # Calls the DescribeDBEngineVersions API operation.
737
756
  # @param [Hash] options
757
+ #
738
758
  # * `:engine` - (String) The database engine to return.
739
759
  # * `:engine_version` - (String) The database engine version to return.
740
760
  # * `:db_parameter_group_family` - (String) The name of a specific
@@ -777,6 +797,7 @@ module AWS
777
797
  # @!method describe_db_instances(options = {})
778
798
  # Calls the DescribeDBInstances API operation.
779
799
  # @param [Hash] options
800
+ #
780
801
  # * `:db_instance_identifier` - (String) The user-supplied instance
781
802
  # identifier. If this parameter is specified, information from only
782
803
  # the specific DB Instance is returned. This parameter isn't case
@@ -858,6 +879,7 @@ module AWS
858
879
  # @!method describe_db_log_files(options = {})
859
880
  # Calls the DescribeDBLogFiles API operation.
860
881
  # @param [Hash] options
882
+ #
861
883
  # * `:db_instance_identifier` - (String) The customer-assigned name of
862
884
  # the DB Instance that contains the log files you want to list.
863
885
  # Constraints: Must contain from 1 to 63 alphanumeric characters or
@@ -889,6 +911,7 @@ module AWS
889
911
  # @!method describe_db_parameter_groups(options = {})
890
912
  # Calls the DescribeDBParameterGroups API operation.
891
913
  # @param [Hash] options
914
+ #
892
915
  # * `:db_parameter_group_name` - (String) The name of a specific
893
916
  # database parameter group to return details for.
894
917
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -912,6 +935,7 @@ module AWS
912
935
  # @!method describe_db_parameters(options = {})
913
936
  # Calls the DescribeDBParameters API operation.
914
937
  # @param [Hash] options
938
+ #
915
939
  # * `:db_parameter_group_name` - *required* - (String) The name of a
916
940
  # specific database parameter group to return details for.
917
941
  # * `:source` - (String) The parameter types to return.
@@ -943,6 +967,7 @@ module AWS
943
967
  # @!method describe_db_security_groups(options = {})
944
968
  # Calls the DescribeDBSecurityGroups API operation.
945
969
  # @param [Hash] options
970
+ #
946
971
  # * `:db_security_group_name` - (String) The name of the DB Security
947
972
  # Group to return details for.
948
973
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -975,6 +1000,7 @@ module AWS
975
1000
  # @!method describe_db_snapshots(options = {})
976
1001
  # Calls the DescribeDBSnapshots API operation.
977
1002
  # @param [Hash] options
1003
+ #
978
1004
  # * `:db_instance_identifier` - (String) The unique identifier for the
979
1005
  # Amazon RDS DB snapshot. This value is stored as a lowercase string.
980
1006
  # * `:db_snapshot_identifier` - (String) The DB Instance identifier.
@@ -1016,6 +1042,7 @@ module AWS
1016
1042
  # @!method describe_db_subnet_groups(options = {})
1017
1043
  # Calls the DescribeDBSubnetGroups API operation.
1018
1044
  # @param [Hash] options
1045
+ #
1019
1046
  # * `:db_subnet_group_name` - (String) The name of the DB Subnet Group
1020
1047
  # to return details for.
1021
1048
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -1047,6 +1074,7 @@ module AWS
1047
1074
  # @!method describe_engine_default_parameters(options = {})
1048
1075
  # Calls the DescribeEngineDefaultParameters API operation.
1049
1076
  # @param [Hash] options
1077
+ #
1050
1078
  # * `:db_parameter_group_family` - *required* - (String) The name of
1051
1079
  # the DB Parameter Group Family.
1052
1080
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -1078,6 +1106,7 @@ module AWS
1078
1106
  # @!method describe_event_categories(options = {})
1079
1107
  # Calls the DescribeEventCategories API operation.
1080
1108
  # @param [Hash] options
1109
+ #
1081
1110
  # * `:source_type` - (String) The type of source that will be
1082
1111
  # generating the events. Valid values: db-instance |
1083
1112
  # db-parameter-group | db-security-group | db-snapshot
@@ -1092,6 +1121,7 @@ module AWS
1092
1121
  # @!method describe_event_subscriptions(options = {})
1093
1122
  # Calls the DescribeEventSubscriptions API operation.
1094
1123
  # @param [Hash] options
1124
+ #
1095
1125
  # * `:subscription_name` - (String) The name of the RDS event
1096
1126
  # notification subscription you want to describe.
1097
1127
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -1122,6 +1152,7 @@ module AWS
1122
1152
  # @!method describe_events(options = {})
1123
1153
  # Calls the DescribeEvents API operation.
1124
1154
  # @param [Hash] options
1155
+ #
1125
1156
  # * `:source_identifier` - (String) The identifier of the event source
1126
1157
  # for which events will be returned. If not specified, then all
1127
1158
  # sources are included in the response.
@@ -1164,6 +1195,7 @@ module AWS
1164
1195
  # @!method describe_option_group_options(options = {})
1165
1196
  # Calls the DescribeOptionGroupOptions API operation.
1166
1197
  # @param [Hash] options
1198
+ #
1167
1199
  # * `:engine_name` - *required* - (String) A required parameter.
1168
1200
  # Options available for the given Engine name will be described.
1169
1201
  # * `:major_engine_version` - (String) If specified, filters the
@@ -1204,6 +1236,7 @@ module AWS
1204
1236
  # @!method describe_option_groups(options = {})
1205
1237
  # Calls the DescribeOptionGroups API operation.
1206
1238
  # @param [Hash] options
1239
+ #
1207
1240
  # * `:option_group_name` - (String) The name of the option group to
1208
1241
  # describe. Cannot be supplied together with EngineName or
1209
1242
  # MajorEngineVersion.
@@ -1259,6 +1292,7 @@ module AWS
1259
1292
  # @!method describe_orderable_db_instance_options(options = {})
1260
1293
  # Calls the DescribeOrderableDBInstanceOptions API operation.
1261
1294
  # @param [Hash] options
1295
+ #
1262
1296
  # * `:engine` - *required* - (String) The name of the engine to
1263
1297
  # retrieve DB Instance options for.
1264
1298
  # * `:engine_version` - (String) The engine version filter value.
@@ -1301,6 +1335,7 @@ module AWS
1301
1335
  # @!method describe_reserved_db_instances(options = {})
1302
1336
  # Calls the DescribeReservedDBInstances API operation.
1303
1337
  # @param [Hash] options
1338
+ #
1304
1339
  # * `:reserved_db_instance_id` - (String) The reserved DB Instance
1305
1340
  # identifier filter value. Specify this parameter to show only the
1306
1341
  # reservation that matches the specified reservation ID.
@@ -1356,6 +1391,7 @@ module AWS
1356
1391
  # @!method describe_reserved_db_instances_offerings(options = {})
1357
1392
  # Calls the DescribeReservedDBInstancesOfferings API operation.
1358
1393
  # @param [Hash] options
1394
+ #
1359
1395
  # * `:reserved_db_instances_offering_id` - (String) The offering
1360
1396
  # identifier filter value. Specify this parameter to show only the
1361
1397
  # available offering that matches the specified reservation
@@ -1405,6 +1441,7 @@ module AWS
1405
1441
  # @!method download_db_log_file_portion(options = {})
1406
1442
  # Calls the DownloadDBLogFilePortion API operation.
1407
1443
  # @param [Hash] options
1444
+ #
1408
1445
  # * `:db_instance_identifier` - (String)
1409
1446
  # * `:log_file_name` - (String)
1410
1447
  # * `:marker` - (String) The pagination token provided in the previous
@@ -1423,6 +1460,7 @@ module AWS
1423
1460
  # @!method list_tags_for_resource(options = {})
1424
1461
  # Calls the ListTagsForResource API operation.
1425
1462
  # @param [Hash] options
1463
+ #
1426
1464
  # * `:resource_name` - *required* - (String) The DB Instance with tags
1427
1465
  # to be listed.
1428
1466
  # @return [Core::Response]
@@ -1436,6 +1474,7 @@ module AWS
1436
1474
  # @!method modify_db_instance(options = {})
1437
1475
  # Calls the ModifyDBInstance API operation.
1438
1476
  # @param [Hash] options
1477
+ #
1439
1478
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
1440
1479
  # identifier. This value is stored as a lowercase string.
1441
1480
  # * `:allocated_storage` - (Integer) The new storage capacity of the
@@ -1584,6 +1623,7 @@ module AWS
1584
1623
  # @!method modify_db_parameter_group(options = {})
1585
1624
  # Calls the ModifyDBParameterGroup API operation.
1586
1625
  # @param [Hash] options
1626
+ #
1587
1627
  # * `:db_parameter_group_name` - *required* - (String) The name of the
1588
1628
  # database parameter group.
1589
1629
  # * `:parameters` - *required* - (Array<Hash>) An array of parameter
@@ -1622,6 +1662,7 @@ module AWS
1622
1662
  # @!method modify_db_subnet_group(options = {})
1623
1663
  # Calls the ModifyDBSubnetGroup API operation.
1624
1664
  # @param [Hash] options
1665
+ #
1625
1666
  # * `:db_subnet_group_name` - *required* - (String) The name for the DB
1626
1667
  # Subnet Group. This value is stored as a lowercase string.
1627
1668
  # Constraints: Must contain no more than 255 alphanumeric characters
@@ -1648,6 +1689,7 @@ module AWS
1648
1689
  # @!method modify_event_subscription(options = {})
1649
1690
  # Calls the ModifyEventSubscription API operation.
1650
1691
  # @param [Hash] options
1692
+ #
1651
1693
  # * `:subscription_name` - *required* - (String) The name of the RDS
1652
1694
  # event notification subscription.
1653
1695
  # * `:sns_topic_arn` - (String) The Amazon Resource Name (ARN) of the
@@ -1683,6 +1725,7 @@ module AWS
1683
1725
  # @!method modify_option_group(options = {})
1684
1726
  # Calls the ModifyOptionGroup API operation.
1685
1727
  # @param [Hash] options
1728
+ #
1686
1729
  # * `:option_group_name` - *required* - (String) The name of the option
1687
1730
  # group to be modified.
1688
1731
  # * `:options_to_include` - (Array<Hash>) Options in this list are
@@ -1751,6 +1794,7 @@ module AWS
1751
1794
  # @!method promote_read_replica(options = {})
1752
1795
  # Calls the PromoteReadReplica API operation.
1753
1796
  # @param [Hash] options
1797
+ #
1754
1798
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
1755
1799
  # identifier. This value is stored as a lowercase string.
1756
1800
  # Constraints: Must be the identifier for an existing Read Replica DB
@@ -1841,6 +1885,7 @@ module AWS
1841
1885
  # @!method purchase_reserved_db_instances_offering(options = {})
1842
1886
  # Calls the PurchaseReservedDBInstancesOffering API operation.
1843
1887
  # @param [Hash] options
1888
+ #
1844
1889
  # * `:reserved_db_instances_offering_id` - *required* - (String) The ID
1845
1890
  # of the Reserved DB Instance offering to purchase. Example:
1846
1891
  # 438012d3-4052-4cc7-b2e3-8d3372e0e706
@@ -1872,6 +1917,7 @@ module AWS
1872
1917
  # @!method reboot_db_instance(options = {})
1873
1918
  # Calls the RebootDBInstance API operation.
1874
1919
  # @param [Hash] options
1920
+ #
1875
1921
  # * `:db_instance_identifier` - *required* - (String) The DB Instance
1876
1922
  # identifier. This parameter is stored as a lowercase string.
1877
1923
  # * `:force_failover` - (Boolean) When `true` , the reboot will be
@@ -1944,6 +1990,7 @@ module AWS
1944
1990
  # @!method remove_source_identifier_from_subscription(options = {})
1945
1991
  # Calls the RemoveSourceIdentifierFromSubscription API operation.
1946
1992
  # @param [Hash] options
1993
+ #
1947
1994
  # * `:subscription_name` - *required* - (String) The name of the RDS
1948
1995
  # event notification subscription you want to remove a source
1949
1996
  # identifier from.
@@ -1967,6 +2014,7 @@ module AWS
1967
2014
  # @!method remove_tags_from_resource(options = {})
1968
2015
  # Calls the RemoveTagsFromResource API operation.
1969
2016
  # @param [Hash] options
2017
+ #
1970
2018
  # * `:resource_name` - *required* - (String) The DB Instance the tags
1971
2019
  # will be removed from.
1972
2020
  # * `:tag_keys` - *required* - (Array<String>) The tag key (name) of
@@ -1976,6 +2024,7 @@ module AWS
1976
2024
  # @!method reset_db_parameter_group(options = {})
1977
2025
  # Calls the ResetDBParameterGroup API operation.
1978
2026
  # @param [Hash] options
2027
+ #
1979
2028
  # * `:db_parameter_group_name` - *required* - (String) The name of the
1980
2029
  # DB Parameter Group.
1981
2030
  # * `:reset_all_parameters` - (Boolean) Specifies whether ( `true` ) or
@@ -2017,6 +2066,7 @@ module AWS
2017
2066
  # @!method restore_db_instance_from_db_snapshot(options = {})
2018
2067
  # Calls the RestoreDBInstanceFromDBSnapshot API operation.
2019
2068
  # @param [Hash] options
2069
+ #
2020
2070
  # * `:db_instance_identifier` - *required* - (String) The identifier
2021
2071
  # for the DB Snapshot to restore from.
2022
2072
  # * `:db_snapshot_identifier` - *required* - (String) Name of the DB
@@ -2128,6 +2178,7 @@ module AWS
2128
2178
  # @!method restore_db_instance_to_point_in_time(options = {})
2129
2179
  # Calls the RestoreDBInstanceToPointInTime API operation.
2130
2180
  # @param [Hash] options
2181
+ #
2131
2182
  # * `:source_db_instance_identifier` - *required* - (String) The
2132
2183
  # identifier of the source DB Instance from which to restore.
2133
2184
  # * `:target_db_instance_identifier` - *required* - (String) The name
@@ -2243,6 +2294,7 @@ module AWS
2243
2294
  # @!method revoke_db_security_group_ingress(options = {})
2244
2295
  # Calls the RevokeDBSecurityGroupIngress API operation.
2245
2296
  # @param [Hash] options
2297
+ #
2246
2298
  # * `:db_security_group_name` - *required* - (String) The name of the
2247
2299
  # DB Security Group to revoke ingress from.
2248
2300
  # * `:cidrip` - (String) The IP range to revoke access from.