aws-sdk-redshiftserverless 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2546 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::RedshiftServerless
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] code
16
+ # @return [String]
17
+ #
18
+ # @!attribute [rw] message
19
+ # @return [String]
20
+ #
21
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/AccessDeniedException AWS API Documentation
22
+ #
23
+ class AccessDeniedException < Struct.new(
24
+ :code,
25
+ :message)
26
+ SENSITIVE = []
27
+ include Aws::Structure
28
+ end
29
+
30
+ # An array of key-value pairs to set for advanced control over Amazon
31
+ # Redshift Serverless.
32
+ #
33
+ # @note When making an API call, you may pass ConfigParameter
34
+ # data as a hash:
35
+ #
36
+ # {
37
+ # parameter_key: "ParameterKey",
38
+ # parameter_value: "ParameterValue",
39
+ # }
40
+ #
41
+ # @!attribute [rw] parameter_key
42
+ # The key of the parameter. The options are `datestyle`,
43
+ # `enable_user_activity_logging`, `query_group`, `search_path`, and
44
+ # `max_query_execution_time`.
45
+ # @return [String]
46
+ #
47
+ # @!attribute [rw] parameter_value
48
+ # The value of the parameter to set.
49
+ # @return [String]
50
+ #
51
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ConfigParameter AWS API Documentation
52
+ #
53
+ class ConfigParameter < Struct.new(
54
+ :parameter_key,
55
+ :parameter_value)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
60
+ # The submitted action has conflicts.
61
+ #
62
+ # @!attribute [rw] message
63
+ # @return [String]
64
+ #
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ConflictException AWS API Documentation
66
+ #
67
+ class ConflictException < Struct.new(
68
+ :message)
69
+ SENSITIVE = []
70
+ include Aws::Structure
71
+ end
72
+
73
+ # @note When making an API call, you may pass ConvertRecoveryPointToSnapshotRequest
74
+ # data as a hash:
75
+ #
76
+ # {
77
+ # recovery_point_id: "String", # required
78
+ # retention_period: 1,
79
+ # snapshot_name: "String", # required
80
+ # }
81
+ #
82
+ # @!attribute [rw] recovery_point_id
83
+ # The unique identifier of the recovery point.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] retention_period
87
+ # How long to retain the snapshot.
88
+ # @return [Integer]
89
+ #
90
+ # @!attribute [rw] snapshot_name
91
+ # The name of the snapshot.
92
+ # @return [String]
93
+ #
94
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ConvertRecoveryPointToSnapshotRequest AWS API Documentation
95
+ #
96
+ class ConvertRecoveryPointToSnapshotRequest < Struct.new(
97
+ :recovery_point_id,
98
+ :retention_period,
99
+ :snapshot_name)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # @!attribute [rw] snapshot
105
+ # The snapshot converted from the recovery point.
106
+ # @return [Types::Snapshot]
107
+ #
108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ConvertRecoveryPointToSnapshotResponse AWS API Documentation
109
+ #
110
+ class ConvertRecoveryPointToSnapshotResponse < Struct.new(
111
+ :snapshot)
112
+ SENSITIVE = []
113
+ include Aws::Structure
114
+ end
115
+
116
+ # @note When making an API call, you may pass CreateEndpointAccessRequest
117
+ # data as a hash:
118
+ #
119
+ # {
120
+ # endpoint_name: "String", # required
121
+ # subnet_ids: ["SubnetId"], # required
122
+ # vpc_security_group_ids: ["VpcSecurityGroupId"],
123
+ # workgroup_name: "String", # required
124
+ # }
125
+ #
126
+ # @!attribute [rw] endpoint_name
127
+ # The name of the VPC endpoint. An endpoint name must contain 1-30
128
+ # characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The
129
+ # first character must be a letter. The name can't contain two
130
+ # consecutive hyphens or end with a hyphen.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] subnet_ids
134
+ # The unique identifers of subnets from which Amazon Redshift
135
+ # Serverless chooses one to deploy a VPC endpoint.
136
+ # @return [Array<String>]
137
+ #
138
+ # @!attribute [rw] vpc_security_group_ids
139
+ # The unique identifiers of the security group that defines the ports,
140
+ # protocols, and sources for inbound traffic that you are authorizing
141
+ # into your endpoint.
142
+ # @return [Array<String>]
143
+ #
144
+ # @!attribute [rw] workgroup_name
145
+ # The name of the workgroup to associate with the VPC endpoint.
146
+ # @return [String]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateEndpointAccessRequest AWS API Documentation
149
+ #
150
+ class CreateEndpointAccessRequest < Struct.new(
151
+ :endpoint_name,
152
+ :subnet_ids,
153
+ :vpc_security_group_ids,
154
+ :workgroup_name)
155
+ SENSITIVE = []
156
+ include Aws::Structure
157
+ end
158
+
159
+ # @!attribute [rw] endpoint
160
+ # The created VPC endpoint.
161
+ # @return [Types::EndpointAccess]
162
+ #
163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateEndpointAccessResponse AWS API Documentation
164
+ #
165
+ class CreateEndpointAccessResponse < Struct.new(
166
+ :endpoint)
167
+ SENSITIVE = []
168
+ include Aws::Structure
169
+ end
170
+
171
+ # @note When making an API call, you may pass CreateNamespaceRequest
172
+ # data as a hash:
173
+ #
174
+ # {
175
+ # admin_user_password: "DbPassword",
176
+ # admin_username: "DbUser",
177
+ # db_name: "String",
178
+ # default_iam_role_arn: "String",
179
+ # iam_roles: ["IamRoleArn"],
180
+ # kms_key_id: "String",
181
+ # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
182
+ # namespace_name: "NamespaceName", # required
183
+ # tags: [
184
+ # {
185
+ # key: "TagKey", # required
186
+ # value: "TagValue", # required
187
+ # },
188
+ # ],
189
+ # }
190
+ #
191
+ # @!attribute [rw] admin_user_password
192
+ # The password of the administrator for the first database created in
193
+ # the namespace.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] admin_username
197
+ # The username of the administrator for the first database created in
198
+ # the namespace.
199
+ # @return [String]
200
+ #
201
+ # @!attribute [rw] db_name
202
+ # The name of the first database created in the namespace.
203
+ # @return [String]
204
+ #
205
+ # @!attribute [rw] default_iam_role_arn
206
+ # The Amazon Resource Name (ARN) of the IAM role to set as a default
207
+ # in the namespace.
208
+ # @return [String]
209
+ #
210
+ # @!attribute [rw] iam_roles
211
+ # A list of IAM roles to associate with the namespace.
212
+ # @return [Array<String>]
213
+ #
214
+ # @!attribute [rw] kms_key_id
215
+ # The ID of the Amazon Web Services Key Management Service key used to
216
+ # encrypt your data.
217
+ # @return [String]
218
+ #
219
+ # @!attribute [rw] log_exports
220
+ # The types of logs the namespace can export. Available export types
221
+ # are `userlog`, `connectionlog`, and `useractivitylog`.
222
+ # @return [Array<String>]
223
+ #
224
+ # @!attribute [rw] namespace_name
225
+ # The name of the namespace.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] tags
229
+ # A list of tag instances.
230
+ # @return [Array<Types::Tag>]
231
+ #
232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateNamespaceRequest AWS API Documentation
233
+ #
234
+ class CreateNamespaceRequest < Struct.new(
235
+ :admin_user_password,
236
+ :admin_username,
237
+ :db_name,
238
+ :default_iam_role_arn,
239
+ :iam_roles,
240
+ :kms_key_id,
241
+ :log_exports,
242
+ :namespace_name,
243
+ :tags)
244
+ SENSITIVE = [:admin_user_password, :admin_username]
245
+ include Aws::Structure
246
+ end
247
+
248
+ # @!attribute [rw] namespace
249
+ # The created namespace object.
250
+ # @return [Types::Namespace]
251
+ #
252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateNamespaceResponse AWS API Documentation
253
+ #
254
+ class CreateNamespaceResponse < Struct.new(
255
+ :namespace)
256
+ SENSITIVE = []
257
+ include Aws::Structure
258
+ end
259
+
260
+ # @note When making an API call, you may pass CreateSnapshotRequest
261
+ # data as a hash:
262
+ #
263
+ # {
264
+ # namespace_name: "String", # required
265
+ # retention_period: 1,
266
+ # snapshot_name: "String", # required
267
+ # }
268
+ #
269
+ # @!attribute [rw] namespace_name
270
+ # The namespace to create a snapshot for.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] retention_period
274
+ # How long to retain the created snapshot.
275
+ # @return [Integer]
276
+ #
277
+ # @!attribute [rw] snapshot_name
278
+ # The name of the snapshot.
279
+ # @return [String]
280
+ #
281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateSnapshotRequest AWS API Documentation
282
+ #
283
+ class CreateSnapshotRequest < Struct.new(
284
+ :namespace_name,
285
+ :retention_period,
286
+ :snapshot_name)
287
+ SENSITIVE = []
288
+ include Aws::Structure
289
+ end
290
+
291
+ # @!attribute [rw] snapshot
292
+ # The created snapshot object.
293
+ # @return [Types::Snapshot]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateSnapshotResponse AWS API Documentation
296
+ #
297
+ class CreateSnapshotResponse < Struct.new(
298
+ :snapshot)
299
+ SENSITIVE = []
300
+ include Aws::Structure
301
+ end
302
+
303
+ # @note When making an API call, you may pass CreateUsageLimitRequest
304
+ # data as a hash:
305
+ #
306
+ # {
307
+ # amount: 1, # required
308
+ # breach_action: "log", # accepts log, emit-metric, deactivate
309
+ # period: "daily", # accepts daily, weekly, monthly
310
+ # resource_arn: "String", # required
311
+ # usage_type: "serverless-compute", # required, accepts serverless-compute, cross-region-datasharing
312
+ # }
313
+ #
314
+ # @!attribute [rw] amount
315
+ # The limit amount. If time-based, this amount is in Redshift
316
+ # Processing Units (RPU) consumed per hour. If data-based, this amount
317
+ # is in terabytes (TB) of data transferred between Regions in
318
+ # cross-account sharing. The value must be a positive number.
319
+ # @return [Integer]
320
+ #
321
+ # @!attribute [rw] breach_action
322
+ # The action that Amazon Redshift Serverless takes when the limit is
323
+ # reached. The default is log.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] period
327
+ # The time period that the amount applies to. A weekly period begins
328
+ # on Sunday. The default is monthly.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] resource_arn
332
+ # The Amazon Resource Name (ARN) of the Amazon Redshift Serverless
333
+ # resource to create the usage limit for.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] usage_type
337
+ # The type of Amazon Redshift Serverless usage to create a usage limit
338
+ # for.
339
+ # @return [String]
340
+ #
341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateUsageLimitRequest AWS API Documentation
342
+ #
343
+ class CreateUsageLimitRequest < Struct.new(
344
+ :amount,
345
+ :breach_action,
346
+ :period,
347
+ :resource_arn,
348
+ :usage_type)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @!attribute [rw] usage_limit
354
+ # The returned usage limit object.
355
+ # @return [Types::UsageLimit]
356
+ #
357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateUsageLimitResponse AWS API Documentation
358
+ #
359
+ class CreateUsageLimitResponse < Struct.new(
360
+ :usage_limit)
361
+ SENSITIVE = []
362
+ include Aws::Structure
363
+ end
364
+
365
+ # @note When making an API call, you may pass CreateWorkgroupRequest
366
+ # data as a hash:
367
+ #
368
+ # {
369
+ # base_capacity: 1,
370
+ # config_parameters: [
371
+ # {
372
+ # parameter_key: "ParameterKey",
373
+ # parameter_value: "ParameterValue",
374
+ # },
375
+ # ],
376
+ # enhanced_vpc_routing: false,
377
+ # namespace_name: "NamespaceName", # required
378
+ # publicly_accessible: false,
379
+ # security_group_ids: ["SecurityGroupId"],
380
+ # subnet_ids: ["SubnetId"],
381
+ # tags: [
382
+ # {
383
+ # key: "TagKey", # required
384
+ # value: "TagValue", # required
385
+ # },
386
+ # ],
387
+ # workgroup_name: "WorkgroupName", # required
388
+ # }
389
+ #
390
+ # @!attribute [rw] base_capacity
391
+ # The base data warehouse capacity of the workgroup in Redshift
392
+ # Processing Units (RPUs).
393
+ # @return [Integer]
394
+ #
395
+ # @!attribute [rw] config_parameters
396
+ # An array of parameters to set for more control over a serverless
397
+ # database. The options are `datestyle`,
398
+ # `enable_user_activity_logging`, `query_group`, `search_path`, and
399
+ # `max_query_execution_time`.
400
+ # @return [Array<Types::ConfigParameter>]
401
+ #
402
+ # @!attribute [rw] enhanced_vpc_routing
403
+ # The value that specifies whether to turn on enhanced virtual private
404
+ # cloud (VPC) routing, which forces Amazon Redshift Serverless to
405
+ # route traffic through your VPC instead of over the internet.
406
+ # @return [Boolean]
407
+ #
408
+ # @!attribute [rw] namespace_name
409
+ # The name of the namespace to associate with the workgroup.
410
+ # @return [String]
411
+ #
412
+ # @!attribute [rw] publicly_accessible
413
+ # A value that specifies whether the workgroup can be accessed from a
414
+ # public network.
415
+ # @return [Boolean]
416
+ #
417
+ # @!attribute [rw] security_group_ids
418
+ # An array of security group IDs to associate with the workgroup.
419
+ # @return [Array<String>]
420
+ #
421
+ # @!attribute [rw] subnet_ids
422
+ # An array of VPC subnet IDs to associate with the workgroup.
423
+ # @return [Array<String>]
424
+ #
425
+ # @!attribute [rw] tags
426
+ # A array of tag instances.
427
+ # @return [Array<Types::Tag>]
428
+ #
429
+ # @!attribute [rw] workgroup_name
430
+ # The name of the created workgroup.
431
+ # @return [String]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateWorkgroupRequest AWS API Documentation
434
+ #
435
+ class CreateWorkgroupRequest < Struct.new(
436
+ :base_capacity,
437
+ :config_parameters,
438
+ :enhanced_vpc_routing,
439
+ :namespace_name,
440
+ :publicly_accessible,
441
+ :security_group_ids,
442
+ :subnet_ids,
443
+ :tags,
444
+ :workgroup_name)
445
+ SENSITIVE = []
446
+ include Aws::Structure
447
+ end
448
+
449
+ # @!attribute [rw] workgroup
450
+ # The created workgroup object.
451
+ # @return [Types::Workgroup]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/CreateWorkgroupResponse AWS API Documentation
454
+ #
455
+ class CreateWorkgroupResponse < Struct.new(
456
+ :workgroup)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @note When making an API call, you may pass DeleteEndpointAccessRequest
462
+ # data as a hash:
463
+ #
464
+ # {
465
+ # endpoint_name: "String", # required
466
+ # }
467
+ #
468
+ # @!attribute [rw] endpoint_name
469
+ # The name of the VPC endpoint to delete.
470
+ # @return [String]
471
+ #
472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteEndpointAccessRequest AWS API Documentation
473
+ #
474
+ class DeleteEndpointAccessRequest < Struct.new(
475
+ :endpoint_name)
476
+ SENSITIVE = []
477
+ include Aws::Structure
478
+ end
479
+
480
+ # @!attribute [rw] endpoint
481
+ # The deleted VPC endpoint.
482
+ # @return [Types::EndpointAccess]
483
+ #
484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteEndpointAccessResponse AWS API Documentation
485
+ #
486
+ class DeleteEndpointAccessResponse < Struct.new(
487
+ :endpoint)
488
+ SENSITIVE = []
489
+ include Aws::Structure
490
+ end
491
+
492
+ # @note When making an API call, you may pass DeleteNamespaceRequest
493
+ # data as a hash:
494
+ #
495
+ # {
496
+ # final_snapshot_name: "String",
497
+ # final_snapshot_retention_period: 1,
498
+ # namespace_name: "NamespaceName", # required
499
+ # }
500
+ #
501
+ # @!attribute [rw] final_snapshot_name
502
+ # The name of the snapshot to be created before the namespace is
503
+ # deleted.
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] final_snapshot_retention_period
507
+ # How long to retain the final snapshot.
508
+ # @return [Integer]
509
+ #
510
+ # @!attribute [rw] namespace_name
511
+ # The name of the namespace to delete.
512
+ # @return [String]
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteNamespaceRequest AWS API Documentation
515
+ #
516
+ class DeleteNamespaceRequest < Struct.new(
517
+ :final_snapshot_name,
518
+ :final_snapshot_retention_period,
519
+ :namespace_name)
520
+ SENSITIVE = []
521
+ include Aws::Structure
522
+ end
523
+
524
+ # @!attribute [rw] namespace
525
+ # The deleted namespace object.
526
+ # @return [Types::Namespace]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteNamespaceResponse AWS API Documentation
529
+ #
530
+ class DeleteNamespaceResponse < Struct.new(
531
+ :namespace)
532
+ SENSITIVE = []
533
+ include Aws::Structure
534
+ end
535
+
536
+ # @note When making an API call, you may pass DeleteResourcePolicyRequest
537
+ # data as a hash:
538
+ #
539
+ # {
540
+ # resource_arn: "String", # required
541
+ # }
542
+ #
543
+ # @!attribute [rw] resource_arn
544
+ # The Amazon Resource Name (ARN) of the policy to delete.
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteResourcePolicyRequest AWS API Documentation
548
+ #
549
+ class DeleteResourcePolicyRequest < Struct.new(
550
+ :resource_arn)
551
+ SENSITIVE = []
552
+ include Aws::Structure
553
+ end
554
+
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteResourcePolicyResponse AWS API Documentation
556
+ #
557
+ class DeleteResourcePolicyResponse < Aws::EmptyStructure; end
558
+
559
+ # @note When making an API call, you may pass DeleteSnapshotRequest
560
+ # data as a hash:
561
+ #
562
+ # {
563
+ # snapshot_name: "String", # required
564
+ # }
565
+ #
566
+ # @!attribute [rw] snapshot_name
567
+ # The name of the snapshot to be deleted.
568
+ # @return [String]
569
+ #
570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteSnapshotRequest AWS API Documentation
571
+ #
572
+ class DeleteSnapshotRequest < Struct.new(
573
+ :snapshot_name)
574
+ SENSITIVE = []
575
+ include Aws::Structure
576
+ end
577
+
578
+ # @!attribute [rw] snapshot
579
+ # The deleted snapshot object.
580
+ # @return [Types::Snapshot]
581
+ #
582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteSnapshotResponse AWS API Documentation
583
+ #
584
+ class DeleteSnapshotResponse < Struct.new(
585
+ :snapshot)
586
+ SENSITIVE = []
587
+ include Aws::Structure
588
+ end
589
+
590
+ # @note When making an API call, you may pass DeleteUsageLimitRequest
591
+ # data as a hash:
592
+ #
593
+ # {
594
+ # usage_limit_id: "String", # required
595
+ # }
596
+ #
597
+ # @!attribute [rw] usage_limit_id
598
+ # The unique identifier of the usage limit to delete.
599
+ # @return [String]
600
+ #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteUsageLimitRequest AWS API Documentation
602
+ #
603
+ class DeleteUsageLimitRequest < Struct.new(
604
+ :usage_limit_id)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] usage_limit
610
+ # The deleted usage limit object.
611
+ # @return [Types::UsageLimit]
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteUsageLimitResponse AWS API Documentation
614
+ #
615
+ class DeleteUsageLimitResponse < Struct.new(
616
+ :usage_limit)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @note When making an API call, you may pass DeleteWorkgroupRequest
622
+ # data as a hash:
623
+ #
624
+ # {
625
+ # workgroup_name: "WorkgroupName", # required
626
+ # }
627
+ #
628
+ # @!attribute [rw] workgroup_name
629
+ # The name of the workgroup to be deleted.
630
+ # @return [String]
631
+ #
632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteWorkgroupRequest AWS API Documentation
633
+ #
634
+ class DeleteWorkgroupRequest < Struct.new(
635
+ :workgroup_name)
636
+ SENSITIVE = []
637
+ include Aws::Structure
638
+ end
639
+
640
+ # @!attribute [rw] workgroup
641
+ # The deleted workgroup object.
642
+ # @return [Types::Workgroup]
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/DeleteWorkgroupResponse AWS API Documentation
645
+ #
646
+ class DeleteWorkgroupResponse < Struct.new(
647
+ :workgroup)
648
+ SENSITIVE = []
649
+ include Aws::Structure
650
+ end
651
+
652
+ # The VPC endpoint object.
653
+ #
654
+ # @!attribute [rw] address
655
+ # The DNS address of the VPC endpoint.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] port
659
+ # The port that Amazon Redshift Serverless listens on.
660
+ # @return [Integer]
661
+ #
662
+ # @!attribute [rw] vpc_endpoints
663
+ # An array of `VpcEndpoint` objects.
664
+ # @return [Array<Types::VpcEndpoint>]
665
+ #
666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/Endpoint AWS API Documentation
667
+ #
668
+ class Endpoint < Struct.new(
669
+ :address,
670
+ :port,
671
+ :vpc_endpoints)
672
+ SENSITIVE = []
673
+ include Aws::Structure
674
+ end
675
+
676
+ # Information about an Amazon Redshift Serverless VPC endpoint.
677
+ #
678
+ # @!attribute [rw] address
679
+ # The DNS address of the endpoint.
680
+ # @return [String]
681
+ #
682
+ # @!attribute [rw] endpoint_arn
683
+ # The Amazon Resource Name (ARN) of the VPC endpoint.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] endpoint_create_time
687
+ # The time that the endpoint was created.
688
+ # @return [Time]
689
+ #
690
+ # @!attribute [rw] endpoint_name
691
+ # The name of the VPC endpoint.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] endpoint_status
695
+ # The status of the VPC endpoint.
696
+ # @return [String]
697
+ #
698
+ # @!attribute [rw] port
699
+ # The port number on which Amazon Redshift Serverless accepts incoming
700
+ # connections.
701
+ # @return [Integer]
702
+ #
703
+ # @!attribute [rw] subnet_ids
704
+ # The unique identifier of subnets where Amazon Redshift Serverless
705
+ # choose to deploy the VPC endpoint.
706
+ # @return [Array<String>]
707
+ #
708
+ # @!attribute [rw] vpc_endpoint
709
+ # The connection endpoint for connecting to Amazon Redshift
710
+ # Serverless.
711
+ # @return [Types::VpcEndpoint]
712
+ #
713
+ # @!attribute [rw] vpc_security_groups
714
+ # The security groups associated with the endpoint.
715
+ # @return [Array<Types::VpcSecurityGroupMembership>]
716
+ #
717
+ # @!attribute [rw] workgroup_name
718
+ # The name of the workgroup associated with the endpoint.
719
+ # @return [String]
720
+ #
721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/EndpointAccess AWS API Documentation
722
+ #
723
+ class EndpointAccess < Struct.new(
724
+ :address,
725
+ :endpoint_arn,
726
+ :endpoint_create_time,
727
+ :endpoint_name,
728
+ :endpoint_status,
729
+ :port,
730
+ :subnet_ids,
731
+ :vpc_endpoint,
732
+ :vpc_security_groups,
733
+ :workgroup_name)
734
+ SENSITIVE = []
735
+ include Aws::Structure
736
+ end
737
+
738
+ # @note When making an API call, you may pass GetCredentialsRequest
739
+ # data as a hash:
740
+ #
741
+ # {
742
+ # db_name: "DbName",
743
+ # duration_seconds: 1,
744
+ # workgroup_name: "WorkgroupName", # required
745
+ # }
746
+ #
747
+ # @!attribute [rw] db_name
748
+ # The name of the database to get temporary authorization to log on
749
+ # to.
750
+ #
751
+ # Constraints:
752
+ #
753
+ # * Must be 1 to 64 alphanumeric characters or hyphens.
754
+ #
755
+ # * Must contain only lowercase letters, numbers, underscore, plus
756
+ # sign, period (dot), at symbol (@), or hyphen.
757
+ #
758
+ # * The first character must be a letter.
759
+ #
760
+ # * Must not contain a colon ( : ) or slash ( / ).
761
+ #
762
+ # * Cannot be a reserved word. A list of reserved words can be found
763
+ # in [Reserved Words ][1] in the Amazon Redshift Database Developer
764
+ # Guide
765
+ #
766
+ #
767
+ #
768
+ # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
769
+ # @return [String]
770
+ #
771
+ # @!attribute [rw] duration_seconds
772
+ # The number of seconds until the returned temporary password expires.
773
+ # The minimum is 900 seconds, and the maximum is 3600 seconds.
774
+ # @return [Integer]
775
+ #
776
+ # @!attribute [rw] workgroup_name
777
+ # The name of the workgroup associated with the database.
778
+ # @return [String]
779
+ #
780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetCredentialsRequest AWS API Documentation
781
+ #
782
+ class GetCredentialsRequest < Struct.new(
783
+ :db_name,
784
+ :duration_seconds,
785
+ :workgroup_name)
786
+ SENSITIVE = []
787
+ include Aws::Structure
788
+ end
789
+
790
+ # @!attribute [rw] db_password
791
+ # A temporary password that authorizes the user name returned by
792
+ # `DbUser` to log on to the database `DbName`.
793
+ # @return [String]
794
+ #
795
+ # @!attribute [rw] db_user
796
+ # A database user name that is authorized to log on to the database
797
+ # `DbName` using the password `DbPassword`. If the specified `DbUser`
798
+ # exists in the database, the new user name has the same database
799
+ # privileges as the the user named in `DbUser`. By default, the user
800
+ # is added to PUBLIC.
801
+ # @return [String]
802
+ #
803
+ # @!attribute [rw] expiration
804
+ # The date and time the password in `DbPassword` expires.
805
+ # @return [Time]
806
+ #
807
+ # @!attribute [rw] next_refresh_time
808
+ # The date and time of when the `DbUser` and `DbPassword`
809
+ # authorization refreshes.
810
+ # @return [Time]
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetCredentialsResponse AWS API Documentation
813
+ #
814
+ class GetCredentialsResponse < Struct.new(
815
+ :db_password,
816
+ :db_user,
817
+ :expiration,
818
+ :next_refresh_time)
819
+ SENSITIVE = [:db_password, :db_user]
820
+ include Aws::Structure
821
+ end
822
+
823
+ # @note When making an API call, you may pass GetEndpointAccessRequest
824
+ # data as a hash:
825
+ #
826
+ # {
827
+ # endpoint_name: "String", # required
828
+ # }
829
+ #
830
+ # @!attribute [rw] endpoint_name
831
+ # The name of the VPC endpoint to return information for.
832
+ # @return [String]
833
+ #
834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetEndpointAccessRequest AWS API Documentation
835
+ #
836
+ class GetEndpointAccessRequest < Struct.new(
837
+ :endpoint_name)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # @!attribute [rw] endpoint
843
+ # The returned VPC endpoint.
844
+ # @return [Types::EndpointAccess]
845
+ #
846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetEndpointAccessResponse AWS API Documentation
847
+ #
848
+ class GetEndpointAccessResponse < Struct.new(
849
+ :endpoint)
850
+ SENSITIVE = []
851
+ include Aws::Structure
852
+ end
853
+
854
+ # @note When making an API call, you may pass GetNamespaceRequest
855
+ # data as a hash:
856
+ #
857
+ # {
858
+ # namespace_name: "NamespaceName", # required
859
+ # }
860
+ #
861
+ # @!attribute [rw] namespace_name
862
+ # The name of the namespace to retrieve information for.
863
+ # @return [String]
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetNamespaceRequest AWS API Documentation
866
+ #
867
+ class GetNamespaceRequest < Struct.new(
868
+ :namespace_name)
869
+ SENSITIVE = []
870
+ include Aws::Structure
871
+ end
872
+
873
+ # @!attribute [rw] namespace
874
+ # The returned namespace object.
875
+ # @return [Types::Namespace]
876
+ #
877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetNamespaceResponse AWS API Documentation
878
+ #
879
+ class GetNamespaceResponse < Struct.new(
880
+ :namespace)
881
+ SENSITIVE = []
882
+ include Aws::Structure
883
+ end
884
+
885
+ # @note When making an API call, you may pass GetRecoveryPointRequest
886
+ # data as a hash:
887
+ #
888
+ # {
889
+ # recovery_point_id: "String", # required
890
+ # }
891
+ #
892
+ # @!attribute [rw] recovery_point_id
893
+ # The unique identifier of the recovery point to return information
894
+ # for.
895
+ # @return [String]
896
+ #
897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetRecoveryPointRequest AWS API Documentation
898
+ #
899
+ class GetRecoveryPointRequest < Struct.new(
900
+ :recovery_point_id)
901
+ SENSITIVE = []
902
+ include Aws::Structure
903
+ end
904
+
905
+ # @!attribute [rw] recovery_point
906
+ # The returned recovery point object.
907
+ # @return [Types::RecoveryPoint]
908
+ #
909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetRecoveryPointResponse AWS API Documentation
910
+ #
911
+ class GetRecoveryPointResponse < Struct.new(
912
+ :recovery_point)
913
+ SENSITIVE = []
914
+ include Aws::Structure
915
+ end
916
+
917
+ # @note When making an API call, you may pass GetResourcePolicyRequest
918
+ # data as a hash:
919
+ #
920
+ # {
921
+ # resource_arn: "String", # required
922
+ # }
923
+ #
924
+ # @!attribute [rw] resource_arn
925
+ # The Amazon Resource Name (ARN) of the resource to return.
926
+ # @return [String]
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetResourcePolicyRequest AWS API Documentation
929
+ #
930
+ class GetResourcePolicyRequest < Struct.new(
931
+ :resource_arn)
932
+ SENSITIVE = []
933
+ include Aws::Structure
934
+ end
935
+
936
+ # @!attribute [rw] resource_policy
937
+ # The returned resource policy.
938
+ # @return [Types::ResourcePolicy]
939
+ #
940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetResourcePolicyResponse AWS API Documentation
941
+ #
942
+ class GetResourcePolicyResponse < Struct.new(
943
+ :resource_policy)
944
+ SENSITIVE = []
945
+ include Aws::Structure
946
+ end
947
+
948
+ # @note When making an API call, you may pass GetSnapshotRequest
949
+ # data as a hash:
950
+ #
951
+ # {
952
+ # owner_account: "String",
953
+ # snapshot_arn: "String",
954
+ # snapshot_name: "String",
955
+ # }
956
+ #
957
+ # @!attribute [rw] owner_account
958
+ # The owner Amazon Web Services account of a snapshot shared with
959
+ # another user.
960
+ # @return [String]
961
+ #
962
+ # @!attribute [rw] snapshot_arn
963
+ # The Amazon Resource Name (ARN) of the snapshot to return.
964
+ # @return [String]
965
+ #
966
+ # @!attribute [rw] snapshot_name
967
+ # The name of the snapshot to return.
968
+ # @return [String]
969
+ #
970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetSnapshotRequest AWS API Documentation
971
+ #
972
+ class GetSnapshotRequest < Struct.new(
973
+ :owner_account,
974
+ :snapshot_arn,
975
+ :snapshot_name)
976
+ SENSITIVE = []
977
+ include Aws::Structure
978
+ end
979
+
980
+ # @!attribute [rw] snapshot
981
+ # The returned snapshot object.
982
+ # @return [Types::Snapshot]
983
+ #
984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetSnapshotResponse AWS API Documentation
985
+ #
986
+ class GetSnapshotResponse < Struct.new(
987
+ :snapshot)
988
+ SENSITIVE = []
989
+ include Aws::Structure
990
+ end
991
+
992
+ # @note When making an API call, you may pass GetUsageLimitRequest
993
+ # data as a hash:
994
+ #
995
+ # {
996
+ # usage_limit_id: "String", # required
997
+ # }
998
+ #
999
+ # @!attribute [rw] usage_limit_id
1000
+ # The unique identifier of the usage limit to return information for.
1001
+ # @return [String]
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetUsageLimitRequest AWS API Documentation
1004
+ #
1005
+ class GetUsageLimitRequest < Struct.new(
1006
+ :usage_limit_id)
1007
+ SENSITIVE = []
1008
+ include Aws::Structure
1009
+ end
1010
+
1011
+ # @!attribute [rw] usage_limit
1012
+ # The returned usage limit object.
1013
+ # @return [Types::UsageLimit]
1014
+ #
1015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetUsageLimitResponse AWS API Documentation
1016
+ #
1017
+ class GetUsageLimitResponse < Struct.new(
1018
+ :usage_limit)
1019
+ SENSITIVE = []
1020
+ include Aws::Structure
1021
+ end
1022
+
1023
+ # @note When making an API call, you may pass GetWorkgroupRequest
1024
+ # data as a hash:
1025
+ #
1026
+ # {
1027
+ # workgroup_name: "WorkgroupName", # required
1028
+ # }
1029
+ #
1030
+ # @!attribute [rw] workgroup_name
1031
+ # The name of the workgroup to return information for.
1032
+ # @return [String]
1033
+ #
1034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetWorkgroupRequest AWS API Documentation
1035
+ #
1036
+ class GetWorkgroupRequest < Struct.new(
1037
+ :workgroup_name)
1038
+ SENSITIVE = []
1039
+ include Aws::Structure
1040
+ end
1041
+
1042
+ # @!attribute [rw] workgroup
1043
+ # The returned workgroup object.
1044
+ # @return [Types::Workgroup]
1045
+ #
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/GetWorkgroupResponse AWS API Documentation
1047
+ #
1048
+ class GetWorkgroupResponse < Struct.new(
1049
+ :workgroup)
1050
+ SENSITIVE = []
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # There is an insufficient capacity to perform the action.
1055
+ #
1056
+ # @!attribute [rw] message
1057
+ # @return [String]
1058
+ #
1059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/InsufficientCapacityException AWS API Documentation
1060
+ #
1061
+ class InsufficientCapacityException < Struct.new(
1062
+ :message)
1063
+ SENSITIVE = []
1064
+ include Aws::Structure
1065
+ end
1066
+
1067
+ # The request processing has failed because of an unknown error,
1068
+ # exception or failure.
1069
+ #
1070
+ # @!attribute [rw] message
1071
+ # @return [String]
1072
+ #
1073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/InternalServerException AWS API Documentation
1074
+ #
1075
+ class InternalServerException < Struct.new(
1076
+ :message)
1077
+ SENSITIVE = []
1078
+ include Aws::Structure
1079
+ end
1080
+
1081
+ # The provided pagination token is invalid.
1082
+ #
1083
+ # @!attribute [rw] message
1084
+ # @return [String]
1085
+ #
1086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/InvalidPaginationException AWS API Documentation
1087
+ #
1088
+ class InvalidPaginationException < Struct.new(
1089
+ :message)
1090
+ SENSITIVE = []
1091
+ include Aws::Structure
1092
+ end
1093
+
1094
+ # @note When making an API call, you may pass ListEndpointAccessRequest
1095
+ # data as a hash:
1096
+ #
1097
+ # {
1098
+ # max_results: 1,
1099
+ # next_token: "String",
1100
+ # vpc_id: "String",
1101
+ # workgroup_name: "String",
1102
+ # }
1103
+ #
1104
+ # @!attribute [rw] max_results
1105
+ # An optional parameter that specifies the maximum number of results
1106
+ # to return. You can use `nextToken` to get the next page of results.
1107
+ # @return [Integer]
1108
+ #
1109
+ # @!attribute [rw] next_token
1110
+ # If your initial `ListEndpointAccess` operation returns a
1111
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1112
+ # `ListEndpointAccess` operations, which returns results in the next
1113
+ # page.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] vpc_id
1117
+ # The unique identifier of the virtual private cloud with access to
1118
+ # Amazon Redshift Serverless.
1119
+ # @return [String]
1120
+ #
1121
+ # @!attribute [rw] workgroup_name
1122
+ # The name of the workgroup associated with the VPC endpoint to
1123
+ # return.
1124
+ # @return [String]
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListEndpointAccessRequest AWS API Documentation
1127
+ #
1128
+ class ListEndpointAccessRequest < Struct.new(
1129
+ :max_results,
1130
+ :next_token,
1131
+ :vpc_id,
1132
+ :workgroup_name)
1133
+ SENSITIVE = []
1134
+ include Aws::Structure
1135
+ end
1136
+
1137
+ # @!attribute [rw] endpoints
1138
+ # The returned VPC endpoints.
1139
+ # @return [Array<Types::EndpointAccess>]
1140
+ #
1141
+ # @!attribute [rw] next_token
1142
+ # When `nextToken` is returned, there are more results available. The
1143
+ # value of `nextToken` is a unique pagination token for each page.
1144
+ # Make the call again using the returned token to retrieve the next
1145
+ # page.
1146
+ # @return [String]
1147
+ #
1148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListEndpointAccessResponse AWS API Documentation
1149
+ #
1150
+ class ListEndpointAccessResponse < Struct.new(
1151
+ :endpoints,
1152
+ :next_token)
1153
+ SENSITIVE = []
1154
+ include Aws::Structure
1155
+ end
1156
+
1157
+ # @note When making an API call, you may pass ListNamespacesRequest
1158
+ # data as a hash:
1159
+ #
1160
+ # {
1161
+ # max_results: 1,
1162
+ # next_token: "String",
1163
+ # }
1164
+ #
1165
+ # @!attribute [rw] max_results
1166
+ # An optional parameter that specifies the maximum number of results
1167
+ # to return. You can use `nextToken` to get the next page of results.
1168
+ # @return [Integer]
1169
+ #
1170
+ # @!attribute [rw] next_token
1171
+ # If your initial `ListNamespaces` operation returns a `nextToken`,
1172
+ # you can include the returned `nextToken` in subsequent
1173
+ # `ListNamespaces` operations, which returns results in the next page.
1174
+ # @return [String]
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListNamespacesRequest AWS API Documentation
1177
+ #
1178
+ class ListNamespacesRequest < Struct.new(
1179
+ :max_results,
1180
+ :next_token)
1181
+ SENSITIVE = []
1182
+ include Aws::Structure
1183
+ end
1184
+
1185
+ # @!attribute [rw] namespaces
1186
+ # The list of returned namespaces.
1187
+ # @return [Array<Types::Namespace>]
1188
+ #
1189
+ # @!attribute [rw] next_token
1190
+ # When `nextToken` is returned, there are more results available. The
1191
+ # value of `nextToken` is a unique pagination token for each page.
1192
+ # Make the call again using the returned token to retrieve the next
1193
+ # page.
1194
+ # @return [String]
1195
+ #
1196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListNamespacesResponse AWS API Documentation
1197
+ #
1198
+ class ListNamespacesResponse < Struct.new(
1199
+ :namespaces,
1200
+ :next_token)
1201
+ SENSITIVE = []
1202
+ include Aws::Structure
1203
+ end
1204
+
1205
+ # @note When making an API call, you may pass ListRecoveryPointsRequest
1206
+ # data as a hash:
1207
+ #
1208
+ # {
1209
+ # end_time: Time.now,
1210
+ # max_results: 1,
1211
+ # namespace_name: "NamespaceName",
1212
+ # next_token: "String",
1213
+ # start_time: Time.now,
1214
+ # }
1215
+ #
1216
+ # @!attribute [rw] end_time
1217
+ # The time when creation of the recovery point finished.
1218
+ # @return [Time]
1219
+ #
1220
+ # @!attribute [rw] max_results
1221
+ # An optional parameter that specifies the maximum number of results
1222
+ # to return. You can use `nextToken` to get the next page of results.
1223
+ # @return [Integer]
1224
+ #
1225
+ # @!attribute [rw] namespace_name
1226
+ # The name of the namespace to list recovery points for.
1227
+ # @return [String]
1228
+ #
1229
+ # @!attribute [rw] next_token
1230
+ # If your initial `ListRecoveryPoints` operation returns a
1231
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1232
+ # `ListRecoveryPoints` operations, which returns results in the next
1233
+ # page.
1234
+ # @return [String]
1235
+ #
1236
+ # @!attribute [rw] start_time
1237
+ # The time when the recovery point's creation was initiated.
1238
+ # @return [Time]
1239
+ #
1240
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListRecoveryPointsRequest AWS API Documentation
1241
+ #
1242
+ class ListRecoveryPointsRequest < Struct.new(
1243
+ :end_time,
1244
+ :max_results,
1245
+ :namespace_name,
1246
+ :next_token,
1247
+ :start_time)
1248
+ SENSITIVE = []
1249
+ include Aws::Structure
1250
+ end
1251
+
1252
+ # @!attribute [rw] next_token
1253
+ # If `nextToken` is returned, there are more results available. The
1254
+ # value of `nextToken` is a unique pagination token for each page.
1255
+ # Make the call again using the returned token to retrieve the next
1256
+ # page.
1257
+ # @return [String]
1258
+ #
1259
+ # @!attribute [rw] recovery_points
1260
+ # The returned recovery point objects.
1261
+ # @return [Array<Types::RecoveryPoint>]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListRecoveryPointsResponse AWS API Documentation
1264
+ #
1265
+ class ListRecoveryPointsResponse < Struct.new(
1266
+ :next_token,
1267
+ :recovery_points)
1268
+ SENSITIVE = []
1269
+ include Aws::Structure
1270
+ end
1271
+
1272
+ # @note When making an API call, you may pass ListSnapshotsRequest
1273
+ # data as a hash:
1274
+ #
1275
+ # {
1276
+ # end_time: Time.now,
1277
+ # max_results: 1,
1278
+ # namespace_arn: "String",
1279
+ # namespace_name: "String",
1280
+ # next_token: "String",
1281
+ # owner_account: "String",
1282
+ # start_time: Time.now,
1283
+ # }
1284
+ #
1285
+ # @!attribute [rw] end_time
1286
+ # The timestamp showing when the snapshot creation finished.
1287
+ # @return [Time]
1288
+ #
1289
+ # @!attribute [rw] max_results
1290
+ # An optional parameter that specifies the maximum number of results
1291
+ # to return. You can use `nextToken` to get the next page of results.
1292
+ # @return [Integer]
1293
+ #
1294
+ # @!attribute [rw] namespace_arn
1295
+ # The Amazon Resource Name (ARN) of the namespace from which to list
1296
+ # all snapshots.
1297
+ # @return [String]
1298
+ #
1299
+ # @!attribute [rw] namespace_name
1300
+ # The namespace from which to list all snapshots.
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] next_token
1304
+ # If `nextToken` is returned, there are more results available. The
1305
+ # value of `nextToken` is a unique pagination token for each page.
1306
+ # Make the call again using the returned token to retrieve the next
1307
+ # page.
1308
+ # @return [String]
1309
+ #
1310
+ # @!attribute [rw] owner_account
1311
+ # The owner Amazon Web Services account of the snapshot.
1312
+ # @return [String]
1313
+ #
1314
+ # @!attribute [rw] start_time
1315
+ # The time when the creation of the snapshot was initiated.
1316
+ # @return [Time]
1317
+ #
1318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListSnapshotsRequest AWS API Documentation
1319
+ #
1320
+ class ListSnapshotsRequest < Struct.new(
1321
+ :end_time,
1322
+ :max_results,
1323
+ :namespace_arn,
1324
+ :namespace_name,
1325
+ :next_token,
1326
+ :owner_account,
1327
+ :start_time)
1328
+ SENSITIVE = []
1329
+ include Aws::Structure
1330
+ end
1331
+
1332
+ # @!attribute [rw] next_token
1333
+ # If `nextToken` is returned, there are more results available. The
1334
+ # value of `nextToken` is a unique pagination token for each page.
1335
+ # Make the call again using the returned token to retrieve the next
1336
+ # page.
1337
+ # @return [String]
1338
+ #
1339
+ # @!attribute [rw] snapshots
1340
+ # All of the returned snapshot objects.
1341
+ # @return [Array<Types::Snapshot>]
1342
+ #
1343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListSnapshotsResponse AWS API Documentation
1344
+ #
1345
+ class ListSnapshotsResponse < Struct.new(
1346
+ :next_token,
1347
+ :snapshots)
1348
+ SENSITIVE = []
1349
+ include Aws::Structure
1350
+ end
1351
+
1352
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1353
+ # data as a hash:
1354
+ #
1355
+ # {
1356
+ # resource_arn: "AmazonResourceName", # required
1357
+ # }
1358
+ #
1359
+ # @!attribute [rw] resource_arn
1360
+ # The Amazon Resource Name (ARN) of the resource to list tags for.
1361
+ # @return [String]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListTagsForResourceRequest AWS API Documentation
1364
+ #
1365
+ class ListTagsForResourceRequest < Struct.new(
1366
+ :resource_arn)
1367
+ SENSITIVE = []
1368
+ include Aws::Structure
1369
+ end
1370
+
1371
+ # @!attribute [rw] tags
1372
+ # A map of the key-value pairs assigned to the resource.
1373
+ # @return [Array<Types::Tag>]
1374
+ #
1375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListTagsForResourceResponse AWS API Documentation
1376
+ #
1377
+ class ListTagsForResourceResponse < Struct.new(
1378
+ :tags)
1379
+ SENSITIVE = []
1380
+ include Aws::Structure
1381
+ end
1382
+
1383
+ # @note When making an API call, you may pass ListUsageLimitsRequest
1384
+ # data as a hash:
1385
+ #
1386
+ # {
1387
+ # max_results: 1,
1388
+ # next_token: "PaginationToken",
1389
+ # resource_arn: "String",
1390
+ # usage_type: "serverless-compute", # accepts serverless-compute, cross-region-datasharing
1391
+ # }
1392
+ #
1393
+ # @!attribute [rw] max_results
1394
+ # An optional parameter that specifies the maximum number of results
1395
+ # to return. You can use `nextToken` to get the next page of results.
1396
+ # The default is 100.
1397
+ # @return [Integer]
1398
+ #
1399
+ # @!attribute [rw] next_token
1400
+ # If your initial `ListUsageLimits` operation returns a `nextToken`,
1401
+ # you can include the returned `nextToken` in subsequent
1402
+ # `ListUsageLimits` operations, which returns results in the next
1403
+ # page.
1404
+ # @return [String]
1405
+ #
1406
+ # @!attribute [rw] resource_arn
1407
+ # The Amazon Resource Name (ARN) associated with the resource whose
1408
+ # usage limits you want to list.
1409
+ # @return [String]
1410
+ #
1411
+ # @!attribute [rw] usage_type
1412
+ # The Amazon Redshift Serverless feature whose limits you want to see.
1413
+ # @return [String]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListUsageLimitsRequest AWS API Documentation
1416
+ #
1417
+ class ListUsageLimitsRequest < Struct.new(
1418
+ :max_results,
1419
+ :next_token,
1420
+ :resource_arn,
1421
+ :usage_type)
1422
+ SENSITIVE = []
1423
+ include Aws::Structure
1424
+ end
1425
+
1426
+ # @!attribute [rw] next_token
1427
+ # When `nextToken` is returned, there are more results available. The
1428
+ # value of `nextToken` is a unique pagination token for each page.
1429
+ # Make the call again using the returned token to retrieve the next
1430
+ # page.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] usage_limits
1434
+ # An array of returned usage limit objects.
1435
+ # @return [Array<Types::UsageLimit>]
1436
+ #
1437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListUsageLimitsResponse AWS API Documentation
1438
+ #
1439
+ class ListUsageLimitsResponse < Struct.new(
1440
+ :next_token,
1441
+ :usage_limits)
1442
+ SENSITIVE = []
1443
+ include Aws::Structure
1444
+ end
1445
+
1446
+ # @note When making an API call, you may pass ListWorkgroupsRequest
1447
+ # data as a hash:
1448
+ #
1449
+ # {
1450
+ # max_results: 1,
1451
+ # next_token: "String",
1452
+ # }
1453
+ #
1454
+ # @!attribute [rw] max_results
1455
+ # An optional parameter that specifies the maximum number of results
1456
+ # to return. You can use `nextToken` to get the next page of results.
1457
+ # @return [Integer]
1458
+ #
1459
+ # @!attribute [rw] next_token
1460
+ # If your initial ListWorkgroups operation returns a `nextToken`, you
1461
+ # can include the returned `nextToken` in subsequent ListNamespaces
1462
+ # operations, which returns results in the next page.
1463
+ # @return [String]
1464
+ #
1465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListWorkgroupsRequest AWS API Documentation
1466
+ #
1467
+ class ListWorkgroupsRequest < Struct.new(
1468
+ :max_results,
1469
+ :next_token)
1470
+ SENSITIVE = []
1471
+ include Aws::Structure
1472
+ end
1473
+
1474
+ # @!attribute [rw] next_token
1475
+ # If `nextToken` is returned, there are more results available. The
1476
+ # value of `nextToken` is a unique pagination token for each page. To
1477
+ # retrieve the next page, make the call again using the returned
1478
+ # token.
1479
+ # @return [String]
1480
+ #
1481
+ # @!attribute [rw] workgroups
1482
+ # The returned array of workgroups.
1483
+ # @return [Array<Types::Workgroup>]
1484
+ #
1485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ListWorkgroupsResponse AWS API Documentation
1486
+ #
1487
+ class ListWorkgroupsResponse < Struct.new(
1488
+ :next_token,
1489
+ :workgroups)
1490
+ SENSITIVE = []
1491
+ include Aws::Structure
1492
+ end
1493
+
1494
+ # A collection of database objects and users.
1495
+ #
1496
+ # @!attribute [rw] admin_username
1497
+ # The username of the administrator for the first database created in
1498
+ # the namespace.
1499
+ # @return [String]
1500
+ #
1501
+ # @!attribute [rw] creation_date
1502
+ # The date of when the namespace was created.
1503
+ # @return [Time]
1504
+ #
1505
+ # @!attribute [rw] db_name
1506
+ # The name of the first database created in the namespace.
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] default_iam_role_arn
1510
+ # The Amazon Resource Name (ARN) of the IAM role to set as a default
1511
+ # in the namespace.
1512
+ # @return [String]
1513
+ #
1514
+ # @!attribute [rw] iam_roles
1515
+ # A list of IAM roles to associate with the namespace.
1516
+ # @return [Array<String>]
1517
+ #
1518
+ # @!attribute [rw] kms_key_id
1519
+ # The ID of the Amazon Web Services Key Management Service key used to
1520
+ # encrypt your data.
1521
+ # @return [String]
1522
+ #
1523
+ # @!attribute [rw] log_exports
1524
+ # The types of logs the namespace can export. Available export types
1525
+ # are User log, Connection log, and User activity log.
1526
+ # @return [Array<String>]
1527
+ #
1528
+ # @!attribute [rw] namespace_arn
1529
+ # The Amazon Resource Name (ARN) associated with a namespace.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] namespace_id
1533
+ # The unique identifier of a namespace.
1534
+ # @return [String]
1535
+ #
1536
+ # @!attribute [rw] namespace_name
1537
+ # The name of the namespace. Must be between 3-64 alphanumeric
1538
+ # characters in lowercase, and it cannot be a reserved word. A list of
1539
+ # reserved words can be found in [Reserved Words][1] in the Amazon
1540
+ # Redshift Database Developer Guide.
1541
+ #
1542
+ #
1543
+ #
1544
+ # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
1545
+ # @return [String]
1546
+ #
1547
+ # @!attribute [rw] status
1548
+ # The status of the namespace.
1549
+ # @return [String]
1550
+ #
1551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/Namespace AWS API Documentation
1552
+ #
1553
+ class Namespace < Struct.new(
1554
+ :admin_username,
1555
+ :creation_date,
1556
+ :db_name,
1557
+ :default_iam_role_arn,
1558
+ :iam_roles,
1559
+ :kms_key_id,
1560
+ :log_exports,
1561
+ :namespace_arn,
1562
+ :namespace_id,
1563
+ :namespace_name,
1564
+ :status)
1565
+ SENSITIVE = [:admin_username]
1566
+ include Aws::Structure
1567
+ end
1568
+
1569
+ # Contains information about a network interface in an Amazon Redshift
1570
+ # Serverless managed VPC endpoint.
1571
+ #
1572
+ # @!attribute [rw] availability_zone
1573
+ # The availability Zone.
1574
+ # @return [String]
1575
+ #
1576
+ # @!attribute [rw] network_interface_id
1577
+ # The unique identifier of the network interface.
1578
+ # @return [String]
1579
+ #
1580
+ # @!attribute [rw] private_ip_address
1581
+ # The IPv4 address of the network interface within the subnet.
1582
+ # @return [String]
1583
+ #
1584
+ # @!attribute [rw] subnet_id
1585
+ # The unique identifier of the subnet.
1586
+ # @return [String]
1587
+ #
1588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/NetworkInterface AWS API Documentation
1589
+ #
1590
+ class NetworkInterface < Struct.new(
1591
+ :availability_zone,
1592
+ :network_interface_id,
1593
+ :private_ip_address,
1594
+ :subnet_id)
1595
+ SENSITIVE = []
1596
+ include Aws::Structure
1597
+ end
1598
+
1599
+ # @note When making an API call, you may pass PutResourcePolicyRequest
1600
+ # data as a hash:
1601
+ #
1602
+ # {
1603
+ # policy: "String", # required
1604
+ # resource_arn: "String", # required
1605
+ # }
1606
+ #
1607
+ # @!attribute [rw] policy
1608
+ # The policy to create or update. For example, the following policy
1609
+ # grants a user authorization to restore a snapshot.
1610
+ #
1611
+ # `"\{"Version": "2012-10-17", "Statement" : [\{ "Sid":
1612
+ # "AllowUserRestoreFromSnapshot", "Principal":\{"AWS":
1613
+ # ["739247239426"]\}, "Action":
1614
+ # ["redshift-serverless:RestoreFromSnapshot"] , "Effect":
1615
+ # "Allow" \}]\}"`
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] resource_arn
1619
+ # The Amazon Resource Name (ARN) of the account to create or update a
1620
+ # resource policy for.
1621
+ # @return [String]
1622
+ #
1623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/PutResourcePolicyRequest AWS API Documentation
1624
+ #
1625
+ class PutResourcePolicyRequest < Struct.new(
1626
+ :policy,
1627
+ :resource_arn)
1628
+ SENSITIVE = []
1629
+ include Aws::Structure
1630
+ end
1631
+
1632
+ # @!attribute [rw] resource_policy
1633
+ # The policy that was created or updated.
1634
+ # @return [Types::ResourcePolicy]
1635
+ #
1636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/PutResourcePolicyResponse AWS API Documentation
1637
+ #
1638
+ class PutResourcePolicyResponse < Struct.new(
1639
+ :resource_policy)
1640
+ SENSITIVE = []
1641
+ include Aws::Structure
1642
+ end
1643
+
1644
+ # The automatically created recovery point of a namespace. Recovery
1645
+ # points are created every 30 minutes and kept for 24 hours.
1646
+ #
1647
+ # @!attribute [rw] namespace_name
1648
+ # The name of the namespace the recovery point is associated with.
1649
+ # @return [String]
1650
+ #
1651
+ # @!attribute [rw] recovery_point_create_time
1652
+ # The time the recovery point is created.
1653
+ # @return [Time]
1654
+ #
1655
+ # @!attribute [rw] recovery_point_id
1656
+ # The unique identifier of the recovery point.
1657
+ # @return [String]
1658
+ #
1659
+ # @!attribute [rw] total_size_in_mega_bytes
1660
+ # The total size of the data in the recovery point in megabytes.
1661
+ # @return [Float]
1662
+ #
1663
+ # @!attribute [rw] workgroup_name
1664
+ # The name of the workgroup the recovery point is associated with.
1665
+ # @return [String]
1666
+ #
1667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/RecoveryPoint AWS API Documentation
1668
+ #
1669
+ class RecoveryPoint < Struct.new(
1670
+ :namespace_name,
1671
+ :recovery_point_create_time,
1672
+ :recovery_point_id,
1673
+ :total_size_in_mega_bytes,
1674
+ :workgroup_name)
1675
+ SENSITIVE = []
1676
+ include Aws::Structure
1677
+ end
1678
+
1679
+ # The resource could not be found.
1680
+ #
1681
+ # @!attribute [rw] message
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] resource_name
1685
+ # The name of the resource that could not be found.
1686
+ # @return [String]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ResourceNotFoundException AWS API Documentation
1689
+ #
1690
+ class ResourceNotFoundException < Struct.new(
1691
+ :message,
1692
+ :resource_name)
1693
+ SENSITIVE = []
1694
+ include Aws::Structure
1695
+ end
1696
+
1697
+ # The resource policy object. Currently, you can use policies to share
1698
+ # snapshots across Amazon Web Services accounts.
1699
+ #
1700
+ # @!attribute [rw] policy
1701
+ # The resource policy.
1702
+ # @return [String]
1703
+ #
1704
+ # @!attribute [rw] resource_arn
1705
+ # The Amazon Resource Name (ARN) of the policy.
1706
+ # @return [String]
1707
+ #
1708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ResourcePolicy AWS API Documentation
1709
+ #
1710
+ class ResourcePolicy < Struct.new(
1711
+ :policy,
1712
+ :resource_arn)
1713
+ SENSITIVE = []
1714
+ include Aws::Structure
1715
+ end
1716
+
1717
+ # @note When making an API call, you may pass RestoreFromRecoveryPointRequest
1718
+ # data as a hash:
1719
+ #
1720
+ # {
1721
+ # namespace_name: "NamespaceName", # required
1722
+ # recovery_point_id: "String", # required
1723
+ # workgroup_name: "WorkgroupName", # required
1724
+ # }
1725
+ #
1726
+ # @!attribute [rw] namespace_name
1727
+ # The name of the namespace to restore data into.
1728
+ # @return [String]
1729
+ #
1730
+ # @!attribute [rw] recovery_point_id
1731
+ # The unique identifier of the recovery point to restore from.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] workgroup_name
1735
+ # The name of the workgroup used to restore data.
1736
+ # @return [String]
1737
+ #
1738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/RestoreFromRecoveryPointRequest AWS API Documentation
1739
+ #
1740
+ class RestoreFromRecoveryPointRequest < Struct.new(
1741
+ :namespace_name,
1742
+ :recovery_point_id,
1743
+ :workgroup_name)
1744
+ SENSITIVE = []
1745
+ include Aws::Structure
1746
+ end
1747
+
1748
+ # @!attribute [rw] namespace
1749
+ # The namespace that data was restored into.
1750
+ # @return [Types::Namespace]
1751
+ #
1752
+ # @!attribute [rw] recovery_point_id
1753
+ # The unique identifier of the recovery point used for the restore.
1754
+ # @return [String]
1755
+ #
1756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/RestoreFromRecoveryPointResponse AWS API Documentation
1757
+ #
1758
+ class RestoreFromRecoveryPointResponse < Struct.new(
1759
+ :namespace,
1760
+ :recovery_point_id)
1761
+ SENSITIVE = []
1762
+ include Aws::Structure
1763
+ end
1764
+
1765
+ # @note When making an API call, you may pass RestoreFromSnapshotRequest
1766
+ # data as a hash:
1767
+ #
1768
+ # {
1769
+ # namespace_name: "NamespaceName", # required
1770
+ # owner_account: "String",
1771
+ # snapshot_arn: "String",
1772
+ # snapshot_name: "String",
1773
+ # workgroup_name: "WorkgroupName", # required
1774
+ # }
1775
+ #
1776
+ # @!attribute [rw] namespace_name
1777
+ # The name of the namespace to restore the snapshot to.
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] owner_account
1781
+ # The Amazon Web Services account that owns the snapshot.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] snapshot_arn
1785
+ # The Amazon Resource Name (ARN) of the snapshot to restore from.
1786
+ # @return [String]
1787
+ #
1788
+ # @!attribute [rw] snapshot_name
1789
+ # The name of the snapshot to restore from.
1790
+ # @return [String]
1791
+ #
1792
+ # @!attribute [rw] workgroup_name
1793
+ # The name of the workgroup used to restore the snapshot.
1794
+ # @return [String]
1795
+ #
1796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/RestoreFromSnapshotRequest AWS API Documentation
1797
+ #
1798
+ class RestoreFromSnapshotRequest < Struct.new(
1799
+ :namespace_name,
1800
+ :owner_account,
1801
+ :snapshot_arn,
1802
+ :snapshot_name,
1803
+ :workgroup_name)
1804
+ SENSITIVE = []
1805
+ include Aws::Structure
1806
+ end
1807
+
1808
+ # @!attribute [rw] namespace
1809
+ # A collection of database objects and users.
1810
+ # @return [Types::Namespace]
1811
+ #
1812
+ # @!attribute [rw] owner_account
1813
+ # The owner Amazon Web Services; account of the snapshot that was
1814
+ # restored.
1815
+ # @return [String]
1816
+ #
1817
+ # @!attribute [rw] snapshot_name
1818
+ # The name of the snapshot used to restore the namespace.
1819
+ # @return [String]
1820
+ #
1821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/RestoreFromSnapshotResponse AWS API Documentation
1822
+ #
1823
+ class RestoreFromSnapshotResponse < Struct.new(
1824
+ :namespace,
1825
+ :owner_account,
1826
+ :snapshot_name)
1827
+ SENSITIVE = []
1828
+ include Aws::Structure
1829
+ end
1830
+
1831
+ # The service limit was exceeded.
1832
+ #
1833
+ # @!attribute [rw] message
1834
+ # @return [String]
1835
+ #
1836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ServiceQuotaExceededException AWS API Documentation
1837
+ #
1838
+ class ServiceQuotaExceededException < Struct.new(
1839
+ :message)
1840
+ SENSITIVE = []
1841
+ include Aws::Structure
1842
+ end
1843
+
1844
+ # A snapshot object that contains databases.
1845
+ #
1846
+ # @!attribute [rw] accounts_with_provisioned_restore_access
1847
+ # All of the Amazon Web Services accounts that have access to restore
1848
+ # a snapshot to a provisioned cluster.
1849
+ # @return [Array<String>]
1850
+ #
1851
+ # @!attribute [rw] accounts_with_restore_access
1852
+ # All of the Amazon Web Services accounts that have access to restore
1853
+ # a snapshot to a namespace.
1854
+ # @return [Array<String>]
1855
+ #
1856
+ # @!attribute [rw] actual_incremental_backup_size_in_mega_bytes
1857
+ # The size of the incremental backup in megabytes.
1858
+ # @return [Float]
1859
+ #
1860
+ # @!attribute [rw] admin_username
1861
+ # The username of the database within a snapshot.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] backup_progress_in_mega_bytes
1865
+ # The size in megabytes of the data that has been backed up to a
1866
+ # snapshot.
1867
+ # @return [Float]
1868
+ #
1869
+ # @!attribute [rw] current_backup_rate_in_mega_bytes_per_second
1870
+ # The rate at which data is backed up into a snapshot in megabytes per
1871
+ # second.
1872
+ # @return [Float]
1873
+ #
1874
+ # @!attribute [rw] elapsed_time_in_seconds
1875
+ # The amount of time it took to back up data into a snapshot.
1876
+ # @return [Integer]
1877
+ #
1878
+ # @!attribute [rw] estimated_seconds_to_completion
1879
+ # The estimated amount of seconds until the snapshot completes backup.
1880
+ # @return [Integer]
1881
+ #
1882
+ # @!attribute [rw] kms_key_id
1883
+ # The unique identifier of the KMS key used to encrypt the snapshot.
1884
+ # @return [String]
1885
+ #
1886
+ # @!attribute [rw] namespace_arn
1887
+ # The Amazon Resource Name (ARN) of the namespace the snapshot was
1888
+ # created from.
1889
+ # @return [String]
1890
+ #
1891
+ # @!attribute [rw] namespace_name
1892
+ # The name of the namepsace.
1893
+ # @return [String]
1894
+ #
1895
+ # @!attribute [rw] owner_account
1896
+ # The owner Amazon Web Services; account of the snapshot.
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] snapshot_arn
1900
+ # The Amazon Resource Name (ARN) of the snapshot.
1901
+ # @return [String]
1902
+ #
1903
+ # @!attribute [rw] snapshot_create_time
1904
+ # The timestamp of when the snapshot was created.
1905
+ # @return [Time]
1906
+ #
1907
+ # @!attribute [rw] snapshot_name
1908
+ # The name of the snapshot.
1909
+ # @return [String]
1910
+ #
1911
+ # @!attribute [rw] snapshot_remaining_days
1912
+ # The amount of days until the snapshot is deleted.
1913
+ # @return [Integer]
1914
+ #
1915
+ # @!attribute [rw] snapshot_retention_period
1916
+ # The period of time, in days, of how long the snapshot is retained.
1917
+ # @return [Integer]
1918
+ #
1919
+ # @!attribute [rw] snapshot_retention_start_time
1920
+ # The timestamp of when data within the snapshot started getting
1921
+ # retained.
1922
+ # @return [Time]
1923
+ #
1924
+ # @!attribute [rw] status
1925
+ # The status of the snapshot.
1926
+ # @return [String]
1927
+ #
1928
+ # @!attribute [rw] total_backup_size_in_mega_bytes
1929
+ # The total size, in megabytes, of how big the snapshot is.
1930
+ # @return [Float]
1931
+ #
1932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/Snapshot AWS API Documentation
1933
+ #
1934
+ class Snapshot < Struct.new(
1935
+ :accounts_with_provisioned_restore_access,
1936
+ :accounts_with_restore_access,
1937
+ :actual_incremental_backup_size_in_mega_bytes,
1938
+ :admin_username,
1939
+ :backup_progress_in_mega_bytes,
1940
+ :current_backup_rate_in_mega_bytes_per_second,
1941
+ :elapsed_time_in_seconds,
1942
+ :estimated_seconds_to_completion,
1943
+ :kms_key_id,
1944
+ :namespace_arn,
1945
+ :namespace_name,
1946
+ :owner_account,
1947
+ :snapshot_arn,
1948
+ :snapshot_create_time,
1949
+ :snapshot_name,
1950
+ :snapshot_remaining_days,
1951
+ :snapshot_retention_period,
1952
+ :snapshot_retention_start_time,
1953
+ :status,
1954
+ :total_backup_size_in_mega_bytes)
1955
+ SENSITIVE = []
1956
+ include Aws::Structure
1957
+ end
1958
+
1959
+ # A map of key-value pairs.
1960
+ #
1961
+ # @note When making an API call, you may pass Tag
1962
+ # data as a hash:
1963
+ #
1964
+ # {
1965
+ # key: "TagKey", # required
1966
+ # value: "TagValue", # required
1967
+ # }
1968
+ #
1969
+ # @!attribute [rw] key
1970
+ # The key to use in the tag.
1971
+ # @return [String]
1972
+ #
1973
+ # @!attribute [rw] value
1974
+ # The value of the tag.
1975
+ # @return [String]
1976
+ #
1977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/Tag AWS API Documentation
1978
+ #
1979
+ class Tag < Struct.new(
1980
+ :key,
1981
+ :value)
1982
+ SENSITIVE = []
1983
+ include Aws::Structure
1984
+ end
1985
+
1986
+ # @note When making an API call, you may pass TagResourceRequest
1987
+ # data as a hash:
1988
+ #
1989
+ # {
1990
+ # resource_arn: "AmazonResourceName", # required
1991
+ # tags: [ # required
1992
+ # {
1993
+ # key: "TagKey", # required
1994
+ # value: "TagValue", # required
1995
+ # },
1996
+ # ],
1997
+ # }
1998
+ #
1999
+ # @!attribute [rw] resource_arn
2000
+ # The Amazon Resource Name (ARN) of the resource to tag.
2001
+ # @return [String]
2002
+ #
2003
+ # @!attribute [rw] tags
2004
+ # The map of the key-value pairs used to tag the resource.
2005
+ # @return [Array<Types::Tag>]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/TagResourceRequest AWS API Documentation
2008
+ #
2009
+ class TagResourceRequest < Struct.new(
2010
+ :resource_arn,
2011
+ :tags)
2012
+ SENSITIVE = []
2013
+ include Aws::Structure
2014
+ end
2015
+
2016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/TagResourceResponse AWS API Documentation
2017
+ #
2018
+ class TagResourceResponse < Aws::EmptyStructure; end
2019
+
2020
+ # The request was denied due to request throttling.
2021
+ #
2022
+ # @!attribute [rw] code
2023
+ # @return [String]
2024
+ #
2025
+ # @!attribute [rw] message
2026
+ # @return [String]
2027
+ #
2028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ThrottlingException AWS API Documentation
2029
+ #
2030
+ class ThrottlingException < Struct.new(
2031
+ :code,
2032
+ :message)
2033
+ SENSITIVE = []
2034
+ include Aws::Structure
2035
+ end
2036
+
2037
+ # The request exceeded the number of tags allowed for a resource.
2038
+ #
2039
+ # @!attribute [rw] message
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] resource_name
2043
+ # The name of the resource that exceeded the number of tags allowed
2044
+ # for a resource.
2045
+ # @return [String]
2046
+ #
2047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/TooManyTagsException AWS API Documentation
2048
+ #
2049
+ class TooManyTagsException < Struct.new(
2050
+ :message,
2051
+ :resource_name)
2052
+ SENSITIVE = []
2053
+ include Aws::Structure
2054
+ end
2055
+
2056
+ # @note When making an API call, you may pass UntagResourceRequest
2057
+ # data as a hash:
2058
+ #
2059
+ # {
2060
+ # resource_arn: "AmazonResourceName", # required
2061
+ # tag_keys: ["TagKey"], # required
2062
+ # }
2063
+ #
2064
+ # @!attribute [rw] resource_arn
2065
+ # The Amazon Resource Name (ARN) of the resource to remove tags from.
2066
+ # @return [String]
2067
+ #
2068
+ # @!attribute [rw] tag_keys
2069
+ # The tag or set of tags to remove from the resource.
2070
+ # @return [Array<String>]
2071
+ #
2072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UntagResourceRequest AWS API Documentation
2073
+ #
2074
+ class UntagResourceRequest < Struct.new(
2075
+ :resource_arn,
2076
+ :tag_keys)
2077
+ SENSITIVE = []
2078
+ include Aws::Structure
2079
+ end
2080
+
2081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UntagResourceResponse AWS API Documentation
2082
+ #
2083
+ class UntagResourceResponse < Aws::EmptyStructure; end
2084
+
2085
+ # @note When making an API call, you may pass UpdateEndpointAccessRequest
2086
+ # data as a hash:
2087
+ #
2088
+ # {
2089
+ # endpoint_name: "String", # required
2090
+ # vpc_security_group_ids: ["VpcSecurityGroupId"],
2091
+ # }
2092
+ #
2093
+ # @!attribute [rw] endpoint_name
2094
+ # The name of the VPC endpoint to update.
2095
+ # @return [String]
2096
+ #
2097
+ # @!attribute [rw] vpc_security_group_ids
2098
+ # The list of VPC security groups associated with the endpoint after
2099
+ # the endpoint is modified.
2100
+ # @return [Array<String>]
2101
+ #
2102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateEndpointAccessRequest AWS API Documentation
2103
+ #
2104
+ class UpdateEndpointAccessRequest < Struct.new(
2105
+ :endpoint_name,
2106
+ :vpc_security_group_ids)
2107
+ SENSITIVE = []
2108
+ include Aws::Structure
2109
+ end
2110
+
2111
+ # @!attribute [rw] endpoint
2112
+ # The updated VPC endpoint.
2113
+ # @return [Types::EndpointAccess]
2114
+ #
2115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateEndpointAccessResponse AWS API Documentation
2116
+ #
2117
+ class UpdateEndpointAccessResponse < Struct.new(
2118
+ :endpoint)
2119
+ SENSITIVE = []
2120
+ include Aws::Structure
2121
+ end
2122
+
2123
+ # @note When making an API call, you may pass UpdateNamespaceRequest
2124
+ # data as a hash:
2125
+ #
2126
+ # {
2127
+ # admin_user_password: "DbPassword",
2128
+ # admin_username: "DbUser",
2129
+ # default_iam_role_arn: "String",
2130
+ # iam_roles: ["IamRoleArn"],
2131
+ # kms_key_id: "String",
2132
+ # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
2133
+ # namespace_name: "NamespaceName", # required
2134
+ # }
2135
+ #
2136
+ # @!attribute [rw] admin_user_password
2137
+ # The password of the administrator for the first database created in
2138
+ # the namespace.
2139
+ # @return [String]
2140
+ #
2141
+ # @!attribute [rw] admin_username
2142
+ # The username of the administrator for the first database created in
2143
+ # the namespace.
2144
+ # @return [String]
2145
+ #
2146
+ # @!attribute [rw] default_iam_role_arn
2147
+ # The Amazon Resource Name (ARN) of the IAM role to set as a default
2148
+ # in the namespace.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] iam_roles
2152
+ # A list of IAM roles to associate with the namespace.
2153
+ # @return [Array<String>]
2154
+ #
2155
+ # @!attribute [rw] kms_key_id
2156
+ # The ID of the Amazon Web Services Key Management Service key used to
2157
+ # encrypt your data.
2158
+ # @return [String]
2159
+ #
2160
+ # @!attribute [rw] log_exports
2161
+ # The types of logs the namespace can export. The export types are
2162
+ # `userlog`, `connectionlog`, and `useractivitylog`.
2163
+ # @return [Array<String>]
2164
+ #
2165
+ # @!attribute [rw] namespace_name
2166
+ # The name of the namespace.
2167
+ # @return [String]
2168
+ #
2169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateNamespaceRequest AWS API Documentation
2170
+ #
2171
+ class UpdateNamespaceRequest < Struct.new(
2172
+ :admin_user_password,
2173
+ :admin_username,
2174
+ :default_iam_role_arn,
2175
+ :iam_roles,
2176
+ :kms_key_id,
2177
+ :log_exports,
2178
+ :namespace_name)
2179
+ SENSITIVE = [:admin_user_password, :admin_username]
2180
+ include Aws::Structure
2181
+ end
2182
+
2183
+ # @!attribute [rw] namespace
2184
+ # A list of tag instances.
2185
+ # @return [Types::Namespace]
2186
+ #
2187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateNamespaceResponse AWS API Documentation
2188
+ #
2189
+ class UpdateNamespaceResponse < Struct.new(
2190
+ :namespace)
2191
+ SENSITIVE = []
2192
+ include Aws::Structure
2193
+ end
2194
+
2195
+ # @note When making an API call, you may pass UpdateSnapshotRequest
2196
+ # data as a hash:
2197
+ #
2198
+ # {
2199
+ # retention_period: 1,
2200
+ # snapshot_name: "String", # required
2201
+ # }
2202
+ #
2203
+ # @!attribute [rw] retention_period
2204
+ # The new retention period of the snapshot.
2205
+ # @return [Integer]
2206
+ #
2207
+ # @!attribute [rw] snapshot_name
2208
+ # The name of the snapshot.
2209
+ # @return [String]
2210
+ #
2211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateSnapshotRequest AWS API Documentation
2212
+ #
2213
+ class UpdateSnapshotRequest < Struct.new(
2214
+ :retention_period,
2215
+ :snapshot_name)
2216
+ SENSITIVE = []
2217
+ include Aws::Structure
2218
+ end
2219
+
2220
+ # @!attribute [rw] snapshot
2221
+ # The updated snapshot object.
2222
+ # @return [Types::Snapshot]
2223
+ #
2224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateSnapshotResponse AWS API Documentation
2225
+ #
2226
+ class UpdateSnapshotResponse < Struct.new(
2227
+ :snapshot)
2228
+ SENSITIVE = []
2229
+ include Aws::Structure
2230
+ end
2231
+
2232
+ # @note When making an API call, you may pass UpdateUsageLimitRequest
2233
+ # data as a hash:
2234
+ #
2235
+ # {
2236
+ # amount: 1,
2237
+ # breach_action: "log", # accepts log, emit-metric, deactivate
2238
+ # usage_limit_id: "String", # required
2239
+ # }
2240
+ #
2241
+ # @!attribute [rw] amount
2242
+ # The new limit amount. For more information about this parameter.
2243
+ # @return [Integer]
2244
+ #
2245
+ # @!attribute [rw] breach_action
2246
+ # The new action that Amazon Redshift Serverless takes when the limit
2247
+ # is reached.
2248
+ # @return [String]
2249
+ #
2250
+ # @!attribute [rw] usage_limit_id
2251
+ # The identifier of the usage limit to update.
2252
+ # @return [String]
2253
+ #
2254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateUsageLimitRequest AWS API Documentation
2255
+ #
2256
+ class UpdateUsageLimitRequest < Struct.new(
2257
+ :amount,
2258
+ :breach_action,
2259
+ :usage_limit_id)
2260
+ SENSITIVE = []
2261
+ include Aws::Structure
2262
+ end
2263
+
2264
+ # @!attribute [rw] usage_limit
2265
+ # The updated usage limit object.
2266
+ # @return [Types::UsageLimit]
2267
+ #
2268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateUsageLimitResponse AWS API Documentation
2269
+ #
2270
+ class UpdateUsageLimitResponse < Struct.new(
2271
+ :usage_limit)
2272
+ SENSITIVE = []
2273
+ include Aws::Structure
2274
+ end
2275
+
2276
+ # @note When making an API call, you may pass UpdateWorkgroupRequest
2277
+ # data as a hash:
2278
+ #
2279
+ # {
2280
+ # base_capacity: 1,
2281
+ # config_parameters: [
2282
+ # {
2283
+ # parameter_key: "ParameterKey",
2284
+ # parameter_value: "ParameterValue",
2285
+ # },
2286
+ # ],
2287
+ # enhanced_vpc_routing: false,
2288
+ # publicly_accessible: false,
2289
+ # security_group_ids: ["SecurityGroupId"],
2290
+ # subnet_ids: ["SubnetId"],
2291
+ # workgroup_name: "WorkgroupName", # required
2292
+ # }
2293
+ #
2294
+ # @!attribute [rw] base_capacity
2295
+ # The new base data warehouse capacity in Redshift Processing Units
2296
+ # (RPUs).
2297
+ # @return [Integer]
2298
+ #
2299
+ # @!attribute [rw] config_parameters
2300
+ # An array of parameters to set for advanced control over a database.
2301
+ # The options are `datestyle`, `enable_user_activity_logging`,
2302
+ # `query_group`, `search_path`, and `max_query_execution_time`.
2303
+ # @return [Array<Types::ConfigParameter>]
2304
+ #
2305
+ # @!attribute [rw] enhanced_vpc_routing
2306
+ # The value that specifies whether to turn on enhanced virtual private
2307
+ # cloud (VPC) routing, which forces Amazon Redshift Serverless to
2308
+ # route traffic through your VPC.
2309
+ # @return [Boolean]
2310
+ #
2311
+ # @!attribute [rw] publicly_accessible
2312
+ # A value that specifies whether the workgroup can be accessible from
2313
+ # a public network.
2314
+ # @return [Boolean]
2315
+ #
2316
+ # @!attribute [rw] security_group_ids
2317
+ # An array of security group IDs to associate with the workgroup.
2318
+ # @return [Array<String>]
2319
+ #
2320
+ # @!attribute [rw] subnet_ids
2321
+ # An array of VPC subnet IDs to associate with the workgroup.
2322
+ # @return [Array<String>]
2323
+ #
2324
+ # @!attribute [rw] workgroup_name
2325
+ # The name of the workgroup to update.
2326
+ # @return [String]
2327
+ #
2328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateWorkgroupRequest AWS API Documentation
2329
+ #
2330
+ class UpdateWorkgroupRequest < Struct.new(
2331
+ :base_capacity,
2332
+ :config_parameters,
2333
+ :enhanced_vpc_routing,
2334
+ :publicly_accessible,
2335
+ :security_group_ids,
2336
+ :subnet_ids,
2337
+ :workgroup_name)
2338
+ SENSITIVE = []
2339
+ include Aws::Structure
2340
+ end
2341
+
2342
+ # @!attribute [rw] workgroup
2343
+ # The updated workgroup object.
2344
+ # @return [Types::Workgroup]
2345
+ #
2346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UpdateWorkgroupResponse AWS API Documentation
2347
+ #
2348
+ class UpdateWorkgroupResponse < Struct.new(
2349
+ :workgroup)
2350
+ SENSITIVE = []
2351
+ include Aws::Structure
2352
+ end
2353
+
2354
+ # The usage limit object.
2355
+ #
2356
+ # @!attribute [rw] amount
2357
+ # The limit amount. If time-based, this amount is in RPUs consumed per
2358
+ # hour. If data-based, this amount is in terabytes (TB). The value
2359
+ # must be a positive number.
2360
+ # @return [Integer]
2361
+ #
2362
+ # @!attribute [rw] breach_action
2363
+ # The action that Amazon Redshift Serverless takes when the limit is
2364
+ # reached.
2365
+ # @return [String]
2366
+ #
2367
+ # @!attribute [rw] period
2368
+ # The time period that the amount applies to. A weekly period begins
2369
+ # on Sunday. The default is monthly.
2370
+ # @return [String]
2371
+ #
2372
+ # @!attribute [rw] resource_arn
2373
+ # The Amazon Resource Name (ARN) that identifies the Amazon Redshift
2374
+ # Serverless resource.
2375
+ # @return [String]
2376
+ #
2377
+ # @!attribute [rw] usage_limit_arn
2378
+ # The Amazon Resource Name (ARN) of the resource associated with the
2379
+ # usage limit.
2380
+ # @return [String]
2381
+ #
2382
+ # @!attribute [rw] usage_limit_id
2383
+ # The identifier of the usage limit.
2384
+ # @return [String]
2385
+ #
2386
+ # @!attribute [rw] usage_type
2387
+ # The Amazon Redshift Serverless feature to limit.
2388
+ # @return [String]
2389
+ #
2390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/UsageLimit AWS API Documentation
2391
+ #
2392
+ class UsageLimit < Struct.new(
2393
+ :amount,
2394
+ :breach_action,
2395
+ :period,
2396
+ :resource_arn,
2397
+ :usage_limit_arn,
2398
+ :usage_limit_id,
2399
+ :usage_type)
2400
+ SENSITIVE = []
2401
+ include Aws::Structure
2402
+ end
2403
+
2404
+ # The input failed to satisfy the constraints specified by an AWS
2405
+ # service.
2406
+ #
2407
+ # @!attribute [rw] message
2408
+ # @return [String]
2409
+ #
2410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/ValidationException AWS API Documentation
2411
+ #
2412
+ class ValidationException < Struct.new(
2413
+ :message)
2414
+ SENSITIVE = []
2415
+ include Aws::Structure
2416
+ end
2417
+
2418
+ # The connection endpoint for connecting to Amazon Redshift Serverless
2419
+ # through the proxy.
2420
+ #
2421
+ # @!attribute [rw] network_interfaces
2422
+ # One or more network interfaces of the endpoint. Also known as an
2423
+ # interface endpoint.
2424
+ # @return [Array<Types::NetworkInterface>]
2425
+ #
2426
+ # @!attribute [rw] vpc_endpoint_id
2427
+ # The connection endpoint ID for connecting to Amazon Redshift
2428
+ # Serverless.
2429
+ # @return [String]
2430
+ #
2431
+ # @!attribute [rw] vpc_id
2432
+ # The VPC identifier that the endpoint is associated with.
2433
+ # @return [String]
2434
+ #
2435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/VpcEndpoint AWS API Documentation
2436
+ #
2437
+ class VpcEndpoint < Struct.new(
2438
+ :network_interfaces,
2439
+ :vpc_endpoint_id,
2440
+ :vpc_id)
2441
+ SENSITIVE = []
2442
+ include Aws::Structure
2443
+ end
2444
+
2445
+ # Describes the members of a VPC security group.
2446
+ #
2447
+ # @!attribute [rw] status
2448
+ # The status of the VPC security group.
2449
+ # @return [String]
2450
+ #
2451
+ # @!attribute [rw] vpc_security_group_id
2452
+ # The unique identifier of the VPC security group.
2453
+ # @return [String]
2454
+ #
2455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/VpcSecurityGroupMembership AWS API Documentation
2456
+ #
2457
+ class VpcSecurityGroupMembership < Struct.new(
2458
+ :status,
2459
+ :vpc_security_group_id)
2460
+ SENSITIVE = []
2461
+ include Aws::Structure
2462
+ end
2463
+
2464
+ # The collection of computing resources from which an endpoint is
2465
+ # created.
2466
+ #
2467
+ # @!attribute [rw] base_capacity
2468
+ # The base data warehouse capacity of the workgroup in Redshift
2469
+ # Processing Units (RPUs).
2470
+ # @return [Integer]
2471
+ #
2472
+ # @!attribute [rw] config_parameters
2473
+ # An array of parameters to set for finer control over a database. The
2474
+ # options are `datestyle`, `enable_user_activity_logging`,
2475
+ # `query_group`, `search_path`, and `max_query_execution_time`.
2476
+ # @return [Array<Types::ConfigParameter>]
2477
+ #
2478
+ # @!attribute [rw] creation_date
2479
+ # The creation date of the workgroup.
2480
+ # @return [Time]
2481
+ #
2482
+ # @!attribute [rw] endpoint
2483
+ # The endpoint that is created from the workgroup.
2484
+ # @return [Types::Endpoint]
2485
+ #
2486
+ # @!attribute [rw] enhanced_vpc_routing
2487
+ # The value that specifies whether to enable enhanced virtual private
2488
+ # cloud (VPC) routing, which forces Amazon Redshift Serverless to
2489
+ # route traffic through your VPC.
2490
+ # @return [Boolean]
2491
+ #
2492
+ # @!attribute [rw] namespace_name
2493
+ # The namespace the workgroup is associated with.
2494
+ # @return [String]
2495
+ #
2496
+ # @!attribute [rw] publicly_accessible
2497
+ # A value that specifies whether the workgroup can be accessible from
2498
+ # a public network
2499
+ # @return [Boolean]
2500
+ #
2501
+ # @!attribute [rw] security_group_ids
2502
+ # An array of security group IDs to associate with the workgroup.
2503
+ # @return [Array<String>]
2504
+ #
2505
+ # @!attribute [rw] status
2506
+ # The status of the workgroup.
2507
+ # @return [String]
2508
+ #
2509
+ # @!attribute [rw] subnet_ids
2510
+ # An array of subnet IDs the workgroup is associated with.
2511
+ # @return [Array<String>]
2512
+ #
2513
+ # @!attribute [rw] workgroup_arn
2514
+ # The Amazon Resource Name (ARN) that links to the workgroup.
2515
+ # @return [String]
2516
+ #
2517
+ # @!attribute [rw] workgroup_id
2518
+ # The unique identifier of the workgroup.
2519
+ # @return [String]
2520
+ #
2521
+ # @!attribute [rw] workgroup_name
2522
+ # The name of the workgroup.
2523
+ # @return [String]
2524
+ #
2525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshiftserverless-2021-04-21/Workgroup AWS API Documentation
2526
+ #
2527
+ class Workgroup < Struct.new(
2528
+ :base_capacity,
2529
+ :config_parameters,
2530
+ :creation_date,
2531
+ :endpoint,
2532
+ :enhanced_vpc_routing,
2533
+ :namespace_name,
2534
+ :publicly_accessible,
2535
+ :security_group_ids,
2536
+ :status,
2537
+ :subnet_ids,
2538
+ :workgroup_arn,
2539
+ :workgroup_id,
2540
+ :workgroup_name)
2541
+ SENSITIVE = []
2542
+ include Aws::Structure
2543
+ end
2544
+
2545
+ end
2546
+ end