aws-sdk 1.11.2 → 1.11.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method authorize_cluster_security_group_ingress(options = {})
26
26
  # Calls the AuthorizeClusterSecurityGroupIngress API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:cluster_security_group_name` - *required* - (String) The name of
29
30
  # the security group to which the ingress rule is added.
30
31
  # * `:cidrip` - (String) The IP range to be added the Amazon Redshift
@@ -52,6 +53,7 @@ module AWS
52
53
  # @!method copy_cluster_snapshot(options = {})
53
54
  # Calls the CopyClusterSnapshot API operation.
54
55
  # @param [Hash] options
56
+ #
55
57
  # * `:source_snapshot_identifier` - *required* - (String) The
56
58
  # identifier for the source snapshot. Constraints: Must be the
57
59
  # identifier for a valid automated snapshot whose state is
@@ -84,6 +86,7 @@ module AWS
84
86
  # @!method create_cluster(options = {})
85
87
  # Calls the CreateCluster API operation.
86
88
  # @param [Hash] options
89
+ #
87
90
  # * `:db_name` - (String) The name of the first database to be created
88
91
  # when the cluster is created. To create additional databases after
89
92
  # the cluster is created, connect to the cluster with a SQL client
@@ -237,6 +240,7 @@ module AWS
237
240
  # @!method create_cluster_parameter_group(options = {})
238
241
  # Calls the CreateClusterParameterGroup API operation.
239
242
  # @param [Hash] options
243
+ #
240
244
  # * `:parameter_group_name` - *required* - (String) The name of the
241
245
  # cluster parameter group. Constraints: Must be 1 to 255 alphanumeric
242
246
  # characters or hyphens First character must be a letter. Cannot end
@@ -266,6 +270,7 @@ module AWS
266
270
  # @!method create_cluster_security_group(options = {})
267
271
  # Calls the CreateClusterSecurityGroup API operation.
268
272
  # @param [Hash] options
273
+ #
269
274
  # * `:cluster_security_group_name` - *required* - (String) The name for
270
275
  # the security group. Amazon Redshift stores the value as a lowercase
271
276
  # string. Constraints: Must contain no more than 255 alphanumeric
@@ -291,6 +296,7 @@ module AWS
291
296
  # @!method create_cluster_snapshot(options = {})
292
297
  # Calls the CreateClusterSnapshot API operation.
293
298
  # @param [Hash] options
299
+ #
294
300
  # * `:snapshot_identifier` - *required* - (String) A unique identifier
295
301
  # for the snapshot that you are requesting. This identifier must be
296
302
  # unique for all snapshots within the AWS account. Constraints:
@@ -322,6 +328,7 @@ module AWS
322
328
  # @!method create_cluster_subnet_group(options = {})
323
329
  # Calls the CreateClusterSubnetGroup API operation.
324
330
  # @param [Hash] options
331
+ #
325
332
  # * `:cluster_subnet_group_name` - *required* - (String) The name for
326
333
  # the subnet group. Amazon Redshift stores the value as a lowercase
327
334
  # string. Constraints: Must contain no more than 255 alphanumeric
@@ -349,6 +356,7 @@ module AWS
349
356
  # @!method delete_cluster(options = {})
350
357
  # Calls the DeleteCluster API operation.
351
358
  # @param [Hash] options
359
+ #
352
360
  # * `:cluster_identifier` - *required* - (String) The identifier of the
353
361
  # cluster to be deleted. Constraints: Must contain lowercase
354
362
  # characters. Must contain from 1 to 63 alphanumeric characters or
@@ -410,6 +418,7 @@ module AWS
410
418
  # @!method delete_cluster_parameter_group(options = {})
411
419
  # Calls the DeleteClusterParameterGroup API operation.
412
420
  # @param [Hash] options
421
+ #
413
422
  # * `:parameter_group_name` - *required* - (String) The name of the
414
423
  # parameter group to be deleted. Constraints: Must be the name of an
415
424
  # existing cluster parameter group. Cannot delete a default cluster
@@ -419,6 +428,7 @@ module AWS
419
428
  # @!method delete_cluster_security_group(options = {})
420
429
  # Calls the DeleteClusterSecurityGroup API operation.
421
430
  # @param [Hash] options
431
+ #
422
432
  # * `:cluster_security_group_name` - *required* - (String) The name of
423
433
  # the cluster security group to be deleted.
424
434
  # @return [Core::Response]
@@ -426,6 +436,7 @@ module AWS
426
436
  # @!method delete_cluster_snapshot(options = {})
427
437
  # Calls the DeleteClusterSnapshot API operation.
428
438
  # @param [Hash] options
439
+ #
429
440
  # * `:snapshot_identifier` - *required* - (String) The unique
430
441
  # identifier of the manual snapshot to be deleted. Constraints: Must
431
442
  # be the name of an existing snapshot that is in the available state.
@@ -451,6 +462,7 @@ module AWS
451
462
  # @!method delete_cluster_subnet_group(options = {})
452
463
  # Calls the DeleteClusterSubnetGroup API operation.
453
464
  # @param [Hash] options
465
+ #
454
466
  # * `:cluster_subnet_group_name` - *required* - (String) The name of
455
467
  # the cluster subnet group name to be deleted.
