aws-sdk 1.13.0 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +3 -3
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
- data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
- data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
- data/lib/aws/auto_scaling/client.rb +0 -530
- data/lib/aws/cloud_formation/client.rb +0 -356
- data/lib/aws/cloud_front/client.rb +0 -1567
- data/lib/aws/cloud_search/client.rb +0 -578
- data/lib/aws/cloud_watch/client.rb +0 -445
- data/lib/aws/data_pipeline/client.rb +0 -396
- data/lib/aws/direct_connect/client.rb +0 -248
- data/lib/aws/dynamo_db.rb +0 -1
- data/lib/aws/dynamo_db/client.rb +70 -1
- data/lib/aws/dynamo_db/client_v2.rb +1 -1
- data/lib/aws/ec2/client.rb +0 -3942
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/elastic_beanstalk/client.rb +0 -898
- data/lib/aws/elastic_transcoder/client.rb +0 -1755
- data/lib/aws/elasticache/client.rb +0 -947
- data/lib/aws/elb/client.rb +0 -509
- data/lib/aws/emr/client.rb +0 -314
- data/lib/aws/glacier/client.rb +0 -278
- data/lib/aws/iam/client.rb +0 -1155
- data/lib/aws/import_export/client.rb +0 -96
- data/lib/aws/ops_works/client.rb +0 -1255
- data/lib/aws/rds/client.rb +0 -2367
- data/lib/aws/redshift/client.rb +0 -1458
- data/lib/aws/route_53/client.rb +0 -420
- data/lib/aws/simple_db/client.rb +2 -250
- data/lib/aws/simple_email_service/client.rb +0 -282
- data/lib/aws/simple_workflow/client.rb +0 -1248
- data/lib/aws/sns/client.rb +0 -283
- data/lib/aws/sns/message.rb +1 -1
- data/lib/aws/sqs/client.rb +0 -255
- data/lib/aws/storage_gateway/client.rb +0 -582
- data/lib/aws/sts/client.rb +0 -183
- data/lib/aws/support/client.rb +0 -232
- data/lib/aws/version.rb +1 -1
- metadata +2 -3
- data/lib/aws/dynamo_db/client_base.rb +0 -92
data/lib/aws/redshift/client.rb
CHANGED
@@ -26,1464 +26,6 @@ module AWS
|
|
26
26
|
|
27
27
|
class Client::V20121201 < Client
|
28
28
|
|
29
|
-
# client methods #
|
30
|
-
|
31
|
-
# @!method authorize_cluster_security_group_ingress(options = {})
|
32
|
-
# Calls the AuthorizeClusterSecurityGroupIngress API operation.
|
33
|
-
# @param [Hash] options
|
34
|
-
#
|
35
|
-
# * `:cluster_security_group_name` - *required* - (String) The name of
|
36
|
-
# the security group to which the ingress rule is added.
|
37
|
-
# * `:cidrip` - (String) The IP range to be added the Amazon Redshift
|
38
|
-
# security group.
|
39
|
-
# * `:ec2_security_group_name` - (String) The EC2 security group to be
|
40
|
-
# added the Amazon Redshift security group.
|
41
|
-
# * `:ec2_security_group_owner_id` - (String) The AWS account number of
|
42
|
-
# the owner of the security group specified by the
|
43
|
-
# EC2SecurityGroupName parameter. The AWS Access Key ID is not an
|
44
|
-
# acceptable value. Example: 111122223333
|
45
|
-
# @return [Core::Response]
|
46
|
-
# The #data method of the response object returns
|
47
|
-
# a hash with the following structure:
|
48
|
-
#
|
49
|
-
# * `:cluster_security_group_name` - (String)
|
50
|
-
# * `:description` - (String)
|
51
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
52
|
-
# * `:status` - (String)
|
53
|
-
# * `:ec2_security_group_name` - (String)
|
54
|
-
# * `:ec2_security_group_owner_id` - (String)
|
55
|
-
# * `:ip_ranges` - (Array<Hash>)
|
56
|
-
# * `:status` - (String)
|
57
|
-
# * `:cidrip` - (String)
|
58
|
-
|
59
|
-
# @!method authorize_snapshot_access(options = {})
|
60
|
-
# Calls the AuthorizeSnapshotAccess API operation.
|
61
|
-
# @param [Hash] options
|
62
|
-
#
|
63
|
-
# * `:snapshot_identifier` - *required* - (String) The identifier of
|
64
|
-
# the snapshot the account is authorized to restore.
|
65
|
-
# * `:account_with_restore_access` - *required* - (String) The
|
66
|
-
# identifier of the AWS customer account authorized to restore the
|
67
|
-
# specified snapshot.
|
68
|
-
# @return [Core::Response]
|
69
|
-
# The #data method of the response object returns
|
70
|
-
# a hash with the following structure:
|
71
|
-
#
|
72
|
-
# * `:snapshot_identifier` - (String)
|
73
|
-
# * `:cluster_identifier` - (String)
|
74
|
-
# * `:snapshot_create_time` - (Time)
|
75
|
-
# * `:status` - (String)
|
76
|
-
# * `:port` - (Integer)
|
77
|
-
# * `:availability_zone` - (String)
|
78
|
-
# * `:cluster_create_time` - (Time)
|
79
|
-
# * `:master_username` - (String)
|
80
|
-
# * `:cluster_version` - (String)
|
81
|
-
# * `:snapshot_type` - (String)
|
82
|
-
# * `:node_type` - (String)
|
83
|
-
# * `:number_of_nodes` - (Integer)
|
84
|
-
# * `:db_name` - (String)
|
85
|
-
# * `:vpc_id` - (String)
|
86
|
-
# * `:encrypted` - (Boolean)
|
87
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
88
|
-
# * `:account_id` - (String)
|
89
|
-
# * `:owner_account` - (String)
|
90
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
91
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
92
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
93
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
94
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
95
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
96
|
-
|
97
|
-
# @!method copy_cluster_snapshot(options = {})
|
98
|
-
# Calls the CopyClusterSnapshot API operation.
|
99
|
-
# @param [Hash] options
|
100
|
-
#
|
101
|
-
# * `:source_snapshot_identifier` - *required* - (String) The
|
102
|
-
# identifier for the source snapshot. Constraints: Must be the
|
103
|
-
# identifier for a valid automated snapshot whose state is
|
104
|
-
# "available".
|
105
|
-
# * `:target_snapshot_identifier` - *required* - (String) The
|
106
|
-
# identifier given to the new manual snapshot. Constraints: Cannot be
|
107
|
-
# null, empty, or blank. Must contain from 1 to 255 alphanumeric
|
108
|
-
# characters or hyphens. First character must be a letter. Cannot end
|
109
|
-
# with a hyphen or contain two consecutive hyphens. Must be unique
|
110
|
-
# for the AWS account that is making the request.
|
111
|
-
# @return [Core::Response]
|
112
|
-
# The #data method of the response object returns
|
113
|
-
# a hash with the following structure:
|
114
|
-
#
|
115
|
-
# * `:snapshot_identifier` - (String)
|
116
|
-
# * `:cluster_identifier` - (String)
|
117
|
-
# * `:snapshot_create_time` - (Time)
|
118
|
-
# * `:status` - (String)
|
119
|
-
# * `:port` - (Integer)
|
120
|
-
# * `:availability_zone` - (String)
|
121
|
-
# * `:cluster_create_time` - (Time)
|
122
|
-
# * `:master_username` - (String)
|
123
|
-
# * `:cluster_version` - (String)
|
124
|
-
# * `:snapshot_type` - (String)
|
125
|
-
# * `:node_type` - (String)
|
126
|
-
# * `:number_of_nodes` - (Integer)
|
127
|
-
# * `:db_name` - (String)
|
128
|
-
# * `:vpc_id` - (String)
|
129
|
-
# * `:encrypted` - (Boolean)
|
130
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
131
|
-
# * `:account_id` - (String)
|
132
|
-
# * `:owner_account` - (String)
|
133
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
134
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
135
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
136
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
137
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
138
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
139
|
-
|
140
|
-
# @!method create_cluster(options = {})
|
141
|
-
# Calls the CreateCluster API operation.
|
142
|
-
# @param [Hash] options
|
143
|
-
#
|
144
|
-
# * `:db_name` - (String) The name of the first database to be created
|
145
|
-
# when the cluster is created. To create additional databases after
|
146
|
-
# the cluster is created, connect to the cluster with a SQL client
|
147
|
-
# and use SQL commands to create a database. For more information, go
|
148
|
-
# to Create a Database in the Amazon Redshift Developer Guide.
|
149
|
-
# Default: dev Constraints: Must contain 1 to 64 alphanumeric
|
150
|
-
# characters. Must contain only lowercase letters. Cannot be a word
|
151
|
-
# that is reserved by the service. A list of reserved words can be
|
152
|
-
# found in Reserved Words in the Amazon Redshift Developer Guide.
|
153
|
-
# * `:cluster_identifier` - *required* - (String) A unique identifier
|
154
|
-
# for the cluster. You use this identifier to refer to the cluster
|
155
|
-
# for any subsequent cluster operations such as deleting or
|
156
|
-
# modifying. The identifier also appears in the Amazon Redshift
|
157
|
-
# console. Constraints: Must contain from 1 to 63 alphanumeric
|
158
|
-
# characters or hyphens. Alphabetic characters must be lowercase.
|
159
|
-
# First character must be a letter. Cannot end with a hyphen or
|
160
|
-
# contain two consecutive hyphens. Must be unique for all clusters
|
161
|
-
# within an AWS account. Example: myexamplecluster
|
162
|
-
# * `:cluster_type` - (String) The type of the cluster. When cluster
|
163
|
-
# type is specified as single-node, the NumberOfNodes parameter is
|
164
|
-
# not required. multi-node, the NumberOfNodes parameter is required.
|
165
|
-
# Valid Values: multi-node | single-node Default: multi-node
|
166
|
-
# * `:node_type` - *required* - (String) The node type to be
|
167
|
-
# provisioned for the cluster. For information about node types, go
|
168
|
-
# to Working with Clusters in the Amazon Redshift Management Guide.
|
169
|
-
# Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.
|
170
|
-
# * `:master_username` - *required* - (String) The user name associated
|
171
|
-
# with the master user account for the cluster that is being created.
|
172
|
-
# Constraints: Must be 1 - 128 alphanumeric characters. First
|
173
|
-
# character must be a letter. Cannot be a reserved word. A list of
|
174
|
-
# reserved words can be found in Reserved Words in the Amazon
|
175
|
-
# Redshift Developer Guide.
|
176
|
-
# * `:master_user_password` - *required* - (String) The password
|
177
|
-
# associated with the master user account for the cluster that is
|
178
|
-
# being created. Constraints: Must be between 8 and 64 characters in
|
179
|
-
# length. Must contain at least one uppercase letter. Must contain at
|
180
|
-
# least one lowercase letter. Must contain one number. Can be any
|
181
|
-
# printable ASCII character (ASCII code 33 to 126) except ' (single
|
182
|
-
# quote), " (double quote), \, /, @, or space.
|
183
|
-
# * `:cluster_security_groups` - (Array<String>) A list of security
|
184
|
-
# groups to be associated with this cluster. Default: The default
|
185
|
-
# cluster security group for Amazon Redshift.
|
186
|
-
# * `:vpc_security_group_ids` - (Array<String>) A list of Virtual
|
187
|
-
# Private Cloud (VPC) security groups to be associated with the
|
188
|
-
# cluster. Default: The default VPC security group is associated with
|
189
|
-
# the cluster.
|
190
|
-
# * `:cluster_subnet_group_name` - (String) The name of a cluster
|
191
|
-
# subnet group to be associated with this cluster. If this parameter
|
192
|
-
# is not provided the resulting cluster will be deployed outside
|
193
|
-
# virtual private cloud (VPC).
|
194
|
-
# * `:availability_zone` - (String) The EC2 Availability Zone (AZ) in
|
195
|
-
# which you want Amazon Redshift to provision the cluster. For
|
196
|
-
# example, if you have several EC2 instances running in a specific
|
197
|
-
# Availability Zone, then you might want the cluster to be
|
198
|
-
# provisioned in the same zone in order to decrease network latency.
|
199
|
-
# Default: A random, system-chosen Availability Zone in the region
|
200
|
-
# that is specified by the endpoint. Example: us-east-1d Constraint:
|
201
|
-
# The specified Availability Zone must be in the same region as the
|
202
|
-
# current endpoint.
|
203
|
-
# * `:preferred_maintenance_window` - (String) The weekly time range
|
204
|
-
# (in UTC) during which automated cluster maintenance can occur.
|
205
|
-
# Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window
|
206
|
-
# selected at random from an 8-hour block of time per region,
|
207
|
-
# occurring on a random day of the week. The following list shows the
|
208
|
-
# time blocks for each region from which the default maintenance
|
209
|
-
# windows are assigned. US-East (Northern Virginia) Region:
|
210
|
-
# 03:00-11:00 UTC US-West (Oregon) Region 06:00-14:00 UTC Valid Days:
|
211
|
-
# Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum
|
212
|
-
# 30-minute window.
|
213
|
-
# * `:cluster_parameter_group_name` - (String) The name of the
|
214
|
-
# parameter group to be associated with this cluster. Default: The
|
215
|
-
# default Amazon Redshift cluster parameter group. For information
|
216
|
-
# about the default parameter group, go to Working with Amazon
|
217
|
-
# Redshift Parameter Groups Constraints: Must be 1 to 255
|
218
|
-
# alphanumeric characters or hyphens. First character must be a
|
219
|
-
# letter. Cannot end with a hyphen or contain two consecutive
|
220
|
-
# hyphens.
|
221
|
-
# * `:automated_snapshot_retention_period` - (Integer) The number of
|
222
|
-
# days that automated snapshots are retained. If the value is 0,
|
223
|
-
# automated snapshots are disabled. Even if automated snapshots are
|
224
|
-
# disabled, you can still create manual snapshots when you want with
|
225
|
-
# CreateClusterSnapshot. Default: 1 Constraints: Must be a value from
|
226
|
-
# 0 to 35.
|
227
|
-
# * `:port` - (Integer) The port number on which the cluster accepts
|
228
|
-
# incoming connections. The cluster is accessible only via the JDBC
|
229
|
-
# and ODBC connection strings. Part of the connection string requires
|
230
|
-
# the port on which the cluster will listen for incoming connections.
|
231
|
-
# Default: 5439 Valid Values: 1150-65535
|
232
|
-
# * `:cluster_version` - (String) The version of the Amazon Redshift
|
233
|
-
# engine software that you want to deploy on the cluster. The version
|
234
|
-
# selected runs on all the nodes in the cluster. Constraints: Only
|
235
|
-
# version 1.0 is currently available. Example: 1.0
|
236
|
-
# * `:allow_version_upgrade` - (Boolean) If `true` , upgrades can be
|
237
|
-
# applied during the maintenance window to the Amazon Redshift engine
|
238
|
-
# that is running on the cluster. When a new version of the Amazon
|
239
|
-
# Redshift engine is released, you can request that the service
|
240
|
-
# automatically apply upgrades during the maintenance window to the
|
241
|
-
# Amazon Redshift engine that is running on your cluster. Default:
|
242
|
-
# `true`
|
243
|
-
# * `:number_of_nodes` - (Integer) The number of compute nodes in the
|
244
|
-
# cluster. This parameter is required when the ClusterType parameter
|
245
|
-
# is specified as multi-node. For information about determining how
|
246
|
-
# many nodes you need, go to Working with Clusters in the Amazon
|
247
|
-
# Redshift Management Guide. If you don't specify this parameter, you
|
248
|
-
# get a single-node cluster. When requesting a multi-node cluster,
|
249
|
-
# you must specify the number of nodes that you want in the cluster.
|
250
|
-
# Default: 1 Constraints: Value must be at least 1 and no more than
|
251
|
-
# 100.
|
252
|
-
# * `:publicly_accessible` - (Boolean) If `true` , the cluster can be
|
253
|
-
# accessed from a public network.
|
254
|
-
# * `:encrypted` - (Boolean) If `true` , the data in cluster is
|
255
|
-
# encrypted at rest. Default: `false`
|
256
|
-
# @return [Core::Response]
|
257
|
-
# The #data method of the response object returns
|
258
|
-
# a hash with the following structure:
|
259
|
-
#
|
260
|
-
# * `:cluster_identifier` - (String)
|
261
|
-
# * `:node_type` - (String)
|
262
|
-
# * `:cluster_status` - (String)
|
263
|
-
# * `:modify_status` - (String)
|
264
|
-
# * `:master_username` - (String)
|
265
|
-
# * `:db_name` - (String)
|
266
|
-
# * `:endpoint` - (Hash)
|
267
|
-
# * `:address` - (String)
|
268
|
-
# * `:port` - (Integer)
|
269
|
-
# * `:cluster_create_time` - (Time)
|
270
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
271
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
272
|
-
# * `:cluster_security_group_name` - (String)
|
273
|
-
# * `:status` - (String)
|
274
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
275
|
-
# * `:vpc_security_group_id` - (String)
|
276
|
-
# * `:status` - (String)
|
277
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
278
|
-
# * `:parameter_group_name` - (String)
|
279
|
-
# * `:parameter_apply_status` - (String)
|
280
|
-
# * `:cluster_subnet_group_name` - (String)
|
281
|
-
# * `:vpc_id` - (String)
|
282
|
-
# * `:availability_zone` - (String)
|
283
|
-
# * `:preferred_maintenance_window` - (String)
|
284
|
-
# * `:pending_modified_values` - (Hash)
|
285
|
-
# * `:master_user_password` - (String)
|
286
|
-
# * `:node_type` - (String)
|
287
|
-
# * `:number_of_nodes` - (Integer)
|
288
|
-
# * `:cluster_type` - (String)
|
289
|
-
# * `:cluster_version` - (String)
|
290
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
291
|
-
# * `:cluster_version` - (String)
|
292
|
-
# * `:allow_version_upgrade` - (Boolean)
|
293
|
-
# * `:number_of_nodes` - (Integer)
|
294
|
-
# * `:publicly_accessible` - (Boolean)
|
295
|
-
# * `:encrypted` - (Boolean)
|
296
|
-
|
297
|
-
# @!method create_cluster_parameter_group(options = {})
|
298
|
-
# Calls the CreateClusterParameterGroup API operation.
|
299
|
-
# @param [Hash] options
|
300
|
-
#
|
301
|
-
# * `:parameter_group_name` - *required* - (String) The name of the
|
302
|
-
# cluster parameter group. Constraints: Must be 1 to 255 alphanumeric
|
303
|
-
# characters or hyphens First character must be a letter. Cannot end
|
304
|
-
# with a hyphen or contain two consecutive hyphens. Must be unique
|
305
|
-
# withing your AWS account. This value is stored as a lower-case
|
306
|
-
# string.
|
307
|
-
# * `:parameter_group_family` - *required* - (String) The Amazon
|
308
|
-
# Redshift engine version to which the cluster parameter group
|
309
|
-
# applies. The cluster engine version determines the set of
|
310
|
-
# parameters. To get a list of valid parameter group family names,
|
311
|
-
# you can call DescribeClusterParameterGroups. By default, Amazon
|
312
|
-
# Redshift returns a list of all the parameter groups that are owned
|
313
|
-
# by your AWS account, including the default parameter groups for
|
314
|
-
# each Amazon Redshift engine version. The parameter group family
|
315
|
-
# names associated with the default parameter groups provide you the
|
316
|
-
# valid values. For example, a valid family name is "redshift-1.0".
|
317
|
-
# * `:description` - *required* - (String) A description of the
|
318
|
-
# parameter group.
|
319
|
-
# @return [Core::Response]
|
320
|
-
# The #data method of the response object returns
|
321
|
-
# a hash with the following structure:
|
322
|
-
#
|
323
|
-
# * `:parameter_group_name` - (String)
|
324
|
-
# * `:parameter_group_family` - (String)
|
325
|
-
# * `:description` - (String)
|
326
|
-
|
327
|
-
# @!method create_cluster_security_group(options = {})
|
328
|
-
# Calls the CreateClusterSecurityGroup API operation.
|
329
|
-
# @param [Hash] options
|
330
|
-
#
|
331
|
-
# * `:cluster_security_group_name` - *required* - (String) The name for
|
332
|
-
# the security group. Amazon Redshift stores the value as a lowercase
|
333
|
-
# string. Constraints: Must contain no more than 255 alphanumeric
|
334
|
-
# characters or hyphens. Must not be "Default". Must be unique for
|
335
|
-
# all security groups that are created by your AWS account. Example:
|
336
|
-
# examplesecuritygroup
|
337
|
-
# * `:description` - *required* - (String) A description for the
|
338
|
-
# security group.
|
339
|
-
# @return [Core::Response]
|
340
|
-
# The #data method of the response object returns
|
341
|
-
# a hash with the following structure:
|
342
|
-
#
|
343
|
-
# * `:cluster_security_group_name` - (String)
|
344
|
-
# * `:description` - (String)
|
345
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
346
|
-
# * `:status` - (String)
|
347
|
-
# * `:ec2_security_group_name` - (String)
|
348
|
-
# * `:ec2_security_group_owner_id` - (String)
|
349
|
-
# * `:ip_ranges` - (Array<Hash>)
|
350
|
-
# * `:status` - (String)
|
351
|
-
# * `:cidrip` - (String)
|
352
|
-
|
353
|
-
# @!method create_cluster_snapshot(options = {})
|
354
|
-
# Calls the CreateClusterSnapshot API operation.
|
355
|
-
# @param [Hash] options
|
356
|
-
#
|
357
|
-
# * `:snapshot_identifier` - *required* - (String) A unique identifier
|
358
|
-
# for the snapshot that you are requesting. This identifier must be
|
359
|
-
# unique for all snapshots within the AWS account. Constraints:
|
360
|
-
# Cannot be null, empty, or blank Must contain from 1 to 255
|
361
|
-
# alphanumeric characters or hyphens First character must be a letter
|
362
|
-
# Cannot end with a hyphen or contain two consecutive hyphens
|
363
|
-
# Example: my-snapshot-id
|
364
|
-
# * `:cluster_identifier` - *required* - (String) The cluster
|
365
|
-
# identifier for which you want a snapshot.
|
366
|
-
# @return [Core::Response]
|
367
|
-
# The #data method of the response object returns
|
368
|
-
# a hash with the following structure:
|
369
|
-
#
|
370
|
-
# * `:snapshot_identifier` - (String)
|
371
|
-
# * `:cluster_identifier` - (String)
|
372
|
-
# * `:snapshot_create_time` - (Time)
|
373
|
-
# * `:status` - (String)
|
374
|
-
# * `:port` - (Integer)
|
375
|
-
# * `:availability_zone` - (String)
|
376
|
-
# * `:cluster_create_time` - (Time)
|
377
|
-
# * `:master_username` - (String)
|
378
|
-
# * `:cluster_version` - (String)
|
379
|
-
# * `:snapshot_type` - (String)
|
380
|
-
# * `:node_type` - (String)
|
381
|
-
# * `:number_of_nodes` - (Integer)
|
382
|
-
# * `:db_name` - (String)
|
383
|
-
# * `:vpc_id` - (String)
|
384
|
-
# * `:encrypted` - (Boolean)
|
385
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
386
|
-
# * `:account_id` - (String)
|
387
|
-
# * `:owner_account` - (String)
|
388
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
389
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
390
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
391
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
392
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
393
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
394
|
-
|
395
|
-
# @!method create_cluster_subnet_group(options = {})
|
396
|
-
# Calls the CreateClusterSubnetGroup API operation.
|
397
|
-
# @param [Hash] options
|
398
|
-
#
|
399
|
-
# * `:cluster_subnet_group_name` - *required* - (String) The name for
|
400
|
-
# the subnet group. Amazon Redshift stores the value as a lowercase
|
401
|
-
# string. Constraints: Must contain no more than 255 alphanumeric
|
402
|
-
# characters or hyphens. Must not be "Default". Must be unique for
|
403
|
-
# all subnet groups that are created by your AWS account. Example:
|
404
|
-
# examplesubnetgroup
|
405
|
-
# * `:description` - *required* - (String) A description for the subnet
|
406
|
-
# group.
|
407
|
-
# * `:subnet_ids` - *required* - (Array<String>) An array of VPC subnet
|
408
|
-
# IDs. A maximum of 20 subnets can be modified in a single request.
|
409
|
-
# @return [Core::Response]
|
410
|
-
# The #data method of the response object returns
|
411
|
-
# a hash with the following structure:
|
412
|
-
#
|
413
|
-
# * `:cluster_subnet_group_name` - (String)
|
414
|
-
# * `:description` - (String)
|
415
|
-
# * `:vpc_id` - (String)
|
416
|
-
# * `:subnet_group_status` - (String)
|
417
|
-
# * `:subnets` - (Array<Hash>)
|
418
|
-
# * `:subnet_identifier` - (String)
|
419
|
-
# * `:subnet_availability_zone` - (Hash)
|
420
|
-
# * `:name` - (String)
|
421
|
-
# * `:subnet_status` - (String)
|
422
|
-
|
423
|
-
# @!method delete_cluster(options = {})
|
424
|
-
# Calls the DeleteCluster API operation.
|
425
|
-
# @param [Hash] options
|
426
|
-
#
|
427
|
-
# * `:cluster_identifier` - *required* - (String) The identifier of the
|
428
|
-
# cluster to be deleted. Constraints: Must contain lowercase
|
429
|
-
# characters. Must contain from 1 to 63 alphanumeric characters or
|
430
|
-
# hyphens. First character must be a letter. Cannot end with a hyphen
|
431
|
-
# or contain two consecutive hyphens.
|
432
|
-
# * `:skip_final_cluster_snapshot` - (Boolean) Determines whether a
|
433
|
-
# final snapshot of the cluster is created before Amazon Redshift
|
434
|
-
# deletes the cluster. If `true` , a final cluster snapshot is not
|
435
|
-
# created. If `false` , a final cluster snapshot is created before
|
436
|
-
# the cluster is deleted. The FinalClusterSnapshotIdentifier
|
437
|
-
# parameter must be specified if SkipFinalClusterSnapshot is `false`
|
438
|
-
# . Default: `false`
|
439
|
-
# * `:final_cluster_snapshot_identifier` - (String) The identifier of
|
440
|
-
# the final snapshot that is to be created immediately before
|
441
|
-
# deleting the cluster. If this parameter is provided,
|
442
|
-
# SkipFinalClusterSnapshot must be `false` . Constraints: Must be 1
|
443
|
-
# to 255 alphanumeric characters. First character must be a letter.
|
444
|
-
# Cannot end with a hyphen or contain two consecutive hyphens.
|
445
|
-
# @return [Core::Response]
|
446
|
-
# The #data method of the response object returns
|
447
|
-
# a hash with the following structure:
|
448
|
-
#
|
449
|
-
# * `:cluster_identifier` - (String)
|
450
|
-
# * `:node_type` - (String)
|
451
|
-
# * `:cluster_status` - (String)
|
452
|
-
# * `:modify_status` - (String)
|
453
|
-
# * `:master_username` - (String)
|
454
|
-
# * `:db_name` - (String)
|
455
|
-
# * `:endpoint` - (Hash)
|
456
|
-
# * `:address` - (String)
|
457
|
-
# * `:port` - (Integer)
|
458
|
-
# * `:cluster_create_time` - (Time)
|
459
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
460
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
461
|
-
# * `:cluster_security_group_name` - (String)
|
462
|
-
# * `:status` - (String)
|
463
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
464
|
-
# * `:vpc_security_group_id` - (String)
|
465
|
-
# * `:status` - (String)
|
466
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
467
|
-
# * `:parameter_group_name` - (String)
|
468
|
-
# * `:parameter_apply_status` - (String)
|
469
|
-
# * `:cluster_subnet_group_name` - (String)
|
470
|
-
# * `:vpc_id` - (String)
|
471
|
-
# * `:availability_zone` - (String)
|
472
|
-
# * `:preferred_maintenance_window` - (String)
|
473
|
-
# * `:pending_modified_values` - (Hash)
|
474
|
-
# * `:master_user_password` - (String)
|
475
|
-
# * `:node_type` - (String)
|
476
|
-
# * `:number_of_nodes` - (Integer)
|
477
|
-
# * `:cluster_type` - (String)
|
478
|
-
# * `:cluster_version` - (String)
|
479
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
480
|
-
# * `:cluster_version` - (String)
|
481
|
-
# * `:allow_version_upgrade` - (Boolean)
|
482
|
-
# * `:number_of_nodes` - (Integer)
|
483
|
-
# * `:publicly_accessible` - (Boolean)
|
484
|
-
# * `:encrypted` - (Boolean)
|
485
|
-
|
486
|
-
# @!method delete_cluster_parameter_group(options = {})
|
487
|
-
# Calls the DeleteClusterParameterGroup API operation.
|
488
|
-
# @param [Hash] options
|
489
|
-
#
|
490
|
-
# * `:parameter_group_name` - *required* - (String) The name of the
|
491
|
-
# parameter group to be deleted. Constraints: Must be the name of an
|
492
|
-
# existing cluster parameter group. Cannot delete a default cluster
|
493
|
-
# parameter group.
|
494
|
-
# @return [Core::Response]
|
495
|
-
|
496
|
-
# @!method delete_cluster_security_group(options = {})
|
497
|
-
# Calls the DeleteClusterSecurityGroup API operation.
|
498
|
-
# @param [Hash] options
|
499
|
-
#
|
500
|
-
# * `:cluster_security_group_name` - *required* - (String) The name of
|
501
|
-
# the cluster security group to be deleted.
|
502
|
-
# @return [Core::Response]
|
503
|
-
|
504
|
-
# @!method delete_cluster_snapshot(options = {})
|
505
|
-
# Calls the DeleteClusterSnapshot API operation.
|
506
|
-
# @param [Hash] options
|
507
|
-
#
|
508
|
-
# * `:snapshot_identifier` - *required* - (String) The unique
|
509
|
-
# identifier of the manual snapshot to be deleted. Constraints: Must
|
510
|
-
# be the name of an existing snapshot that is in the available state.
|
511
|
-
# @return [Core::Response]
|
512
|
-
# The #data method of the response object returns
|
513
|
-
# a hash with the following structure:
|
514
|
-
#
|
515
|
-
# * `:snapshot_identifier` - (String)
|
516
|
-
# * `:cluster_identifier` - (String)
|
517
|
-
# * `:snapshot_create_time` - (Time)
|
518
|
-
# * `:status` - (String)
|
519
|
-
# * `:port` - (Integer)
|
520
|
-
# * `:availability_zone` - (String)
|
521
|
-
# * `:cluster_create_time` - (Time)
|
522
|
-
# * `:master_username` - (String)
|
523
|
-
# * `:cluster_version` - (String)
|
524
|
-
# * `:snapshot_type` - (String)
|
525
|
-
# * `:node_type` - (String)
|
526
|
-
# * `:number_of_nodes` - (Integer)
|
527
|
-
# * `:db_name` - (String)
|
528
|
-
# * `:vpc_id` - (String)
|
529
|
-
# * `:encrypted` - (Boolean)
|
530
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
531
|
-
# * `:account_id` - (String)
|
532
|
-
# * `:owner_account` - (String)
|
533
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
534
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
535
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
536
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
537
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
538
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
539
|
-
|
540
|
-
# @!method delete_cluster_subnet_group(options = {})
|
541
|
-
# Calls the DeleteClusterSubnetGroup API operation.
|
542
|
-
# @param [Hash] options
|
543
|
-
#
|
544
|
-
# * `:cluster_subnet_group_name` - *required* - (String) The name of
|
545
|
-
# the cluster subnet group name to be deleted.
|
546
|
-
# @return [Core::Response]
|
547
|
-
|
548
|
-
# @!method describe_cluster_parameter_groups(options = {})
|
549
|
-
# Calls the DescribeClusterParameterGroups API operation.
|
550
|
-
# @param [Hash] options
|
551
|
-
#
|
552
|
-
# * `:parameter_group_name` - (String) The name of a specific parameter
|
553
|
-
# group for which to return details. By default, details about all
|
554
|
-
# parameter groups and the default parameter group are returned.
|
555
|
-
# * `:max_records` - (Integer) The maximum number of parameter group
|
556
|
-
# records to include in the response. If more records exist than the
|
557
|
-
# specified MaxRecords value, the response includes a marker that you
|
558
|
-
# can use in a subsequent DescribeClusterParameterGroups request to
|
559
|
-
# retrieve the next set of records. Default: 100 Constraints: Value
|
560
|
-
# must be at least 20 and no more than 100.
|
561
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
562
|
-
# DescribeClusterParameterGroups request to indicate the first
|
563
|
-
# parameter group that the current request will return.
|
564
|
-
# @return [Core::Response]
|
565
|
-
# The #data method of the response object returns
|
566
|
-
# a hash with the following structure:
|
567
|
-
#
|
568
|
-
# * `:marker` - (String)
|
569
|
-
# * `:parameter_groups` - (Array<Hash>)
|
570
|
-
# * `:parameter_group_name` - (String)
|
571
|
-
# * `:parameter_group_family` - (String)
|
572
|
-
# * `:description` - (String)
|
573
|
-
|
574
|
-
# @!method describe_cluster_parameters(options = {})
|
575
|
-
# Calls the DescribeClusterParameters API operation.
|
576
|
-
# @param [Hash] options
|
577
|
-
#
|
578
|
-
# * `:parameter_group_name` - *required* - (String) The name of a
|
579
|
-
# cluster parameter group for which to return details.
|
580
|
-
# * `:source` - (String) The parameter types to return. Specify user to
|
581
|
-
# show parameters that are different form the default. Similarly,
|
582
|
-
# specify engine-default to show parameters that are the same as the
|
583
|
-
# default parameter group. Default: All parameter types returned.
|
584
|
-
# Valid Values: user | engine-default
|
585
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
586
|
-
# in the response. If more records exist than the specified
|
587
|
-
# MaxRecords value, response includes a marker that you can specify
|
588
|
-
# in your subsequent request to retrieve remaining result. Default:
|
589
|
-
# 100 Constraints: Value must be at least 20 and no more than 100.
|
590
|
-
# * `:marker` - (String) An optional marker returned from a previous
|
591
|
-
# DescribeClusterParameters request. If this parameter is specified,
|
592
|
-
# the response includes only records beyond the specified marker, up
|
593
|
-
# to the value specified by MaxRecords.
|
594
|
-
# @return [Core::Response]
|
595
|
-
# The #data method of the response object returns
|
596
|
-
# a hash with the following structure:
|
597
|
-
#
|
598
|
-
# * `:parameters` - (Array<Hash>)
|
599
|
-
# * `:parameter_name` - (String)
|
600
|
-
# * `:parameter_value` - (String)
|
601
|
-
# * `:description` - (String)
|
602
|
-
# * `:source` - (String)
|
603
|
-
# * `:data_type` - (String)
|
604
|
-
# * `:allowed_values` - (String)
|
605
|
-
# * `:is_modifiable` - (Boolean)
|
606
|
-
# * `:minimum_engine_version` - (String)
|
607
|
-
# * `:marker` - (String)
|
608
|
-
|
609
|
-
# @!method describe_cluster_security_groups(options = {})
|
610
|
-
# Calls the DescribeClusterSecurityGroups API operation.
|
611
|
-
# @param [Hash] options
|
612
|
-
#
|
613
|
-
# * `:cluster_security_group_name` - (String) The name of a cluster
|
614
|
-
# security group for which you are requesting details. You can
|
615
|
-
# specify either the Marker parameter or a ClusterSecurityGroupName
|
616
|
-
# parameter, but not both. Example: securitygroup1
|
617
|
-
# * `:max_records` - (Integer) The maximum number of records to be
|
618
|
-
# included in the response. If more records exist than the specified
|
619
|
-
# MaxRecords value, a marker is included in the response, which you
|
620
|
-
# can use in a subsequent DescribeClusterSecurityGroups request.
|
621
|
-
# Default: 100 Constraints: Value must be at least 20 and no more
|
622
|
-
# than 100.
|
623
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
624
|
-
# DescribeClusterSecurityGroups request to indicate the first
|
625
|
-
# security group that the current request will return. You can
|
626
|
-
# specify either the Marker parameter or a ClusterSecurityGroupName
|
627
|
-
# parameter, but not both.
|
628
|
-
# @return [Core::Response]
|
629
|
-
# The #data method of the response object returns
|
630
|
-
# a hash with the following structure:
|
631
|
-
#
|
632
|
-
# * `:marker` - (String)
|
633
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
634
|
-
# * `:cluster_security_group_name` - (String)
|
635
|
-
# * `:description` - (String)
|
636
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
637
|
-
# * `:status` - (String)
|
638
|
-
# * `:ec2_security_group_name` - (String)
|
639
|
-
# * `:ec2_security_group_owner_id` - (String)
|
640
|
-
# * `:ip_ranges` - (Array<Hash>)
|
641
|
-
# * `:status` - (String)
|
642
|
-
# * `:cidrip` - (String)
|
643
|
-
|
644
|
-
# @!method describe_cluster_snapshots(options = {})
|
645
|
-
# Calls the DescribeClusterSnapshots API operation.
|
646
|
-
# @param [Hash] options
|
647
|
-
#
|
648
|
-
# * `:cluster_identifier` - (String) The identifier of the cluster for
|
649
|
-
# which information about snapshots is requested.
|
650
|
-
# * `:snapshot_identifier` - (String) The snapshot identifier of the
|
651
|
-
# snapshot about which to return information.
|
652
|
-
# * `:snapshot_type` - (String) The type of snapshots for which you are
|
653
|
-
# requesting information. By default, snapshots of all types are
|
654
|
-
# returned. Valid Values: automated | manual
|
655
|
-
# * `:start_time` - (String<ISO8601 datetime>) A value that requests
|
656
|
-
# only snapshots created at or after the specified time. The time
|
657
|
-
# value is specified in ISO 8601 format. For more information about
|
658
|
-
# ISO 8601, go to the ISO8601 Wikipedia page. Example:
|
659
|
-
# 2012-07-16T18:00:00Z
|
660
|
-
# * `:end_time` - (String<ISO8601 datetime>) A time value that requests
|
661
|
-
# only snapshots created at or before the specified time. The time
|
662
|
-
# value is specified in ISO 8601 format. For more information about
|
663
|
-
# ISO 8601, go to the ISO8601 Wikipedia page. Example:
|
664
|
-
# 2012-07-16T18:00:00Z
|
665
|
-
# * `:max_records` - (Integer) The maximum number of snapshot records
|
666
|
-
# to include in the response. If more records exist than the
|
667
|
-
# specified MaxRecords value, the response returns a marker that you
|
668
|
-
# can use in a subsequent DescribeClusterSnapshots request in order
|
669
|
-
# to retrieve the next set of snapshot records. Default: 100
|
670
|
-
# Constraints: Must be at least 20 and no more than 100.
|
671
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
672
|
-
# DescribeClusterSnapshots request to indicate the first snapshot
|
673
|
-
# that the request will return.
|
674
|
-
# * `:owner_account` - (String) The AWS customer account used to create
|
675
|
-
# or copy the snapshot. Use this field to filter the results to
|
676
|
-
# snapshots owned by a particular account. To describe snapshots you
|
677
|
-
# own, either specify your AWS customer account, or do not specify
|
678
|
-
# the parameter.
|
679
|
-
# @return [Core::Response]
|
680
|
-
# The #data method of the response object returns
|
681
|
-
# a hash with the following structure:
|
682
|
-
#
|
683
|
-
# * `:marker` - (String)
|
684
|
-
# * `:snapshots` - (Array<Hash>)
|
685
|
-
# * `:snapshot_identifier` - (String)
|
686
|
-
# * `:cluster_identifier` - (String)
|
687
|
-
# * `:snapshot_create_time` - (Time)
|
688
|
-
# * `:status` - (String)
|
689
|
-
# * `:port` - (Integer)
|
690
|
-
# * `:availability_zone` - (String)
|
691
|
-
# * `:cluster_create_time` - (Time)
|
692
|
-
# * `:master_username` - (String)
|
693
|
-
# * `:cluster_version` - (String)
|
694
|
-
# * `:snapshot_type` - (String)
|
695
|
-
# * `:node_type` - (String)
|
696
|
-
# * `:number_of_nodes` - (Integer)
|
697
|
-
# * `:db_name` - (String)
|
698
|
-
# * `:vpc_id` - (String)
|
699
|
-
# * `:encrypted` - (Boolean)
|
700
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
701
|
-
# * `:account_id` - (String)
|
702
|
-
# * `:owner_account` - (String)
|
703
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
704
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
705
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
706
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
707
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
708
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
709
|
-
|
710
|
-
# @!method describe_cluster_subnet_groups(options = {})
|
711
|
-
# Calls the DescribeClusterSubnetGroups API operation.
|
712
|
-
# @param [Hash] options
|
713
|
-
#
|
714
|
-
# * `:cluster_subnet_group_name` - (String) The name of the cluster
|
715
|
-
# subnet group for which information is requested.
|
716
|
-
# * `:max_records` - (Integer) The maximum number of cluster subnet
|
717
|
-
# group records to include in the response. If more records exist
|
718
|
-
# than the specified MaxRecords value, the response returns a marker
|
719
|
-
# that you can use in a subsequent DescribeClusterSubnetGroups
|
720
|
-
# request in order to retrieve the next set of cluster subnet group
|
721
|
-
# records. Default: 100 Constraints: Must be at least 20 and no more
|
722
|
-
# than 100.
|
723
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
724
|
-
# DescribeClusterSubnetGroups request to indicate the first cluster
|
725
|
-
# subnet group that the current request will return.
|
726
|
-
# @return [Core::Response]
|
727
|
-
# The #data method of the response object returns
|
728
|
-
# a hash with the following structure:
|
729
|
-
#
|
730
|
-
# * `:marker` - (String)
|
731
|
-
# * `:cluster_subnet_groups` - (Array<Hash>)
|
732
|
-
# * `:cluster_subnet_group_name` - (String)
|
733
|
-
# * `:description` - (String)
|
734
|
-
# * `:vpc_id` - (String)
|
735
|
-
# * `:subnet_group_status` - (String)
|
736
|
-
# * `:subnets` - (Array<Hash>)
|
737
|
-
# * `:subnet_identifier` - (String)
|
738
|
-
# * `:subnet_availability_zone` - (Hash)
|
739
|
-
# * `:name` - (String)
|
740
|
-
# * `:subnet_status` - (String)
|
741
|
-
|
742
|
-
# @!method describe_cluster_versions(options = {})
|
743
|
-
# Calls the DescribeClusterVersions API operation.
|
744
|
-
# @param [Hash] options
|
745
|
-
#
|
746
|
-
# * `:cluster_version` - (String) The specific cluster version to
|
747
|
-
# return. Example: 1.0
|
748
|
-
# * `:cluster_parameter_group_family` - (String) The name of a specific
|
749
|
-
# cluster parameter group family to return details for. Constraints:
|
750
|
-
# Must be 1 to 255 alphanumeric characters First character must be a
|
751
|
-
# letter Cannot end with a hyphen or contain two consecutive hyphens
|
752
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
753
|
-
# in the response. If more than the MaxRecords value is available, a
|
754
|
-
# marker is included in the response so that the following results
|
755
|
-
# can be retrieved. Default: 100 Constraints: Value must be at least
|
756
|
-
# 20 and no more than 100.
|
757
|
-
# * `:marker` - (String) The marker returned from a previous request.
|
758
|
-
# If this parameter is specified, the response includes records
|
759
|
-
# beyond the marker only, up to MaxRecords.
|
760
|
-
# @return [Core::Response]
|
761
|
-
# The #data method of the response object returns
|
762
|
-
# a hash with the following structure:
|
763
|
-
#
|
764
|
-
# * `:marker` - (String)
|
765
|
-
# * `:cluster_versions` - (Array<Hash>)
|
766
|
-
# * `:cluster_version` - (String)
|
767
|
-
# * `:cluster_parameter_group_family` - (String)
|
768
|
-
# * `:description` - (String)
|
769
|
-
|
770
|
-
# @!method describe_clusters(options = {})
|
771
|
-
# Calls the DescribeClusters API operation.
|
772
|
-
# @param [Hash] options
|
773
|
-
#
|
774
|
-
# * `:cluster_identifier` - (String) The unique identifier of a cluster
|
775
|
-
# whose properties you are requesting. This parameter isn't case
|
776
|
-
# sensitive. The default is that all clusters defined for an account
|
777
|
-
# are returned.
|
778
|
-
# * `:max_records` - (Integer) The maximum number of records that the
|
779
|
-
# response can include. If more records exist than the specified
|
780
|
-
# MaxRecords value, a marker is included in the response that can be
|
781
|
-
# used in a new DescribeClusters request to continue listing results.
|
782
|
-
# Default: 100 Constraints: Value must be at least 20 and no more
|
783
|
-
# than 100.
|
784
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
785
|
-
# DescribeClusters request to indicate the first cluster that the
|
786
|
-
# current DescribeClusters request will return. You can specify
|
787
|
-
# either a Marker parameter or a ClusterIdentifier parameter in a
|
788
|
-
# DescribeClusters request, but not both.
|
789
|
-
# @return [Core::Response]
|
790
|
-
# The #data method of the response object returns
|
791
|
-
# a hash with the following structure:
|
792
|
-
#
|
793
|
-
# * `:marker` - (String)
|
794
|
-
# * `:clusters` - (Array<Hash>)
|
795
|
-
# * `:cluster_identifier` - (String)
|
796
|
-
# * `:node_type` - (String)
|
797
|
-
# * `:cluster_status` - (String)
|
798
|
-
# * `:modify_status` - (String)
|
799
|
-
# * `:master_username` - (String)
|
800
|
-
# * `:db_name` - (String)
|
801
|
-
# * `:endpoint` - (Hash)
|
802
|
-
# * `:address` - (String)
|
803
|
-
# * `:port` - (Integer)
|
804
|
-
# * `:cluster_create_time` - (Time)
|
805
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
806
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
807
|
-
# * `:cluster_security_group_name` - (String)
|
808
|
-
# * `:status` - (String)
|
809
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
810
|
-
# * `:vpc_security_group_id` - (String)
|
811
|
-
# * `:status` - (String)
|
812
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
813
|
-
# * `:parameter_group_name` - (String)
|
814
|
-
# * `:parameter_apply_status` - (String)
|
815
|
-
# * `:cluster_subnet_group_name` - (String)
|
816
|
-
# * `:vpc_id` - (String)
|
817
|
-
# * `:availability_zone` - (String)
|
818
|
-
# * `:preferred_maintenance_window` - (String)
|
819
|
-
# * `:pending_modified_values` - (Hash)
|
820
|
-
# * `:master_user_password` - (String)
|
821
|
-
# * `:node_type` - (String)
|
822
|
-
# * `:number_of_nodes` - (Integer)
|
823
|
-
# * `:cluster_type` - (String)
|
824
|
-
# * `:cluster_version` - (String)
|
825
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
826
|
-
# * `:cluster_version` - (String)
|
827
|
-
# * `:allow_version_upgrade` - (Boolean)
|
828
|
-
# * `:number_of_nodes` - (Integer)
|
829
|
-
# * `:publicly_accessible` - (Boolean)
|
830
|
-
# * `:encrypted` - (Boolean)
|
831
|
-
|
832
|
-
# @!method describe_default_cluster_parameters(options = {})
|
833
|
-
# Calls the DescribeDefaultClusterParameters API operation.
|
834
|
-
# @param [Hash] options
|
835
|
-
#
|
836
|
-
# * `:parameter_group_family` - *required* - (String) The name of the
|
837
|
-
# cluster parameter group family.
|
838
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
839
|
-
# in the response. If more records exist than the specified
|
840
|
-
# MaxRecords value, a marker is included in the response so that the
|
841
|
-
# remaining results may be retrieved. Default: 100 Constraints: Value
|
842
|
-
# must be at least 20 and no more than 100.
|
843
|
-
# * `:marker` - (String) An optional marker returned from a previous
|
844
|
-
# DescribeDefaultClusterParameters request. If this parameter is
|
845
|
-
# specified, the response includes only records beyond the marker, up
|
846
|
-
# to the value specified by MaxRecords.
|
847
|
-
# @return [Core::Response]
|
848
|
-
# The #data method of the response object returns
|
849
|
-
# a hash with the following structure:
|
850
|
-
#
|
851
|
-
# * `:parameter_group_family` - (String)
|
852
|
-
# * `:marker` - (String)
|
853
|
-
# * `:parameters` - (Array<Hash>)
|
854
|
-
# * `:parameter_name` - (String)
|
855
|
-
# * `:parameter_value` - (String)
|
856
|
-
# * `:description` - (String)
|
857
|
-
# * `:source` - (String)
|
858
|
-
# * `:data_type` - (String)
|
859
|
-
# * `:allowed_values` - (String)
|
860
|
-
# * `:is_modifiable` - (Boolean)
|
861
|
-
# * `:minimum_engine_version` - (String)
|
862
|
-
|
863
|
-
# @!method describe_events(options = {})
|
864
|
-
# Calls the DescribeEvents API operation.
|
865
|
-
# @param [Hash] options
|
866
|
-
#
|
867
|
-
# * `:source_identifier` - (String) The identifier of the event source
|
868
|
-
# for which events will be returned. If this parameter is not
|
869
|
-
# specified, then all sources are included in the response.
|
870
|
-
# Constraints: If SourceIdentifier is supplied, SourceType must also
|
871
|
-
# be provided. Specify a cluster identifier when SourceType is
|
872
|
-
# cluster. Specify a cluster security group name when SourceType is
|
873
|
-
# cluster-security-group. Specify a cluster parameter group name when
|
874
|
-
# SourceType is cluster-parameter-group. Specify a cluster snapshot
|
875
|
-
# identifier when SourceType is cluster-snapshot.
|
876
|
-
# * `:source_type` - (String) The event source to retrieve events for.
|
877
|
-
# If no value is specified, all events are returned. Constraints: If
|
878
|
-
# SourceType is supplied, SourceIdentifier must also be provided.
|
879
|
-
# Specify cluster when SourceIdentifier is a cluster identifier.
|
880
|
-
# Specify cluster-security-group when SourceIdentifier is a cluster
|
881
|
-
# security group name. Specify cluster-parameter-group when
|
882
|
-
# SourceIdentifier is a cluster parameter group name. Specify
|
883
|
-
# cluster-snapshot when SourceIdentifier is a cluster snapshot
|
884
|
-
# identifier. Valid values include:
|
885
|
-
# * `cluster`
|
886
|
-
# * `cluster-parameter-group`
|
887
|
-
# * `cluster-security-group`
|
888
|
-
# * `cluster-snapshot`
|
889
|
-
# * `:start_time` - (String<ISO8601 datetime>) The beginning of the
|
890
|
-
# time interval to retrieve events for, specified in ISO 8601 format.
|
891
|
-
# For more information about ISO 8601, go to the ISO8601 Wikipedia
|
892
|
-
# page. Example: 2009-07-08T18:00Z
|
893
|
-
# * `:end_time` - (String<ISO8601 datetime>) The end of the time
|
894
|
-
# interval for which to retrieve events, specified in ISO 8601
|
895
|
-
# format. For more information about ISO 8601, go to the ISO8601
|
896
|
-
# Wikipedia page. Example: 2009-07-08T18:00Z
|
897
|
-
# * `:duration` - (Integer) The number of minutes prior to the time of
|
898
|
-
# the request for which to retrieve events. For example, if the
|
899
|
-
# request is sent at 18:00 and you specify a duration of 60, then
|
900
|
-
# only events which have occurred after 17:00 will be returned.
|
901
|
-
# Default: 60
|
902
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
903
|
-
# in the response. If more records exist than the specified
|
904
|
-
# MaxRecords value, a marker is included in the response so that the
|
905
|
-
# remaining results may be retrieved. Default: 100 Constraints: Value
|
906
|
-
# must be at least 20 and no more than 100.
|
907
|
-
# * `:marker` - (String) An optional marker returned from a previous
|
908
|
-
# DescribeEvents request. If this parameter is specified, the
|
909
|
-
# response includes only records beyond the marker, up to the value
|
910
|
-
# specified by MaxRecords.
|
911
|
-
# @return [Core::Response]
|
912
|
-
# The #data method of the response object returns
|
913
|
-
# a hash with the following structure:
|
914
|
-
#
|
915
|
-
# * `:marker` - (String)
|
916
|
-
# * `:events` - (Array<Hash>)
|
917
|
-
# * `:source_identifier` - (String)
|
918
|
-
# * `:source_type` - (String)
|
919
|
-
# * `:message` - (String)
|
920
|
-
# * `:date` - (Time)
|
921
|
-
|
922
|
-
# @!method describe_orderable_cluster_options(options = {})
|
923
|
-
# Calls the DescribeOrderableClusterOptions API operation.
|
924
|
-
# @param [Hash] options
|
925
|
-
#
|
926
|
-
# * `:cluster_version` - (String) The version filter value. Specify
|
927
|
-
# this parameter to show only the available offerings matching the
|
928
|
-
# specified version. Default: All versions. Constraints: Must be one
|
929
|
-
# of the version returned from DescribeClusterVersions.
|
930
|
-
# * `:node_type` - (String) The node type filter value. Specify this
|
931
|
-
# parameter to show only the available offerings matching the
|
932
|
-
# specified node type.
|
933
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
934
|
-
# in the response. If more records exist than the specified
|
935
|
-
# MaxRecords value, a marker is included in the response so that the
|
936
|
-
# remaining results may be retrieved. Default: 100 Constraints:
|
937
|
-
# minimum 20, maximum 100.
|
938
|
-
# * `:marker` - (String) An optional marker returned from a previous
|
939
|
-
# DescribeOrderableClusterOptions request. If this parameter is
|
940
|
-
# specified, the response includes only records beyond the marker, up
|
941
|
-
# to the value specified by MaxRecords.
|
942
|
-
# @return [Core::Response]
|
943
|
-
# The #data method of the response object returns
|
944
|
-
# a hash with the following structure:
|
945
|
-
#
|
946
|
-
# * `:orderable_cluster_options` - (Array<Hash>)
|
947
|
-
# * `:cluster_version` - (String)
|
948
|
-
# * `:cluster_type` - (String)
|
949
|
-
# * `:node_type` - (String)
|
950
|
-
# * `:availability_zones` - (Array<Hash>)
|
951
|
-
# * `:name` - (String)
|
952
|
-
# * `:marker` - (String)
|
953
|
-
|
954
|
-
# @!method describe_reserved_node_offerings(options = {})
|
955
|
-
# Calls the DescribeReservedNodeOfferings API operation.
|
956
|
-
# @param [Hash] options
|
957
|
-
#
|
958
|
-
# * `:reserved_node_offering_id` - (String) The unique identifier for
|
959
|
-
# the offering.
|
960
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
961
|
-
# in the response. If more records exist than the specified
|
962
|
-
# MaxRecords value, a marker is included in the response so that the
|
963
|
-
# remaining results may be retrieved. Default: 100 Constraints:
|
964
|
-
# minimum 20, maximum 100.
|
965
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
966
|
-
# DescribeReservedNodeOfferings request to indicate the first
|
967
|
-
# offering that the request will return. You can specify either a
|
968
|
-
# Marker parameter or a ClusterIdentifier parameter in a
|
969
|
-
# DescribeClusters request, but not both.
|
970
|
-
# @return [Core::Response]
|
971
|
-
# The #data method of the response object returns
|
972
|
-
# a hash with the following structure:
|
973
|
-
#
|
974
|
-
# * `:marker` - (String)
|
975
|
-
# * `:reserved_node_offerings` - (Array<Hash>)
|
976
|
-
# * `:reserved_node_offering_id` - (String)
|
977
|
-
# * `:node_type` - (String)
|
978
|
-
# * `:duration` - (Integer)
|
979
|
-
# * `:fixed_price` - (Numeric)
|
980
|
-
# * `:usage_price` - (Numeric)
|
981
|
-
# * `:currency_code` - (String)
|
982
|
-
# * `:offering_type` - (String)
|
983
|
-
# * `:recurring_charges` - (Array<Hash>)
|
984
|
-
# * `:recurring_charge_amount` - (Numeric)
|
985
|
-
# * `:recurring_charge_frequency` - (String)
|
986
|
-
|
987
|
-
# @!method describe_reserved_nodes(options = {})
|
988
|
-
# Calls the DescribeReservedNodes API operation.
|
989
|
-
# @param [Hash] options
|
990
|
-
#
|
991
|
-
# * `:reserved_node_id` - (String) Identifier for the node reservation.
|
992
|
-
# * `:max_records` - (Integer) The maximum number of records to include
|
993
|
-
# in the response. If more records exist than the specified
|
994
|
-
# MaxRecords value, a marker is included in the response so that the
|
995
|
-
# remaining results may be retrieved. Default: 100 Constraints:
|
996
|
-
# minimum 20, maximum 100.
|
997
|
-
# * `:marker` - (String) An optional marker returned by a previous
|
998
|
-
# DescribeReservedNodes request to indicate the first parameter group
|
999
|
-
# that the current request will return.
|
1000
|
-
# @return [Core::Response]
|
1001
|
-
# The #data method of the response object returns
|
1002
|
-
# a hash with the following structure:
|
1003
|
-
#
|
1004
|
-
# * `:marker` - (String)
|
1005
|
-
# * `:reserved_nodes` - (Array<Hash>)
|
1006
|
-
# * `:reserved_node_id` - (String)
|
1007
|
-
# * `:reserved_node_offering_id` - (String)
|
1008
|
-
# * `:node_type` - (String)
|
1009
|
-
# * `:start_time` - (Time)
|
1010
|
-
# * `:duration` - (Integer)
|
1011
|
-
# * `:fixed_price` - (Numeric)
|
1012
|
-
# * `:usage_price` - (Numeric)
|
1013
|
-
# * `:currency_code` - (String)
|
1014
|
-
# * `:node_count` - (Integer)
|
1015
|
-
# * `:state` - (String)
|
1016
|
-
# * `:offering_type` - (String)
|
1017
|
-
# * `:recurring_charges` - (Array<Hash>)
|
1018
|
-
# * `:recurring_charge_amount` - (Numeric)
|
1019
|
-
# * `:recurring_charge_frequency` - (String)
|
1020
|
-
|
1021
|
-
# @!method describe_resize(options = {})
|
1022
|
-
# Calls the DescribeResize API operation.
|
1023
|
-
# @param [Hash] options
|
1024
|
-
#
|
1025
|
-
# * `:cluster_identifier` - *required* - (String) The unique identifier
|
1026
|
-
# of a cluster whose resize progress you are requesting. This
|
1027
|
-
# parameter isn't case-sensitive. By default, resize operations for
|
1028
|
-
# all clusters defined for an AWS account are returned.
|
1029
|
-
# @return [Core::Response]
|
1030
|
-
# The #data method of the response object returns
|
1031
|
-
# a hash with the following structure:
|
1032
|
-
#
|
1033
|
-
# * `:target_node_type` - (String)
|
1034
|
-
# * `:target_number_of_nodes` - (Integer)
|
1035
|
-
# * `:target_cluster_type` - (String)
|
1036
|
-
# * `:status` - (String)
|
1037
|
-
# * `:import_tables_completed` - (Array<String>)
|
1038
|
-
# * `:import_tables_in_progress` - (Array<String>)
|
1039
|
-
# * `:import_tables_not_started` - (Array<String>)
|
1040
|
-
|
1041
|
-
# @!method modify_cluster(options = {})
|
1042
|
-
# Calls the ModifyCluster API operation.
|
1043
|
-
# @param [Hash] options
|
1044
|
-
#
|
1045
|
-
# * `:cluster_identifier` - *required* - (String) The unique identifier
|
1046
|
-
# of the cluster to be modified. Example: examplecluster
|
1047
|
-
# * `:cluster_type` - (String) The new cluster type. When you submit
|
1048
|
-
# your cluster resize request, your existing cluster goes into a
|
1049
|
-
# read-only mode. After Amazon Redshift provisions a new cluster
|
1050
|
-
# based on your resize requirements, there will be outage for a
|
1051
|
-
# period while the old cluster is deleted and your connection is
|
1052
|
-
# switched to the new cluster. You can use DescribeResize to track
|
1053
|
-
# the progress of the resize request. Valid Values: multi-node |
|
1054
|
-
# single-node
|
1055
|
-
# * `:node_type` - (String) The new node type of the cluster. If you
|
1056
|
-
# specify a new node type, you must also specify the number of nodes
|
1057
|
-
# parameter also. When you submit your request to resize a cluster,
|
1058
|
-
# Amazon Redshift sets access permissions for the cluster to
|
1059
|
-
# read-only. After Amazon Redshift provisions a new cluster according
|
1060
|
-
# to your resize requirements, there will be a temporary outage while
|
1061
|
-
# the old cluster is deleted and your connection is switched to the
|
1062
|
-
# new cluster. When the new connection is complete, the original
|
1063
|
-
# access permissions for the cluster are restored. You can use the
|
1064
|
-
# DescribeResize to track the progress of the resize request. Valid
|
1065
|
-
# Values: dw.hs1.xlarge | dw.hs1.8xlarge
|
1066
|
-
# * `:number_of_nodes` - (Integer) The new number of nodes of the
|
1067
|
-
# cluster. If you specify a new number of nodes, you must also
|
1068
|
-
# specify the node type parameter also. When you submit your request
|
1069
|
-
# to resize a cluster, Amazon Redshift sets access permissions for
|
1070
|
-
# the cluster to read-only. After Amazon Redshift provisions a new
|
1071
|
-
# cluster according to your resize requirements, there will be a
|
1072
|
-
# temporary outage while the old cluster is deleted and your
|
1073
|
-
# connection is switched to the new cluster. When the new connection
|
1074
|
-
# is complete, the original access permissions for the cluster are
|
1075
|
-
# restored. You can use DescribeResize to track the progress of the
|
1076
|
-
# resize request. Valid Values: Integer greater than 0.
|
1077
|
-
# * `:cluster_security_groups` - (Array<String>) A list of cluster
|
1078
|
-
# security groups to be authorized on this cluster. This change is
|
1079
|
-
# asynchronously applied as soon as possible. Security groups
|
1080
|
-
# currently associated with the cluster and not in the list of groups
|
1081
|
-
# to apply, will be revoked from the cluster. Constraints: Must be 1
|
1082
|
-
# to 255 alphanumeric characters or hyphens First character must be a
|
1083
|
-
# letter Cannot end with a hyphen or contain two consecutive hyphens
|
1084
|
-
# * `:vpc_security_group_ids` - (Array<String>) A list of Virtual
|
1085
|
-
# Private Cloud (VPC) security groups to be associated with the
|
1086
|
-
# cluster.
|
1087
|
-
# * `:master_user_password` - (String) The new password for the cluster
|
1088
|
-
# master user. This change is asynchronously applied as soon as
|
1089
|
-
# possible. Between the time of the request and the completion of the
|
1090
|
-
# request, the MasterUserPassword element exists in the
|
1091
|
-
# PendingModifiedValues element of the operation response. Operations
|
1092
|
-
# never return the password, so this operation provides a way to
|
1093
|
-
# regain access to the master user account for a cluster if the
|
1094
|
-
# password is lost. Default: Uses existing setting. Constraints: Must
|
1095
|
-
# be between 8 and 64 characters in length. Must contain at least one
|
1096
|
-
# uppercase letter. Must contain at least one lowercase letter. Must
|
1097
|
-
# contain one number. Can be any printable ASCII character (ASCII
|
1098
|
-
# code 33 to 126) except ' (single quote), " (double quote), \, /, @,
|
1099
|
-
# or space.
|
1100
|
-
# * `:cluster_parameter_group_name` - (String) The name of the cluster
|
1101
|
-
# parameter group to apply to this cluster. This change is applied
|
1102
|
-
# only after the cluster is rebooted. To reboot a cluster use
|
1103
|
-
# RebootCluster. Default: Uses existing setting. Constraints: The
|
1104
|
-
# cluster parameter group must be in the same parameter group family
|
1105
|
-
# that matches the cluster version.
|
1106
|
-
# * `:automated_snapshot_retention_period` - (Integer) The number of
|
1107
|
-
# days that automated snapshots are retained. If the value is 0,
|
1108
|
-
# automated snapshots are disabled. Even if automated snapshots are
|
1109
|
-
# disabled, you can still create manual snapshots when you want with
|
1110
|
-
# CreateClusterSnapshot. If you decrease the automated snapshot
|
1111
|
-
# retention period from its current value, existing automated
|
1112
|
-
# snapshots which fall outside of the new retention period will be
|
1113
|
-
# immediately deleted. Default: Uses existing setting. Constraints:
|
1114
|
-
# Must be a value from 0 to 35.
|
1115
|
-
# * `:preferred_maintenance_window` - (String) The weekly time range
|
1116
|
-
# (in UTC) during which system maintenance can occur, if necessary.
|
1117
|
-
# If system maintenance is necessary during the window, it may result
|
1118
|
-
# in an outage. This maintenance window change is made immediately.
|
1119
|
-
# If the new maintenance window indicates the current time, there
|
1120
|
-
# must be at least 120 minutes between the current time and end of
|
1121
|
-
# the window in order to ensure that pending changes are applied.
|
1122
|
-
# Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi,
|
1123
|
-
# for example wed:07:30-wed:08:00. Valid Days: Mon | Tue | Wed | Thu
|
1124
|
-
# | Fri | Sat | Sun Constraints: Must be at least 30 minutes.
|
1125
|
-
# * `:cluster_version` - (String) The new version number of the Amazon
|
1126
|
-
# Redshift engine to upgrade to. For major version upgrades, if a
|
1127
|
-
# non-default cluster parameter group is currently in use, a new
|
1128
|
-
# cluster parameter group in the cluster parameter group family for
|
1129
|
-
# the new version must be specified. The new cluster parameter group
|
1130
|
-
# can be the default for that cluster parameter group family. For
|
1131
|
-
# more information about managing parameter groups, go to Amazon
|
1132
|
-
# Redshift Parameter Groups in the Amazon Redshift Management Guide.
|
1133
|
-
# Example: 1.0
|
1134
|
-
# * `:allow_version_upgrade` - (Boolean) If `true` , upgrades will be
|
1135
|
-
# applied automatically to the cluster during the maintenance window.
|
1136
|
-
# Default: `false`
|
1137
|
-
# @return [Core::Response]
|
1138
|
-
# The #data method of the response object returns
|
1139
|
-
# a hash with the following structure:
|
1140
|
-
#
|
1141
|
-
# * `:cluster_identifier` - (String)
|
1142
|
-
# * `:node_type` - (String)
|
1143
|
-
# * `:cluster_status` - (String)
|
1144
|
-
# * `:modify_status` - (String)
|
1145
|
-
# * `:master_username` - (String)
|
1146
|
-
# * `:db_name` - (String)
|
1147
|
-
# * `:endpoint` - (Hash)
|
1148
|
-
# * `:address` - (String)
|
1149
|
-
# * `:port` - (Integer)
|
1150
|
-
# * `:cluster_create_time` - (Time)
|
1151
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1152
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
1153
|
-
# * `:cluster_security_group_name` - (String)
|
1154
|
-
# * `:status` - (String)
|
1155
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1156
|
-
# * `:vpc_security_group_id` - (String)
|
1157
|
-
# * `:status` - (String)
|
1158
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
1159
|
-
# * `:parameter_group_name` - (String)
|
1160
|
-
# * `:parameter_apply_status` - (String)
|
1161
|
-
# * `:cluster_subnet_group_name` - (String)
|
1162
|
-
# * `:vpc_id` - (String)
|
1163
|
-
# * `:availability_zone` - (String)
|
1164
|
-
# * `:preferred_maintenance_window` - (String)
|
1165
|
-
# * `:pending_modified_values` - (Hash)
|
1166
|
-
# * `:master_user_password` - (String)
|
1167
|
-
# * `:node_type` - (String)
|
1168
|
-
# * `:number_of_nodes` - (Integer)
|
1169
|
-
# * `:cluster_type` - (String)
|
1170
|
-
# * `:cluster_version` - (String)
|
1171
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1172
|
-
# * `:cluster_version` - (String)
|
1173
|
-
# * `:allow_version_upgrade` - (Boolean)
|
1174
|
-
# * `:number_of_nodes` - (Integer)
|
1175
|
-
# * `:publicly_accessible` - (Boolean)
|
1176
|
-
# * `:encrypted` - (Boolean)
|
1177
|
-
|
1178
|
-
# @!method modify_cluster_parameter_group(options = {})
|
1179
|
-
# Calls the ModifyClusterParameterGroup API operation.
|
1180
|
-
# @param [Hash] options
|
1181
|
-
#
|
1182
|
-
# * `:parameter_group_name` - *required* - (String) The name of the
|
1183
|
-
# parameter group to be modified.
|
1184
|
-
# * `:parameters` - *required* - (Array<Hash>) An array of parameters
|
1185
|
-
# to be modified. A maximum of 20 parameters can be modified in a
|
1186
|
-
# single request. For each parameter to be modified, you must supply
|
1187
|
-
# at least the parameter name and parameter value; other name-value
|
1188
|
-
# pairs of the parameter are optional.
|
1189
|
-
# * `:parameter_name` - (String) The name of the parameter.
|
1190
|
-
# * `:parameter_value` - (String) The value of the parameter.
|
1191
|
-
# * `:description` - (String) A description of the parameter.
|
1192
|
-
# * `:source` - (String) The source of the parameter value, such as
|
1193
|
-
# "engine-default" or "user".
|
1194
|
-
# * `:data_type` - (String) The data type of the parameter.
|
1195
|
-
# * `:allowed_values` - (String) The valid range of values for the
|
1196
|
-
# parameter.
|
1197
|
-
# * `:is_modifiable` - (Boolean) If `true` , the parameter can be
|
1198
|
-
# modified. Some parameters have security or operational
|
1199
|
-
# implications that prevent them from being changed.
|
1200
|
-
# * `:minimum_engine_version` - (String) The earliest engine version
|
1201
|
-
# to which the parameter can apply.
|
1202
|
-
# @return [Core::Response]
|
1203
|
-
# The #data method of the response object returns
|
1204
|
-
# a hash with the following structure:
|
1205
|
-
#
|
1206
|
-
# * `:parameter_group_name` - (String)
|
1207
|
-
# * `:parameter_group_status` - (String)
|
1208
|
-
|
1209
|
-
# @!method modify_cluster_subnet_group(options = {})
|
1210
|
-
# Calls the ModifyClusterSubnetGroup API operation.
|
1211
|
-
# @param [Hash] options
|
1212
|
-
#
|
1213
|
-
# * `:cluster_subnet_group_name` - *required* - (String) The name of
|
1214
|
-
# the subnet group to be modified.
|
1215
|
-
# * `:description` - (String) A text description of the subnet group to
|
1216
|
-
# be modified.
|
1217
|
-
# * `:subnet_ids` - *required* - (Array<String>) An array of VPC subnet
|
1218
|
-
# IDs. A maximum of 20 subnets can be modified in a single request.
|
1219
|
-
# @return [Core::Response]
|
1220
|
-
# The #data method of the response object returns
|
1221
|
-
# a hash with the following structure:
|
1222
|
-
#
|
1223
|
-
# * `:cluster_subnet_group_name` - (String)
|
1224
|
-
# * `:description` - (String)
|
1225
|
-
# * `:vpc_id` - (String)
|
1226
|
-
# * `:subnet_group_status` - (String)
|
1227
|
-
# * `:subnets` - (Array<Hash>)
|
1228
|
-
# * `:subnet_identifier` - (String)
|
1229
|
-
# * `:subnet_availability_zone` - (Hash)
|
1230
|
-
# * `:name` - (String)
|
1231
|
-
# * `:subnet_status` - (String)
|
1232
|
-
|
1233
|
-
# @!method purchase_reserved_node_offering(options = {})
|
1234
|
-
# Calls the PurchaseReservedNodeOffering API operation.
|
1235
|
-
# @param [Hash] options
|
1236
|
-
#
|
1237
|
-
# * `:reserved_node_offering_id` - *required* - (String) The unique
|
1238
|
-
# identifier of the reserved node offering you want to purchase.
|
1239
|
-
# * `:node_count` - (Integer) The number of reserved nodes you want to
|
1240
|
-
# purchase. Default: 1
|
1241
|
-
# @return [Core::Response]
|
1242
|
-
# The #data method of the response object returns
|
1243
|
-
# a hash with the following structure:
|
1244
|
-
#
|
1245
|
-
# * `:reserved_node_id` - (String)
|
1246
|
-
# * `:reserved_node_offering_id` - (String)
|
1247
|
-
# * `:node_type` - (String)
|
1248
|
-
# * `:start_time` - (Time)
|
1249
|
-
# * `:duration` - (Integer)
|
1250
|
-
# * `:fixed_price` - (Numeric)
|
1251
|
-
# * `:usage_price` - (Numeric)
|
1252
|
-
# * `:currency_code` - (String)
|
1253
|
-
# * `:node_count` - (Integer)
|
1254
|
-
# * `:state` - (String)
|
1255
|
-
# * `:offering_type` - (String)
|
1256
|
-
# * `:recurring_charges` - (Array<Hash>)
|
1257
|
-
# * `:recurring_charge_amount` - (Numeric)
|
1258
|
-
# * `:recurring_charge_frequency` - (String)
|
1259
|
-
|
1260
|
-
# @!method reboot_cluster(options = {})
|
1261
|
-
# Calls the RebootCluster API operation.
|
1262
|
-
# @param [Hash] options
|
1263
|
-
#
|
1264
|
-
# * `:cluster_identifier` - *required* - (String) The cluster
|
1265
|
-
# identifier.
|
1266
|
-
# @return [Core::Response]
|
1267
|
-
# The #data method of the response object returns
|
1268
|
-
# a hash with the following structure:
|
1269
|
-
#
|
1270
|
-
# * `:cluster_identifier` - (String)
|
1271
|
-
# * `:node_type` - (String)
|
1272
|
-
# * `:cluster_status` - (String)
|
1273
|
-
# * `:modify_status` - (String)
|
1274
|
-
# * `:master_username` - (String)
|
1275
|
-
# * `:db_name` - (String)
|
1276
|
-
# * `:endpoint` - (Hash)
|
1277
|
-
# * `:address` - (String)
|
1278
|
-
# * `:port` - (Integer)
|
1279
|
-
# * `:cluster_create_time` - (Time)
|
1280
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1281
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
1282
|
-
# * `:cluster_security_group_name` - (String)
|
1283
|
-
# * `:status` - (String)
|
1284
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1285
|
-
# * `:vpc_security_group_id` - (String)
|
1286
|
-
# * `:status` - (String)
|
1287
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
1288
|
-
# * `:parameter_group_name` - (String)
|
1289
|
-
# * `:parameter_apply_status` - (String)
|
1290
|
-
# * `:cluster_subnet_group_name` - (String)
|
1291
|
-
# * `:vpc_id` - (String)
|
1292
|
-
# * `:availability_zone` - (String)
|
1293
|
-
# * `:preferred_maintenance_window` - (String)
|
1294
|
-
# * `:pending_modified_values` - (Hash)
|
1295
|
-
# * `:master_user_password` - (String)
|
1296
|
-
# * `:node_type` - (String)
|
1297
|
-
# * `:number_of_nodes` - (Integer)
|
1298
|
-
# * `:cluster_type` - (String)
|
1299
|
-
# * `:cluster_version` - (String)
|
1300
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1301
|
-
# * `:cluster_version` - (String)
|
1302
|
-
# * `:allow_version_upgrade` - (Boolean)
|
1303
|
-
# * `:number_of_nodes` - (Integer)
|
1304
|
-
# * `:publicly_accessible` - (Boolean)
|
1305
|
-
# * `:encrypted` - (Boolean)
|
1306
|
-
|
1307
|
-
# @!method reset_cluster_parameter_group(options = {})
|
1308
|
-
# Calls the ResetClusterParameterGroup API operation.
|
1309
|
-
# @param [Hash] options
|
1310
|
-
#
|
1311
|
-
# * `:parameter_group_name` - *required* - (String) The name of the
|
1312
|
-
# cluster parameter group to be reset.
|
1313
|
-
# * `:reset_all_parameters` - (Boolean) If `true` , all parameters in
|
1314
|
-
# the specified parameter group will be reset to their default
|
1315
|
-
# values. Default: `true`
|
1316
|
-
# * `:parameters` - (Array<Hash>) An array of names of parameters to be
|
1317
|
-
# reset. If ResetAllParameters option is not used, then at least one
|
1318
|
-
# parameter name must be supplied. Constraints: A maximum of 20
|
1319
|
-
# parameters can be reset in a single request.
|
1320
|
-
# * `:parameter_name` - (String) The name of the parameter.
|
1321
|
-
# * `:parameter_value` - (String) The value of the parameter.
|
1322
|
-
# * `:description` - (String) A description of the parameter.
|
1323
|
-
# * `:source` - (String) The source of the parameter value, such as
|
1324
|
-
# "engine-default" or "user".
|
1325
|
-
# * `:data_type` - (String) The data type of the parameter.
|
1326
|
-
# * `:allowed_values` - (String) The valid range of values for the
|
1327
|
-
# parameter.
|
1328
|
-
# * `:is_modifiable` - (Boolean) If `true` , the parameter can be
|
1329
|
-
# modified. Some parameters have security or operational
|
1330
|
-
# implications that prevent them from being changed.
|
1331
|
-
# * `:minimum_engine_version` - (String) The earliest engine version
|
1332
|
-
# to which the parameter can apply.
|
1333
|
-
# @return [Core::Response]
|
1334
|
-
# The #data method of the response object returns
|
1335
|
-
# a hash with the following structure:
|
1336
|
-
#
|
1337
|
-
# * `:parameter_group_name` - (String)
|
1338
|
-
# * `:parameter_group_status` - (String)
|
1339
|
-
|
1340
|
-
# @!method restore_from_cluster_snapshot(options = {})
|
1341
|
-
# Calls the RestoreFromClusterSnapshot API operation.
|
1342
|
-
# @param [Hash] options
|
1343
|
-
#
|
1344
|
-
# * `:cluster_identifier` - *required* - (String) The identifier of the
|
1345
|
-
# cluster that will be created from restoring the snapshot.
|
1346
|
-
# Constraints: Must contain from 1 to 63 alphanumeric characters or
|
1347
|
-
# hyphens. Alphabetic characters must be lowercase. First character
|
1348
|
-
# must be a letter. Cannot end with a hyphen or contain two
|
1349
|
-
# consecutive hyphens. Must be unique for all clusters within an AWS
|
1350
|
-
# account.
|
1351
|
-
# * `:snapshot_identifier` - *required* - (String) The name of the
|
1352
|
-
# snapshot from which to create the new cluster. This parameter isn't
|
1353
|
-
# case sensitive. Example: my-snapshot-id
|
1354
|
-
# * `:port` - (Integer) The port number on which the cluster accepts
|
1355
|
-
# connections. Default: The same port as the original cluster.
|
1356
|
-
# Constraints: Must be between 1115 and 65535.
|
1357
|
-
# * `:availability_zone` - (String) The Amazon EC2 Availability Zone in
|
1358
|
-
# which to restore the cluster. Default: A random, system-chosen
|
1359
|
-
# Availability Zone. Example: us-east-1a
|
1360
|
-
# * `:allow_version_upgrade` - (Boolean) If `true` , upgrades can be
|
1361
|
-
# applied during the maintenance window to the Amazon Redshift engine
|
1362
|
-
# that is running on the cluster. Default: `true`
|
1363
|
-
# * `:cluster_subnet_group_name` - (String) The name of the subnet
|
1364
|
-
# group where you want to cluster restored. A snapshot of cluster in
|
1365
|
-
# VPC can be restored only in VPC. Therefore, you must provide subnet
|
1366
|
-
# group name where you want the cluster restored.
|
1367
|
-
# * `:publicly_accessible` - (Boolean) If `true` , the cluster can be
|
1368
|
-
# accessed from a public network.
|
1369
|
-
# * `:owner_account` - (String) The AWS customer account used to create
|
1370
|
-
# or copy the snapshot. Required if you are restoring a snapshot you
|
1371
|
-
# do not own, optional if you own the snapshot.
|
1372
|
-
# @return [Core::Response]
|
1373
|
-
# The #data method of the response object returns
|
1374
|
-
# a hash with the following structure:
|
1375
|
-
#
|
1376
|
-
# * `:cluster_identifier` - (String)
|
1377
|
-
# * `:node_type` - (String)
|
1378
|
-
# * `:cluster_status` - (String)
|
1379
|
-
# * `:modify_status` - (String)
|
1380
|
-
# * `:master_username` - (String)
|
1381
|
-
# * `:db_name` - (String)
|
1382
|
-
# * `:endpoint` - (Hash)
|
1383
|
-
# * `:address` - (String)
|
1384
|
-
# * `:port` - (Integer)
|
1385
|
-
# * `:cluster_create_time` - (Time)
|
1386
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1387
|
-
# * `:cluster_security_groups` - (Array<Hash>)
|
1388
|
-
# * `:cluster_security_group_name` - (String)
|
1389
|
-
# * `:status` - (String)
|
1390
|
-
# * `:vpc_security_groups` - (Array<Hash>)
|
1391
|
-
# * `:vpc_security_group_id` - (String)
|
1392
|
-
# * `:status` - (String)
|
1393
|
-
# * `:cluster_parameter_groups` - (Array<Hash>)
|
1394
|
-
# * `:parameter_group_name` - (String)
|
1395
|
-
# * `:parameter_apply_status` - (String)
|
1396
|
-
# * `:cluster_subnet_group_name` - (String)
|
1397
|
-
# * `:vpc_id` - (String)
|
1398
|
-
# * `:availability_zone` - (String)
|
1399
|
-
# * `:preferred_maintenance_window` - (String)
|
1400
|
-
# * `:pending_modified_values` - (Hash)
|
1401
|
-
# * `:master_user_password` - (String)
|
1402
|
-
# * `:node_type` - (String)
|
1403
|
-
# * `:number_of_nodes` - (Integer)
|
1404
|
-
# * `:cluster_type` - (String)
|
1405
|
-
# * `:cluster_version` - (String)
|
1406
|
-
# * `:automated_snapshot_retention_period` - (Integer)
|
1407
|
-
# * `:cluster_version` - (String)
|
1408
|
-
# * `:allow_version_upgrade` - (Boolean)
|
1409
|
-
# * `:number_of_nodes` - (Integer)
|
1410
|
-
# * `:publicly_accessible` - (Boolean)
|
1411
|
-
# * `:encrypted` - (Boolean)
|
1412
|
-
|
1413
|
-
# @!method revoke_cluster_security_group_ingress(options = {})
|
1414
|
-
# Calls the RevokeClusterSecurityGroupIngress API operation.
|
1415
|
-
# @param [Hash] options
|
1416
|
-
#
|
1417
|
-
# * `:cluster_security_group_name` - *required* - (String) The name of
|
1418
|
-
# the security Group from which to revoke the ingress rule.
|
1419
|
-
# * `:cidrip` - (String) The IP range for which to revoke access. This
|
1420
|
-
# range must be a valid Classless Inter-Domain Routing (CIDR) block
|
1421
|
-
# of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and
|
1422
|
-
# EC2SecurityGroupOwnerId cannot be provided.
|
1423
|
-
# * `:ec2_security_group_name` - (String) The name of the EC2 Security
|
1424
|
-
# Group whose access is to be revoked. If EC2SecurityGroupName is
|
1425
|
-
# specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP
|
1426
|
-
# cannot be provided.
|
1427
|
-
# * `:ec2_security_group_owner_id` - (String) The AWS account number of
|
1428
|
-
# the owner of the security group specified in the
|
1429
|
-
# EC2SecurityGroupName parameter. The AWS access key ID is not an
|
1430
|
-
# acceptable value. If EC2SecurityGroupOwnerId is specified,
|
1431
|
-
# EC2SecurityGroupName must also be provided. and CIDRIP cannot be
|
1432
|
-
# provided. Example: 111122223333
|
1433
|
-
# @return [Core::Response]
|
1434
|
-
# The #data method of the response object returns
|
1435
|
-
# a hash with the following structure:
|
1436
|
-
#
|
1437
|
-
# * `:cluster_security_group_name` - (String)
|
1438
|
-
# * `:description` - (String)
|
1439
|
-
# * `:ec_2_security_groups` - (Array<Hash>)
|
1440
|
-
# * `:status` - (String)
|
1441
|
-
# * `:ec2_security_group_name` - (String)
|
1442
|
-
# * `:ec2_security_group_owner_id` - (String)
|
1443
|
-
# * `:ip_ranges` - (Array<Hash>)
|
1444
|
-
# * `:status` - (String)
|
1445
|
-
# * `:cidrip` - (String)
|
1446
|
-
|
1447
|
-
# @!method revoke_snapshot_access(options = {})
|
1448
|
-
# Calls the RevokeSnapshotAccess API operation.
|
1449
|
-
# @param [Hash] options
|
1450
|
-
#
|
1451
|
-
# * `:snapshot_identifier` - *required* - (String) The identifier of
|
1452
|
-
# the snapshot that the account can no longer access.
|
1453
|
-
# * `:account_with_restore_access` - *required* - (String) The
|
1454
|
-
# identifier of the AWS customer account that can no longer restore
|
1455
|
-
# the specified snapshot.
|
1456
|
-
# @return [Core::Response]
|
1457
|
-
# The #data method of the response object returns
|
1458
|
-
# a hash with the following structure:
|
1459
|
-
#
|
1460
|
-
# * `:snapshot_identifier` - (String)
|
1461
|
-
# * `:cluster_identifier` - (String)
|
1462
|
-
# * `:snapshot_create_time` - (Time)
|
1463
|
-
# * `:status` - (String)
|
1464
|
-
# * `:port` - (Integer)
|
1465
|
-
# * `:availability_zone` - (String)
|
1466
|
-
# * `:cluster_create_time` - (Time)
|
1467
|
-
# * `:master_username` - (String)
|
1468
|
-
# * `:cluster_version` - (String)
|
1469
|
-
# * `:snapshot_type` - (String)
|
1470
|
-
# * `:node_type` - (String)
|
1471
|
-
# * `:number_of_nodes` - (Integer)
|
1472
|
-
# * `:db_name` - (String)
|
1473
|
-
# * `:vpc_id` - (String)
|
1474
|
-
# * `:encrypted` - (Boolean)
|
1475
|
-
# * `:accounts_with_restore_access` - (Array<Hash>)
|
1476
|
-
# * `:account_id` - (String)
|
1477
|
-
# * `:owner_account` - (String)
|
1478
|
-
# * `:total_backup_size_in_mega_bytes` - (Numeric)
|
1479
|
-
# * `:actual_incremental_backup_size_in_mega_bytes` - (Numeric)
|
1480
|
-
# * `:backup_progress_in_mega_bytes` - (Numeric)
|
1481
|
-
# * `:current_backup_rate_in_mega_bytes_per_second` - (Numeric)
|
1482
|
-
# * `:estimated_seconds_to_completion` - (Integer)
|
1483
|
-
# * `:elapsed_time_in_seconds` - (Integer)
|
1484
|
-
|
1485
|
-
# end client methods #
|
1486
|
-
|
1487
29
|
define_client_methods('2012-12-01')
|
1488
30
|
|
1489
31
|
end
|