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