456
468
  # @return [Core::Response]
@@ -458,6 +470,7 @@ module AWS
458
470
  # @!method describe_cluster_parameter_groups(options = {})
459
471
  # Calls the DescribeClusterParameterGroups API operation.
460
472
  # @param [Hash] options
473
+ #
461
474
  # * `:parameter_group_name` - (String) The name of a specific parameter
462
475
  # group for which to return details. By default, details about all
463
476
  # parameter groups and the default parameter group are returned.
@@ -483,6 +496,7 @@ module AWS
483
496
  # @!method describe_cluster_parameters(options = {})
484
497
  # Calls the DescribeClusterParameters API operation.
485
498
  # @param [Hash] options
499
+ #
486
500
  # * `:parameter_group_name` - *required* - (String) The name of a
487
501
  # cluster parameter group for which to return details.
488
502
  # * `:source` - (String) The parameter types to return. Specify user to
@@ -517,6 +531,7 @@ module AWS
517
531
  # @!method describe_cluster_security_groups(options = {})
518
532
  # Calls the DescribeClusterSecurityGroups API operation.
519
533
  # @param [Hash] options
534
+ #
520
535
  # * `:cluster_security_group_name` - (String) The name of a cluster
521
536
  # security group for which you are requesting details. You can
522
537
  # specify either the Marker parameter or a ClusterSecurityGroupName
@@ -551,6 +566,7 @@ module AWS
551
566
  # @!method describe_cluster_snapshots(options = {})
552
567
  # Calls the DescribeClusterSnapshots API operation.
553
568
  # @param [Hash] options
569
+ #
554
570
  # * `:cluster_identifier` - (String) The identifier of the cluster for
555
571
  # which information about snapshots is requested.
556
572
  # * `:snapshot_identifier` - (String) The snapshot identifier of the
@@ -601,6 +617,7 @@ module AWS
601
617
  # @!method describe_cluster_subnet_groups(options = {})
602
618
  # Calls the DescribeClusterSubnetGroups API operation.
603
619
  # @param [Hash] options
620
+ #
604
621
  # * `:cluster_subnet_group_name` - (String) The name of the cluster
605
622
  # subnet group for which information is requested.
606
623
  # * `:max_records` - (Integer) The maximum number of cluster subnet
@@ -632,6 +649,7 @@ module AWS
632
649
  # @!method describe_cluster_versions(options = {})
633
650
  # Calls the DescribeClusterVersions API operation.
634
651
  # @param [Hash] options
652
+ #
635
653
  # * `:cluster_version` - (String) The specific cluster version to
636
654
  # return. Example: 1.0
637
655
  # * `:cluster_parameter_group_family` - (String) The name of a specific
@@ -659,6 +677,7 @@ module AWS
659
677
  # @!method describe_clusters(options = {})
660
678
  # Calls the DescribeClusters API operation.
661
679
  # @param [Hash] options
680
+ #
662
681
  # * `:cluster_identifier` - (String) The unique identifier of a cluster
663
682
  # whose properties you are requesting. This parameter isn't case
664
683
  # sensitive. The default is that all clusters defined for an account
@@ -719,6 +738,7 @@ module AWS
719
738
  # @!method describe_default_cluster_parameters(options = {})
720
739
  # Calls the DescribeDefaultClusterParameters API operation.
721
740
  # @param [Hash] options
741
+ #
722
742
  # * `:parameter_group_family` - *required* - (String) The name of the
723
743
  # cluster parameter group family.
724
744
  # * `:max_records` - (Integer) The maximum number of records to include
@@ -749,6 +769,7 @@ module AWS
749
769
  # @!method describe_events(options = {})
750
770
  # Calls the DescribeEvents API operation.
751
771
  # @param [Hash] options
772
+ #
752
773
  # * `:source_identifier` - (String) The identifier of the event source
753
774
  # for which events will be returned. If this parameter is not
754
775
  # specified, then all sources are included in the response.
@@ -807,6 +828,7 @@ module AWS
807
828
  # @!method describe_orderable_cluster_options(options = {})
808
829
  # Calls the DescribeOrderableClusterOptions API operation.
809
830
  # @param [Hash] options
831
+ #
810
832
  # * `:cluster_version` - (String) The version filter value. Specify
811
833
  # this parameter to show only the available offerings matching the
812
834
  # specified version. Default: All versions. Constraints: Must be one
@@ -838,6 +860,7 @@ module AWS
838
860
  # @!method describe_reserved_node_offerings(options = {})
839
861
  # Calls the DescribeReservedNodeOfferings API operation.
840
862
  # @param [Hash] options
863
+ #
841
864
  # * `:reserved_node_offering_id` - (String) The unique identifier for
842
865
  # the offering.
843
866
  # * `:node_type` - (String) The node type you can purchase. For more
@@ -875,6 +898,7 @@ module AWS
875
898
  # @!method describe_reserved_nodes(options = {})
876
899
  # Calls the DescribeReservedNodes API operation.
877
900
  # @param [Hash] options
901
+ #
878
902
  # * `:reserved_node_id` - (String) Customer specified identifier for
879
903
  # the node reservation.
880
904
  # * `:reserved_node_offering_id` - (String) The reserved node offering
