/
api_op_RestoreFromClusterSnapshot.go
303 lines (264 loc) · 12.2 KB
/
api_op_RestoreFromClusterSnapshot.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
// Code generated by smithy-go-codegen DO NOT EDIT.
package redshift
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/redshift/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a new cluster from a snapshot. By default, Amazon Redshift creates the
// resulting cluster with the same configuration as the original cluster from which
// the snapshot was created, except that the new cluster is created with the
// default cluster security and parameter groups. After Amazon Redshift creates the
// cluster, you can use the ModifyCluster API to associate a different security
// group and different parameter group with the restored cluster. If you are using
// a DS node type, you can also choose to change to another DS node type of the
// same size during restore. If you restore a cluster into a VPC, you must provide
// a cluster subnet group where you want the cluster restored. For more information
// about working with snapshots, go to Amazon Redshift Snapshots
// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)
// in the Amazon Redshift Cluster Management Guide.
func (c *Client) RestoreFromClusterSnapshot(ctx context.Context, params *RestoreFromClusterSnapshotInput, optFns ...func(*Options)) (*RestoreFromClusterSnapshotOutput, error) {
if params == nil {
params = &RestoreFromClusterSnapshotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreFromClusterSnapshot", params, optFns, addOperationRestoreFromClusterSnapshotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreFromClusterSnapshotOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type RestoreFromClusterSnapshotInput struct {
// The identifier of the cluster that will be created from restoring the snapshot.
// Constraints:
//
// * Must contain from 1 to 63 alphanumeric characters or hyphens.
//
// *
// Alphabetic characters must be lowercase.
//
// * First character must be a letter.
//
// *
// Cannot end with a hyphen or contain two consecutive hyphens.
//
// * Must be unique
// for all clusters within an AWS account.
//
// This member is required.
ClusterIdentifier *string
// The name of the snapshot from which to create the new cluster. This parameter
// isn't case sensitive. Example: my-snapshot-id
//
// This member is required.
SnapshotIdentifier *string
// Reserved.
AdditionalInfo *string
// If true, major version upgrades can be applied during the maintenance window to
// the Amazon Redshift engine that is running on the cluster. Default: true
AllowVersionUpgrade *bool
// The value represents how the cluster is configured to use AQUA (Advanced Query
// Accelerator) after the cluster is restored. Possible values include the
// following.
//
// * enabled - Use AQUA if it is available for the current AWS Region
// and Amazon Redshift node type.
//
// * disabled - Don't use AQUA.
//
// * auto - Amazon
// Redshift determines whether to use AQUA.
AquaConfigurationStatus types.AquaConfigurationStatus
// The number of days that automated snapshots are retained. If the value is 0,
// automated snapshots are disabled. Even if automated snapshots are disabled, you
// can still create manual snapshots when you want with CreateClusterSnapshot. You
// can't disable automated snapshots for RA3 node types. Set the automated
// retention period from 1-35 days. Default: The value selected for the cluster
// from which the snapshot was taken. Constraints: Must be a value from 0 to 35.
AutomatedSnapshotRetentionPeriod *int32
// The Amazon EC2 Availability Zone in which to restore the cluster. Default: A
// random, system-chosen Availability Zone. Example: us-east-2a
AvailabilityZone *string
// The option to enable relocation for an Amazon Redshift cluster between
// Availability Zones after the cluster is restored.
AvailabilityZoneRelocation *bool
// The name of the parameter group to be associated with this cluster. Default: The
// default Amazon Redshift cluster parameter group. For information about the
// default parameter group, go to Working with Amazon Redshift Parameter Groups
// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html).
// Constraints:
//
// * Must be 1 to 255 alphanumeric characters or hyphens.
//
// * First
// character must be a letter.
//
// * Cannot end with a hyphen or contain two
// consecutive hyphens.
ClusterParameterGroupName *string
// A list of security groups to be associated with this cluster. Default: The
// default cluster security group for Amazon Redshift. Cluster security groups only
// apply to clusters outside of VPCs.
ClusterSecurityGroups []string
// The name of the subnet group where you want to cluster restored. A snapshot of
// cluster in VPC can be restored only in VPC. Therefore, you must provide subnet
// group name where you want the cluster restored.
ClusterSubnetGroupName *string
// The elastic IP (EIP) address for the cluster.
ElasticIp *string
// An option that specifies whether to create the cluster with enhanced VPC routing
// enabled. To create a cluster that uses enhanced VPC routing, the cluster must be
// in a VPC. For more information, see Enhanced VPC Routing
// (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in
// the Amazon Redshift Cluster Management Guide. If this option is true, enhanced
// VPC routing is enabled. Default: false
EnhancedVpcRouting *bool
// Specifies the name of the HSM client certificate the Amazon Redshift cluster
// uses to retrieve the data encryption keys stored in an HSM.
HsmClientCertificateIdentifier *string
// Specifies the name of the HSM configuration that contains the information the
// Amazon Redshift cluster can use to retrieve and store keys in an HSM.
HsmConfigurationIdentifier *string
// A list of AWS Identity and Access Management (IAM) roles that can be used by the
// cluster to access other AWS services. You must supply the IAM roles in their
// Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single
// request. A cluster can have up to 10 IAM roles associated at any time.
IamRoles []string
// The AWS Key Management Service (KMS) key ID of the encryption key that you want
// to use to encrypt data in the cluster that you restore from a shared snapshot.
KmsKeyId *string
// The name of the maintenance track for the restored cluster. When you take a
// snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The
// snapshot might be on a different track than the cluster that was the source for
// the snapshot. For example, suppose that you take a snapshot of a cluster that is
// on the current track and then change the cluster to be on the trailing track. In
// this case, the snapshot and the source cluster are on different tracks.
MaintenanceTrackName *string
// The default number of days to retain a manual snapshot. If the value is -1, the
// snapshot is retained indefinitely. This setting doesn't change the retention
// period of existing snapshots. The value must be either -1 or an integer between
// 1 and 3,653.
ManualSnapshotRetentionPeriod *int32
// The node type that the restored cluster will be provisioned with. Default: The
// node type of the cluster from which the snapshot was taken. You can modify this
// if you are using any DS node type. In that case, you can choose to restore into
// another DS node type of the same size. For example, you can restore ds1.8xlarge
// into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type,
// you must restore into that same instance type and size. In other words, you can
// only restore a dc1.large instance type into another dc1.large instance type or
// dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First
// restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more
// information about node types, see About Clusters and Nodes
// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes)
// in the Amazon Redshift Cluster Management Guide.
NodeType *string
// The number of nodes specified when provisioning the restored cluster.
NumberOfNodes *int32
// The AWS customer account used to create or copy the snapshot. Required if you
// are restoring a snapshot you do not own, optional if you own the snapshot.
OwnerAccount *string
// The port number on which the cluster accepts connections. Default: The same port
// as the original cluster. Constraints: Must be between 1115 and 65535.
Port *int32
// The weekly time range (in UTC) during which automated cluster maintenance can
// occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the
// cluster from which the snapshot was taken. For more information about the time
// blocks for each region, see Maintenance Windows
// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows)
// in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu |
// Fri | Sat | Sun Constraints: Minimum 30-minute window.
PreferredMaintenanceWindow *string
// If true, the cluster can be accessed from a public network.
PubliclyAccessible *bool
// The name of the cluster the source snapshot was created from. This parameter is
// required if your IAM user has a policy containing a snapshot resource element
// that specifies anything other than * for the cluster name.
SnapshotClusterIdentifier *string
// A unique identifier for the snapshot schedule.
SnapshotScheduleIdentifier *string
// A list of Virtual Private Cloud (VPC) security groups to be associated with the
// cluster. Default: The default VPC security group is associated with the cluster.
// VPC security groups only apply to clusters in VPCs.
VpcSecurityGroupIds []string
}
type RestoreFromClusterSnapshotOutput struct {
// Describes a cluster.
Cluster *types.Cluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationRestoreFromClusterSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpRestoreFromClusterSnapshot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpRestoreFromClusterSnapshot{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpRestoreFromClusterSnapshotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreFromClusterSnapshot(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRestoreFromClusterSnapshot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "redshift",
OperationName: "RestoreFromClusterSnapshot",
}
}