@@ -914,6 +938,7 @@ module AWS
914
938
  # @!method describe_resize(options = {})
915
939
  # Calls the DescribeResize API operation.
916
940
  # @param [Hash] options
941
+ #
917
942
  # * `:cluster_identifier` - *required* - (String) The unique identifier
918
943
  # of a cluster whose resize progress you are requesting. This
919
944
  # parameter isn't case sensitive. The default is that all clusters
@@ -933,6 +958,7 @@ module AWS
933
958
  # @!method modify_cluster(options = {})
934
959
  # Calls the ModifyCluster API operation.
935
960
  # @param [Hash] options
961
+ #
936
962
  # * `:cluster_identifier` - *required* - (String) The unique identifier
937
963
  # of the cluster to be modified. Example: examplecluster
938
964
  # * `:cluster_type` - (String) The new cluster type. When you submit
@@ -1061,6 +1087,7 @@ module AWS
1061
1087
  # @!method modify_cluster_parameter_group(options = {})
1062
1088
  # Calls the ModifyClusterParameterGroup API operation.
1063
1089
  # @param [Hash] options
1090
+ #
1064
1091
  # * `:parameter_group_name` - *required* - (String) The name of the
1065
1092
  # parameter group to be modified.
1066
1093
  # * `:parameters` - *required* - (Array<Hash>) An array of parameters
@@ -1091,6 +1118,7 @@ module AWS
1091
1118
  # @!method modify_cluster_subnet_group(options = {})
1092
1119
  # Calls the ModifyClusterSubnetGroup API operation.
1093
1120
  # @param [Hash] options
1121
+ #
1094
1122
  # * `:cluster_subnet_group_name` - *required* - (String) The name of
1095
1123
  # the parameter group to be modified.
1096
1124
  # * `:description` - (String) The name of the parameter group to be
@@ -1114,6 +1142,7 @@ module AWS
1114
1142
  # @!method purchase_reserved_node_offering(options = {})
1115
1143
  # Calls the PurchaseReservedNodeOffering API operation.
1116
1144
  # @param [Hash] options
1145
+ #
1117
1146
  # * `:reserved_node_offering_id` - *required* - (String) The unique
1118
1147
  # identifier of the reserved node offering you want to purchase.
1119
1148
  # * `:reserved_node_id` - (String)
@@ -1141,6 +1170,7 @@ module AWS
1141
1170
  # @!method reboot_cluster(options = {})
1142
1171
  # Calls the RebootCluster API operation.
1143
1172
  # @param [Hash] options
1173
+ #
1144
1174
  # * `:cluster_identifier` - *required* - (String) The cluster
1145
1175
  # identifier.
1146
1176
  # @return [Core::Response]
@@ -1186,6 +1216,7 @@ module AWS
1186
1216
  # @!method reset_cluster_parameter_group(options = {})
1187
1217
  # Calls the ResetClusterParameterGroup API operation.
1188
1218
  # @param [Hash] options
1219
+ #
1189
1220
  # * `:parameter_group_name` - *required* - (String) The name of the
1190
1221
  # cluster parameter group to be reset.
1191
1222
  # * `:reset_all_parameters` - (Boolean) If `true` , all parameters in
@@ -1218,6 +1249,7 @@ module AWS
1218
1249
  # @!method restore_from_cluster_snapshot(options = {})
1219
1250
  # Calls the RestoreFromClusterSnapshot API operation.
1220
1251
  # @param [Hash] options
1252
+ #
1221
1253
  # * `:cluster_identifier` - *required* - (String) The identifier of the
1222
1254
  # cluster that will be created from restoring the snapshot.
1223
1255
  # Constraints: Must contain from 1 to 63 alphanumeric characters or
@@ -1286,6 +1318,7 @@ module AWS
1286
1318
  # @!method revoke_cluster_security_group_ingress(options = {})
1287
1319
  # Calls the RevokeClusterSecurityGroupIngress API operation.
1288
1320
  # @param [Hash] options
1321
+ #
1289
1322
  # * `:cluster_security_group_name` - *required* - (String) The name of
1290
1323
  # the security Group from which to revoke the ingress rule.
1291
1324
  # * `:cidrip` - (String) The IP range for which to revoke access. This
@@ -25,120 +25,123 @@ module AWS
25
25
  # @!method change_resource_record_sets(options = {})
26
26
  # Calls the POST ChangeResourceRecordSets API operation.
27
27
  # @param [Hash] options
28
- # * `:hosted_zone_id` - *required* - (String) Alias resource record sets
29
- # only: The value of the hosted zone ID, CanonicalHostedZoneNameId, for
30
- # the LoadBalancer. Currently, Route 53 supports alias resource record
31
- # sets only for Elastic Load Balancing. For more information, an
32
- # example, and several ways to get the hosted zone ID for the
33
- # LoadBalancer, see Creating Alias Resource Record Sets for Elastic
34
- # Load Balancing in the Amazon Route 53 Developer Guide.
35
- # * `:change_batch` - *required* - (Hash) A complex type that contains an
36
- # optional comment and the Changes element.
37
- # * `:comment` - (String) Optional: Any comments you want to include
38
- # about a change batch request.
39
- # * `:changes` - *required* - (Array<Hash>) A complex type that
40
- # contains one Change element for each resource record set that you
41
- # want to create or delete.
42
- # * `:action` - *required* - (String) The action to perform. Valid
43
- # values: CREATE | DELETE Valid values include:
44
- # * `CREATE`
45
- # * `DELETE`
46
- # * `:resource_record_set` - *required* - (Hash) Information about
47
- # the resource record set to create or delete.
48
- # * `:name` - *required* - (String) The domain name of the current
49
- # resource record set.
50
- # * `:type` - *required* - (String) The type of the current
51
- # resource record set. Valid values include:
52
- # * `SOA`
53
- # * `A`
54
- # * `TXT`
55
- # * `NS`
56
- # * `CNAME`
57
- # * `MX`
58
- # * `PTR`
59
- # * `SRV`
60
- # * `SPF`
61
- # * `AAAA`
62
- # * `:set_identifier` - (String) Weighted resource record sets
63
- # only: An identifier that differentiates among multiple resource
64
- # record sets that have the same combination of DNS name and
65
- # type.
66
- # * `:weight` - (Integer) Weighted resource record sets only: Among
67
- # resource record sets that have the same combination of DNS name
68
- # and type, a value that determines what portion of traffic for
69
- # the current resource record set is routed to the associated
70
- # location.
71
- # * `:region` - (String) Regional resource record sets only: Among
72
- # resource record sets that have the same combination of DNS name
73
- # and type, a value that specifies the AWS region for the current
74
- # resource record set. Valid values include:
75
- # * `us-east-1`
76
- # * `us-west-1`
77
- # * `us-west-2`
78
- # * `eu-west-1`
79
- # * `ap-southeast-1`
80
- # * `ap-southeast-2`
81
- # * `ap-northeast-1`
82
- # * `sa-east-1`
83
- # * `:failover` - (String) Failover resource record sets only:
84
- # Among resource record sets that have the same combination of
85
- # DNS name and type, a value that indicates whether the current
86
- # resource record set is a primary or secondary resource record
87
- # set. A failover set may contain at most one resource record set
88
- # marked as primary and one resource record set marked as
89
- # secondary. A resource record set marked as primary will be
90
- # returned if any of the following are `true` : (1) an associated
91
- # health check is passing, (2) if the resource record set is an
92
- # alias with the evaluate target health and at least one target
93
- # resource record set is healthy, (3) both the primary and
94
- # secondary resource record set are failing health checks or (4)
95
- # there is no secondary resource record set. A secondary resource
96
- # record set will be returned if: (1) the primary is failing a
97
- # health check and either the secondary is passing a health check
98
- # or has no associated health check, or (2) there is no primary
99
- # resource record set. Valid values: PRIMARY | SECONDARY Valid
100
- # values include:
101
- # * `PRIMARY`
102
- # * `SECONDARY`
103
- # * `:ttl` - (Integer) The cache time to live for the current
104
- # resource record set.
105
- # * `:resource_records` - (Array<Hash>) A complex type that
106
- # contains the resource records for the current resource record
107
- # set.
108
- # * `:value` - *required* - (String) The value of the Value
109
- # element for the current resource record set.
110
- # * `:alias_target` - (Hash) Alias resource record sets only:
111
- # Information about the Elastic Load Balancing LoadBalancer to
112
- # which you are redirecting traffic.
113
- # * `:hosted_zone_id` - *required* - (String) Alias resource
114
- # record sets only: The value of the hosted zone ID,
115
- # CanonicalHostedZoneNameId, for the LoadBalancer. Currently,
116
- # Route 53 supports alias resource record sets only for Elastic
117
- # Load Balancing. For more information, an example, and several
118
- # ways to get the hosted zone ID for the LoadBalancer, see
119
- # Creating Alias Resource Record Sets for Elastic Load
120
- # Balancing in the Amazon Route 53 Developer Guide.
121
- # * `:dns_name` - *required* - (String) Alias resource record
122
- # sets only: The external DNS name associated with the
123
- # LoadBalancer. Currently, Route 53 supports alias resource
124
- # record sets only for Elastic Load Balancing. For more
125
- # information, an example, and several ways to get the hosted
126
- # zone ID for the LoadBalancer, see Creating Alias Resource
127
- # Record Sets for Elastic Load Balancing in the Amazon Route 53
128
- # Developer Guide.
129
- # * `:evaluate_target_health` - *required* - (Boolean) Alias
130
- # resource record sets only: A boolean value that indicates
131
- # whether this Resource Record Set should respect the health
132
- # status of any health checks associated with the ALIAS target
133
- # record which it is linked to. Currently, Route 53 supports
134
- # health checks only for Elastic Load Balancing. For more
135
- # information, an example, see Creating Alias Resource Record
136
- # Sets for Elastic Load Balancing in the Amazon Route 53
137
- # Developer Guide.
138
- # * `:health_check_id` - (String) Health Check resource record sets
139
- # only, not required for alias resource record sets: An
140
- # identifier that is used to identify health check associated
141
- # with the resource record set.
28
+ #
29
+ # * `:hosted_zone_id` - *required* - (String) Alias resource record
30
+ # sets only: The value of the hosted zone ID,
31
+ # CanonicalHostedZoneNameId, for the LoadBalancer. Currently, Route
32
+ # 53 supports alias resource record sets only for Elastic Load
33
+ # Balancing. For more information, an example, and several ways to
34
+ # get the hosted zone ID for the LoadBalancer, see Creating Alias
35
+ # Resource Record Sets for Elastic Load Balancing in the Amazon Route
36
+ # 53 Developer Guide.
37
+ # * `:change_batch` - *required* - (Hash) A complex type that contains
38
+ # an optional comment and the Changes element.
39
+ # * `:comment` - (String) Optional: Any comments you want to include
40
+ # about a change batch request.
41
+ # * `:changes` - *required* - (Array<Hash>) A complex type that
42
+ # contains one Change element for each resource record set that you
43
+ # want to create or delete.
44
+ # * `:action` - *required* - (String) The action to perform. Valid
45
+ # values: CREATE | DELETE Valid values include:
46
+ # * `CREATE`
47
+ # * `DELETE`
48
+ # * `:resource_record_set` - *required* - (Hash) Information about
49
+ # the resource record set to create or delete.
50
+ # * `:name` - *required* - (String) The domain name of the
51
+ # current resource record set.
52
+ # * `:type` - *required* - (String) The type of the current
53
+ # resource record set. Valid values include:
54
+ # * `SOA`
55
+ # * `A`
56
+ # * `TXT`
57
+ # * `NS`
58
+ # * `CNAME`
59
+ # * `MX`
60
+ # * `PTR`
61
+ # * `SRV`
62
+ # * `SPF`
63
+ # * `AAAA`
64
+ # * `:set_identifier` - (String) Weighted resource record sets
65
+ # only: An identifier that differentiates among multiple
66
+ # resource record sets that have the same combination of DNS
67
+ # name and type.
68
+ # * `:weight` - (Integer) Weighted resource record sets only:
69
+ # Among resource record sets that have the same combination of
70
+ # DNS name and type, a value that determines what portion of
71
+ # traffic for the current resource record set is routed to the
72
+ # associated location.
73
+ # * `:region` - (String) Regional resource record sets only:
74
+ # Among resource record sets that have the same combination of
75
+ # DNS name and type, a value that specifies the AWS region for
76
+ # the current resource record set. Valid values include:
77
+ # * `us-east-1`
78
+ # * `us-west-1`
79
+ # * `us-west-2`
80
+ # * `eu-west-1`
81
+ # * `ap-southeast-1`
82
+ # * `ap-southeast-2`
83
+ # * `ap-northeast-1`
84
+ # * `sa-east-1`
85
+ # * `:failover` - (String) Failover resource record sets only:
86
+ # Among resource record sets that have the same combination of
87
+ # DNS name and type, a value that indicates whether the current
88
+ # resource record set is a primary or secondary resource record
89
+ # set. A failover set may contain at most one resource record
90
+ # set marked as primary and one resource record set marked as
91
+ # secondary. A resource record set marked as primary will be
92
+ # returned if any of the following are `true` : (1) an
93
+ # associated health check is passing, (2) if the resource
94
+ # record set is an alias with the evaluate target health and at
95
+ # least one target resource record set is healthy, (3) both the
96
+ # primary and secondary resource record set are failing health
97
+ # checks or (4) there is no secondary resource record set. A
98
+ # secondary resource record set will be returned if: (1) the
99
+ # primary is failing a health check and either the secondary is
100
+ # passing a health check or has no associated health check, or
101
+ # (2) there is no primary resource record set. Valid values:
102
+ # PRIMARY | SECONDARY Valid values include:
103
+ # * `PRIMARY`
104
+ # * `SECONDARY`
105
+ # * `:ttl` - (Integer) The cache time to live for the current
106
+ # resource record set.
107
+ # * `:resource_records` - (Array<Hash>) A complex type that
108
+ # contains the resource records for the current resource record
109
+ # set.
110
+ # * `:value` - *required* - (String) The value of the Value
111
+ # element for the current resource record set.
112
+ # * `:alias_target` - (Hash) Alias resource record sets only:
113
+ # Information about the Elastic Load Balancing LoadBalancer to
114
+ # which you are redirecting traffic.
115
+ # * `:hosted_zone_id` - *required* - (String) Alias resource
116
+ # record sets only: The value of the hosted zone ID,
117
+ # CanonicalHostedZoneNameId, for the LoadBalancer. Currently,
118
+ # Route 53 supports alias resource record sets only for
119
+ # Elastic Load Balancing. For more information, an example,
120
+ # and several ways to get the hosted zone ID for the
121
+ # LoadBalancer, see Creating Alias Resource Record Sets for
122
+ # Elastic Load Balancing in the Amazon Route 53 Developer
123
+ # Guide.
124
+ # * `:dns_name` - *required* - (String) Alias resource record
125
+ # sets only: The external DNS name associated with the
126
+ # LoadBalancer. Currently, Route 53 supports alias resource
127
+ # record sets only for Elastic Load Balancing. For more
128
+ # information, an example, and several ways to get the hosted
129
+ # zone ID for the LoadBalancer, see Creating Alias Resource
130
+ # Record Sets for Elastic Load Balancing in the Amazon Route
131
+ # 53 Developer Guide.
132
+ # * `:evaluate_target_health` - *required* - (Boolean) Alias
133
+ # resource record sets only: A boolean value that indicates
134
+ # whether this Resource Record Set should respect the health
135
+ # status of any health checks associated with the ALIAS
136
+ # target record which it is linked to. Currently, Route 53
137
+ # supports health checks only for Elastic Load Balancing. For
138
+ # more information, an example, see Creating Alias Resource
139
+ # Record Sets for Elastic Load Balancing in the Amazon Route
140
+ # 53 Developer Guide.
141
+ # * `:health_check_id` - (String) Health Check resource record
142
+ # sets only, not required for alias resource record sets: An
143
+ # identifier that is used to identify health check associated
144
+ # with the resource record set.
142
145
  # @return [Core::Response]
143
146
  # The #data method of the response object returns
144
147
  # a hash with the following structure:
@@ -152,32 +155,33 @@ module AWS
152
155
  # @!method create_health_check(options = {})
153
156
  # Calls the POST CreateHealthCheck API operation.
154
157
  # @param [Hash] options
155
- # * `:caller_reference` - *required* - (String) A unique string that
156
- # identifies the request and that allows failed CreateHealthCheck
157
- # requests to be retried without the risk of executing the operation
158
- # twice. You must use a unique CallerReference string every time you
159
- # create a health check. CallerReference can be any unique string; you
160
- # might choose to use a string that identifies your project. Valid
161
- # characters are any Unicode code points that are legal in an XML 1.0
162
- # document. The UTF-8 encoding of the value must be less than 128
163
- # bytes.
164
- # * `:health_check_config` - *required* - (Hash) A complex type that
165
- # contains health check configuration.
166
- # * `:ip_address` - *required* - (String) IP Address of the instance
167
- # being checked.
168
- # * `:port` - (Integer) Port on which connection will be opened to the
169
- # instance to health check. For HTTP this defaults to 80 if the port
170
- # is not specified.
171
- # * `:type` - *required* - (String) The type of health check to be
172
- # performed. Currently supported protocols are TCP and HTTP. Valid
173
- # values include:
174
- # * `HTTP`
175
- # * `TCP`
176
- # * `:resource_path` - (String) Path to ping on the instance to check
177
- # the health. Required only for HTTP health checks, HTTP request is
178
- # issued to the instance on the given port and path.
179
- # * `:fully_qualified_domain_name` - (String) Fully qualified domain
180
- # name of the instance to be health checked.
158
+ #
159
+ # * `:caller_reference` - *required* - (String) A unique string that
160
+ # identifies the request and that allows failed CreateHealthCheck
161
+ # requests to be retried without the risk of executing the operation
162
+ # twice. You must use a unique CallerReference string every time you
163
+ # create a health check. CallerReference can be any unique string;
164
+ # you might choose to use a string that identifies your project.
165
+ # Valid characters are any Unicode code points that are legal in an
166
+ # XML 1.0 document. The UTF-8 encoding of the value must be less than
167
+ # 128 bytes.
168
+ # * `:health_check_config` - *required* - (Hash) A complex type that
169
+ # contains health check configuration.
170
+ # * `:ip_address` - *required* - (String) IP Address of the instance
171
+ # being checked.
172
+ # * `:port` - (Integer) Port on which connection will be opened to
173
+ # the instance to health check. For HTTP this defaults to 80 if the
174
+ # port is not specified.
175
+ # * `:type` - *required* - (String) The type of health check to be
176
+ # performed. Currently supported protocols are TCP and HTTP. Valid
177
+ # values include:
178
+ # * `HTTP`
179
+ # * `TCP`
180
+ # * `:resource_path` - (String) Path to ping on the instance to check
181
+ # the health. Required only for HTTP health checks, HTTP request is
182
+ # issued to the instance on the given port and path.
183
+ # * `:fully_qualified_domain_name` - (String) Fully qualified domain
184
+ # name of the instance to be health checked.
181
185
  # @return [Core::Response]
182
186
  # The #data method of the response object returns
183
187
  # a hash with the following structure:
@@ -195,29 +199,30 @@ module AWS
195
199
  # @!method create_hosted_zone(options = {})
196
200
  # Calls the POST CreateHostedZone API operation.
197
201
  # @param [Hash] options
198
- # * `:name` - *required* - (String) The name of the domain. This must be
199
- # a fully-specified domain, for example, www.example.com. The trailing
200
- # dot is optional; Route 53 assumes that the domain name is fully
201
- # qualified. This means that Route 53 treats www.example.com (without a
202
- # trailing dot) and www.example.com. (with a trailing dot) as
203
- # identical. This is the name you have registered with your DNS
204
- # registrar. You should ask your registrar to change the authoritative
205
- # name servers for your domain to the set of NameServers elements
206
- # returned in DelegationSet.
207
- # * `:caller_reference` - *required* - (String) A unique string that
208
- # identifies the request and that allows failed CreateHostedZone
209
- # requests to be retried without the risk of executing the operation
210
- # twice. You must use a unique CallerReference string every time you
211
- # create a hosted zone. CallerReference can be any unique string; you
212
- # might choose to use a string that identifies your project, such as
213
- # DNSMigration_01. Valid characters are any Unicode code points that
214
- # are legal in an XML 1.0 document. The UTF-8 encoding of the value
215
- # must be less than 128 bytes.
216
- # * `:hosted_zone_config` - (Hash) A complex type that contains an
217
- # optional comment about your hosted zone.
218
- # * `:comment` - (String) An optional comment about your hosted zone.
219
- # If you don't want to specify a comment, you can omit the
220
- # HostedZoneConfig and Comment elements from the XML document.
202
+ #
203
+ # * `:name` - *required* - (String) The name of the domain. This must
204
+ # be a fully-specified domain, for example, www.example.com. The
205
+ # trailing dot is optional; Route 53 assumes that the domain name is
206
+ # fully qualified. This means that Route 53 treats www.example.com
207
+ # (without a trailing dot) and www.example.com. (with a trailing dot)
208
+ # as identical. This is the name you have registered with your DNS
209
+ # registrar. You should ask your registrar to change the
210
+ # authoritative name servers for your domain to the set of
211
+ # NameServers elements returned in DelegationSet.
212
+ # * `:caller_reference` - *required* - (String) A unique string that
213
+ # identifies the request and that allows failed CreateHostedZone
214
+ # requests to be retried without the risk of executing the operation
215
+ # twice. You must use a unique CallerReference string every time you
216
+ # create a hosted zone. CallerReference can be any unique string; you
217
+ # might choose to use a string that identifies your project, such as
218
+ # DNSMigration_01. Valid characters are any Unicode code points that
219
+ # are legal in an XML 1.0 document. The UTF-8 encoding of the value
220
+ # must be less than 128 bytes.
221
+ # * `:hosted_zone_config` - (Hash) A complex type that contains an
222
+ # optional comment about your hosted zone.
223
+ # * `:comment` - (String) An optional comment about your hosted zone.
224
+ # If you don't want to specify a comment, you can omit the
225
+ # HostedZoneConfig and Comment elements from the XML document.
221
226
  # @return [Core::Response]
222
227
  # The #data method of the response object returns
223
228
  # a hash with the following structure:
@@ -240,16 +245,18 @@ module AWS
240
245
  # @!method delete_health_check(options = {})
241
246
  # Calls the DELETE DeleteHealthCheck API operation.
242
247
  # @param [Hash] options
243
- # * `:health_check_id` - *required* - (String) The ID of the health check
244
- # to delete.
248
+ #
249
+ # * `:health_check_id` - *required* - (String) The ID of the health
250
+ # check to delete.
245
251
  # @return [Core::Response]
246
252
 
247
253
  # @!method delete_hosted_zone(options = {})
248
254
  # Calls the DELETE DeleteHostedZone API operation.
249
255
  # @param [Hash] options
250
- # * `:id` - *required* - (String) The ID of the request. Include this ID
251
- # in a call to GetChange to track when the change has propagated to all
252
- # Route 53 DNS servers.
256
+ #
257
+ # * `:id` - *required* - (String) The ID of the request. Include this
258
+ # ID in a call to GetChange to track when the change has propagated
259
+ # to all Route 53 DNS servers.
253
260
  # @return [Core::Response]
254
261
  # The #data method of the response object returns
255
262
  # a hash with the following structure:
@@ -263,10 +270,11 @@ module AWS
263
270
  # @!method get_change(options = {})
264
271
  # Calls the GET GetChange API operation.
265
272
  # @param [Hash] options
266
- # * `:id` - *required* - (String) The ID of the change batch request. The
267
- # value that you specify here is the value that
268
- # ChangeResourceRecordSets returned in the Id element when you
269
- # submitted the request.
273
+ #
274
+ # * `:id` - *required* - (String) The ID of the change batch request.
275
+ # The value that you specify here is the value that
276
+ # ChangeResourceRecordSets returned in the Id element when you
277
+ # submitted the request.
270
278
  # @return [Core::Response]
271
279
  # The #data method of the response object returns
272
280
  # a hash with the following structure:
@@ -280,8 +288,9 @@ module AWS
280
288
  # @!method get_health_check(options = {})
281
289
  # Calls the GET GetHealthCheck API operation.
282
290
  # @param [Hash] options
283
- # * `:health_check_id` - *required* - (String) The ID of the health check
284
- # to retrieve.
291
+ #
292
+ # * `:health_check_id` - *required* - (String) The ID of the health
293
+ # check to retrieve.
285
294
  # @return [Core::Response]
286
295
  # The #data method of the response object returns
287
296
  # a hash with the following structure:
@@ -299,8 +308,9 @@ module AWS
299
308
  # @!method get_hosted_zone(options = {})
300
309
  # Calls the GET GetHostedZone API operation.
301
310
  # @param [Hash] options
302
- # * `:id` - *required* - (String) The ID of the hosted zone for which you
303
- # want to get a list of the name servers in the delegation set.
311
+ #
312
+ # * `:id` - *required* - (String) The ID of the hosted zone for which
313
+ # you want to get a list of the name servers in the delegation set.
304
314
  # @return [Core::Response]
305
315
  # The #data method of the response object returns
306
316
  # a hash with the following structure:
@@ -318,12 +328,13 @@ module AWS
318
328
  # @!method list_health_checks(options = {})
319
329
  # Calls the GET ListHealthChecks API operation.
320
330
  # @param [Hash] options
321
- # * `:marker` - (String) If the request returned more than one page of
322
- # results, submit another request and specify the value of NextMarker
323
- # from the last response in the marker parameter to get the next page
324
- # of results.
325
- # * `:max_items` - (Integer) Specify the maximum number of health checks
326
- # to return per page of results.
331
+ #
332
+ # * `:marker` - (String) If the request returned more than one page of
333
+ # results, submit another request and specify the value of NextMarker
334
+ # from the last response in the marker parameter to get the next page
335
+ # of results.
336
+ # * `:max_items` - (Integer) Specify the maximum number of health
337
+ # checks to return per page of results.
327
338
  # @return [Core::Response]
328
339
  # The #data method of the response object returns
329
340
  # a hash with the following structure:
@@ -345,12 +356,13 @@ module AWS
345
356
  # @!method list_hosted_zones(options = {})
346
357
  # Calls the GET ListHostedZones API operation.
347
358
  # @param [Hash] options
348
- # * `:marker` - (String) If the request returned more than one page of
349
- # results, submit another request and specify the value of NextMarker
350
- # from the last response in the marker parameter to get the next page
351
- # of results.
352
- # * `:max_items` - (Integer) Specify the maximum number of hosted zones
353
- # to return per page of results.
359
+ #
360
+ # * `:marker` - (String) If the request returned more than one page of
361
+ # results, submit another request and specify the value of NextMarker
362
+ # from the last response in the marker parameter to get the next page
363
+ # of results.
364
+ # * `:max_items` - (Integer) Specify the maximum number of hosted zones
365
+ # to return per page of results.
354
366
  # @return [Core::Response]
355
367
  # The #data method of the response object returns
356
368
  # a hash with the following structure:
@@ -370,35 +382,37 @@ module AWS
370
382
  # @!method list_resource_record_sets(options = {})
371
383
  # Calls the GET ListResourceRecordSets API operation.
372
384
  # @param [Hash] options
373
- # * `:hosted_zone_id` - *required* - (String) The ID of the hosted zone
374
- # that contains the resource record sets that you want to get.
375
- # * `:start_record_name` - (String) The first name in the lexicographic
376
- # ordering of domain names that you want the ListResourceRecordSets
377
- # request to list.
378
- # * `:start_record_type` - (String) The DNS type at which to begin the
379
- # listing of resource record sets. Valid values: A | AAAA | CNAME | MX
380
- # | NS | PTR | SOA | SPF | SRV | TXT Values for Weighted Resource
381
- # Record Sets: A | AAAA | CNAME | TXT Values for Alias Resource Record
382
- # Sets: A | AAAA Constraint: Specifying type without specifying name
383
- # returns an InvalidInput error. Valid values include:
384
- # * `SOA`
385
- # * `A`
386
- # * `TXT`
387
- # * `NS`
388
- # * `CNAME`
389
- # * `MX`
390
- # * `PTR`
391
- # * `SRV`
392
- # * `SPF`
393
- # * `AAAA`
394
- # * `:start_record_identifier` - (String) Weighted resource record sets
395
- # only: If results were truncated for a given DNS name and type,
396
- # specify the value of
397
- # ListResourceRecordSetsResponse$NextRecordIdentifier from the previous
398
- # response to get the next resource record set that has the current DNS
399
- # name and type.
400
- # * `:max_items` - (Integer) The maximum number of records you want in
401
- # the response body.
385
+ #
386
+ # * `:hosted_zone_id` - *required* - (String) The ID of the hosted zone
387
+ # that contains the resource record sets that you want to get.
388
+ # * `:start_record_name` - (String) The first name in the lexicographic
389
+ # ordering of domain names that you want the ListResourceRecordSets
390
+ # request to list.
391
+ # * `:start_record_type` - (String) The DNS type at which to begin the
392
+ # listing of resource record sets. Valid values: A | AAAA | CNAME |
393
+ # MX | NS | PTR | SOA | SPF | SRV | TXT Values for Weighted Resource
394
+ # Record Sets: A | AAAA | CNAME | TXT Values for Alias Resource
395
+ # Record Sets: A | AAAA Constraint: Specifying type without
396
+ # specifying name returns an InvalidInput error. Valid values
397
+ # include:
398
+ # * `SOA`
399
+ # * `A`
400
+ # * `TXT`
401
+ # * `NS`
402
+ # * `CNAME`
403
+ # * `MX`
404
+ # * `PTR`
405
+ # * `SRV`
406
+ # * `SPF`
407
+ # * `AAAA`
408
+ # * `:start_record_identifier` - (String) Weighted resource record sets
409
+ # only: If results were truncated for a given DNS name and type,
410
+ # specify the value of
411
+ # ListResourceRecordSetsResponse$NextRecordIdentifier from the
412
+ # previous response to get the next resource record set that has the
413
+ # current DNS name and type.
414
+ # * `:max_items` - (Integer) The maximum number of records you want in
415
+ # the response body.
402
416
  # @return [Core::Response]
403
417
  # The #data method of the response object returns
404
418
  # a hash with the following structure: