@aws-sdk/client-redshift 3.262.0 → 3.265.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/Redshift.d.ts +106 -105
- package/dist-types/RedshiftClient.d.ts +6 -7
- package/dist-types/commands/AuthorizeClusterSecurityGroupIngressCommand.d.ts +3 -3
- package/dist-types/commands/AuthorizeSnapshotAccessCommand.d.ts +1 -1
- package/dist-types/commands/CopyClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/CreateClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateClusterSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +2 -2
- package/dist-types/commands/CreateHsmClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/CreateHsmConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/CreateSnapshotCopyGrantCommand.d.ts +1 -1
- package/dist-types/commands/CreateTagsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterSecurityGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DescribeClusterParameterGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeClusterParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClusterSecurityGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeClusterSnapshotsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClusterSubnetGroupsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClustersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeHsmClientCertificatesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeHsmConfigurationsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeReservedNodeOfferingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeResizeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSnapshotCopyGrantsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTagsCommand.d.ts +7 -7
- package/dist-types/commands/DescribeUsageLimitsCommand.d.ts +1 -1
- package/dist-types/commands/DisableSnapshotCopyCommand.d.ts +1 -1
- package/dist-types/commands/GetClusterCredentialsCommand.d.ts +4 -4
- package/dist-types/commands/GetClusterCredentialsWithIAMCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterCommand.d.ts +2 -2
- package/dist-types/commands/ModifyClusterIamRolesCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/PurchaseReservedNodeOfferingCommand.d.ts +1 -1
- package/dist-types/commands/ResizeClusterCommand.d.ts +23 -23
- package/dist-types/commands/RestoreFromClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/RestoreTableFromClusterSnapshotCommand.d.ts +3 -1
- package/dist-types/commands/RevokeSnapshotAccessCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +400 -400
- package/dist-types/models/models_1.d.ts +223 -227
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +4 -4
|
@@ -16,9 +16,9 @@ export interface DescribeHsmConfigurationsMessage {
|
|
|
16
16
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
17
17
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
18
18
|
* set of records by retrying the command with the returned marker value. </p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
19
|
+
* <p>Default: <code>100</code>
|
|
20
|
+
* </p>
|
|
21
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
22
22
|
*/
|
|
23
23
|
MaxRecords?: number;
|
|
24
24
|
/**
|
|
@@ -72,8 +72,8 @@ export interface HsmConfigurationMessage {
|
|
|
72
72
|
export interface DescribeLoggingStatusMessage {
|
|
73
73
|
/**
|
|
74
74
|
* <p>The identifier of the cluster from which to get the logging status.</p>
|
|
75
|
-
*
|
|
76
|
-
*
|
|
75
|
+
* <p>Example: <code>examplecluster</code>
|
|
76
|
+
* </p>
|
|
77
77
|
*/
|
|
78
78
|
ClusterIdentifier: string | undefined;
|
|
79
79
|
}
|
|
@@ -115,7 +115,8 @@ export interface LoggingStatus {
|
|
|
115
115
|
*/
|
|
116
116
|
LogDestinationType?: LogDestinationType | string;
|
|
117
117
|
/**
|
|
118
|
-
* <p>The collection of exported log types.
|
|
118
|
+
* <p>The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and
|
|
119
|
+
* <code>userlog</code>.</p>
|
|
119
120
|
*/
|
|
120
121
|
LogExports?: string[];
|
|
121
122
|
}
|
|
@@ -203,9 +204,9 @@ export interface DescribeNodeConfigurationOptionsMessage {
|
|
|
203
204
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
204
205
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
205
206
|
* set of records by retrying the command with the returned marker value. </p>
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
207
|
+
* <p>Default: <code>500</code>
|
|
208
|
+
* </p>
|
|
209
|
+
* <p>Constraints: minimum 100, maximum 500.</p>
|
|
209
210
|
*/
|
|
210
211
|
MaxRecords?: number;
|
|
211
212
|
}
|
|
@@ -255,8 +256,8 @@ export interface DescribeOrderableClusterOptionsMessage {
|
|
|
255
256
|
/**
|
|
256
257
|
* <p>The version filter value. Specify this parameter to show only the available
|
|
257
258
|
* offerings matching the specified version.</p>
|
|
258
|
-
*
|
|
259
|
-
*
|
|
259
|
+
* <p>Default: All versions.</p>
|
|
260
|
+
* <p>Constraints: Must be one of the version returned from <a>DescribeClusterVersions</a>.</p>
|
|
260
261
|
*/
|
|
261
262
|
ClusterVersion?: string;
|
|
262
263
|
/**
|
|
@@ -269,9 +270,9 @@ export interface DescribeOrderableClusterOptionsMessage {
|
|
|
269
270
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
270
271
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
271
272
|
* set of records by retrying the command with the returned marker value. </p>
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
273
|
+
* <p>Default: <code>100</code>
|
|
274
|
+
* </p>
|
|
275
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
275
276
|
*/
|
|
276
277
|
MaxRecords?: number;
|
|
277
278
|
/**
|
|
@@ -443,9 +444,9 @@ export interface DescribeReservedNodeOfferingsMessage {
|
|
|
443
444
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
444
445
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
445
446
|
* set of records by retrying the command with the returned marker value. </p>
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
447
|
+
* <p>Default: <code>100</code>
|
|
448
|
+
* </p>
|
|
449
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
449
450
|
*/
|
|
450
451
|
MaxRecords?: number;
|
|
451
452
|
/**
|
|
@@ -534,9 +535,9 @@ export interface DescribeReservedNodesMessage {
|
|
|
534
535
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
535
536
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
536
537
|
* set of records by retrying the command with the returned marker value. </p>
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
538
|
+
* <p>Default: <code>100</code>
|
|
539
|
+
* </p>
|
|
540
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
540
541
|
*/
|
|
541
542
|
MaxRecords?: number;
|
|
542
543
|
/**
|
|
@@ -573,7 +574,7 @@ export interface DescribeResizeMessage {
|
|
|
573
574
|
/**
|
|
574
575
|
* <p>The unique identifier of a cluster whose resize progress you are requesting. This
|
|
575
576
|
* parameter is case-sensitive.</p>
|
|
576
|
-
*
|
|
577
|
+
* <p>By default, resize operations for all clusters defined for an Amazon Web Services account are
|
|
577
578
|
* returned.</p>
|
|
578
579
|
*/
|
|
579
580
|
ClusterIdentifier: string | undefined;
|
|
@@ -642,9 +643,9 @@ export interface DescribeScheduledActionsMessage {
|
|
|
642
643
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
643
644
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
644
645
|
* set of records by retrying the command with the returned marker value. </p>
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
*
|
|
646
|
+
* <p>Default: <code>100</code>
|
|
647
|
+
* </p>
|
|
648
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
648
649
|
*/
|
|
649
650
|
MaxRecords?: number;
|
|
650
651
|
}
|
|
@@ -676,9 +677,9 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
676
677
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
677
678
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
678
679
|
* set of records by retrying the command with the returned marker value. </p>
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
680
|
+
* <p>Default: <code>100</code>
|
|
681
|
+
* </p>
|
|
682
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
682
683
|
*/
|
|
683
684
|
MaxRecords?: number;
|
|
684
685
|
/**
|
|
@@ -688,7 +689,7 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
688
689
|
* <code>Marker</code> field of the response. You can retrieve the next set of response
|
|
689
690
|
* records by providing the returned marker value in the <code>Marker</code> parameter and
|
|
690
691
|
* retrying the request. </p>
|
|
691
|
-
*
|
|
692
|
+
* <p>Constraints: You can specify either the <b>SnapshotCopyGrantName</b> parameter or the <b>Marker</b> parameter, but not both. </p>
|
|
692
693
|
*/
|
|
693
694
|
Marker?: string;
|
|
694
695
|
/**
|
|
@@ -719,7 +720,7 @@ export interface SnapshotCopyGrantMessage {
|
|
|
719
720
|
* <code>Marker</code> field of the response. You can retrieve the next set of response
|
|
720
721
|
* records by providing the returned marker value in the <code>Marker</code> parameter and
|
|
721
722
|
* retrying the request. </p>
|
|
722
|
-
*
|
|
723
|
+
* <p>Constraints: You can specify either the <b>SnapshotCopyGrantName</b> parameter or the <b>Marker</b> parameter, but not both. </p>
|
|
723
724
|
*/
|
|
724
725
|
Marker?: string;
|
|
725
726
|
/**
|
|
@@ -834,9 +835,9 @@ export interface TableRestoreStatus {
|
|
|
834
835
|
TableRestoreRequestId?: string;
|
|
835
836
|
/**
|
|
836
837
|
* <p>A value that describes the current state of the table restore request.</p>
|
|
837
|
-
*
|
|
838
|
+
* <p>Valid Values: <code>SUCCEEDED</code>, <code>FAILED</code>, <code>CANCELED</code>,
|
|
838
839
|
* <code>PENDING</code>, <code>IN_PROGRESS</code>
|
|
839
|
-
*
|
|
840
|
+
* </p>
|
|
840
841
|
*/
|
|
841
842
|
Status?: TableRestoreStatusType | string;
|
|
842
843
|
/**
|
|
@@ -916,39 +917,39 @@ export interface DescribeTagsMessage {
|
|
|
916
917
|
ResourceName?: string;
|
|
917
918
|
/**
|
|
918
919
|
* <p>The type of resource with which you want to view tags. Valid resource types are: </p>
|
|
919
|
-
*
|
|
920
|
+
* <ul>
|
|
920
921
|
* <li>
|
|
921
|
-
*
|
|
922
|
+
* <p>Cluster</p>
|
|
922
923
|
* </li>
|
|
923
924
|
* <li>
|
|
924
|
-
*
|
|
925
|
+
* <p>CIDR/IP</p>
|
|
925
926
|
* </li>
|
|
926
927
|
* <li>
|
|
927
|
-
*
|
|
928
|
+
* <p>EC2 security group</p>
|
|
928
929
|
* </li>
|
|
929
930
|
* <li>
|
|
930
|
-
*
|
|
931
|
+
* <p>Snapshot</p>
|
|
931
932
|
* </li>
|
|
932
933
|
* <li>
|
|
933
|
-
*
|
|
934
|
+
* <p>Cluster security group</p>
|
|
934
935
|
* </li>
|
|
935
936
|
* <li>
|
|
936
|
-
*
|
|
937
|
+
* <p>Subnet group</p>
|
|
937
938
|
* </li>
|
|
938
939
|
* <li>
|
|
939
|
-
*
|
|
940
|
+
* <p>HSM connection</p>
|
|
940
941
|
* </li>
|
|
941
942
|
* <li>
|
|
942
|
-
*
|
|
943
|
+
* <p>HSM certificate</p>
|
|
943
944
|
* </li>
|
|
944
945
|
* <li>
|
|
945
|
-
*
|
|
946
|
+
* <p>Parameter group</p>
|
|
946
947
|
* </li>
|
|
947
948
|
* <li>
|
|
948
|
-
*
|
|
949
|
+
* <p>Snapshot copy grant</p>
|
|
949
950
|
* </li>
|
|
950
951
|
* </ul>
|
|
951
|
-
*
|
|
952
|
+
* <p>For more information about Amazon Redshift resource types and constructing ARNs, go to
|
|
952
953
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions">Specifying Policy Elements: Actions, Effects, Resources, and Principals</a> in
|
|
953
954
|
* the Amazon Redshift Cluster Management Guide. </p>
|
|
954
955
|
*/
|
|
@@ -1001,36 +1002,36 @@ export interface TaggedResource {
|
|
|
1001
1002
|
ResourceName?: string;
|
|
1002
1003
|
/**
|
|
1003
1004
|
* <p>The type of resource with which the tag is associated. Valid resource types are: </p>
|
|
1004
|
-
*
|
|
1005
|
+
* <ul>
|
|
1005
1006
|
* <li>
|
|
1006
|
-
*
|
|
1007
|
+
* <p>Cluster</p>
|
|
1007
1008
|
* </li>
|
|
1008
1009
|
* <li>
|
|
1009
|
-
*
|
|
1010
|
+
* <p>CIDR/IP</p>
|
|
1010
1011
|
* </li>
|
|
1011
1012
|
* <li>
|
|
1012
|
-
*
|
|
1013
|
+
* <p>EC2 security group</p>
|
|
1013
1014
|
* </li>
|
|
1014
1015
|
* <li>
|
|
1015
|
-
*
|
|
1016
|
+
* <p>Snapshot</p>
|
|
1016
1017
|
* </li>
|
|
1017
1018
|
* <li>
|
|
1018
|
-
*
|
|
1019
|
+
* <p>Cluster security group</p>
|
|
1019
1020
|
* </li>
|
|
1020
1021
|
* <li>
|
|
1021
|
-
*
|
|
1022
|
+
* <p>Subnet group</p>
|
|
1022
1023
|
* </li>
|
|
1023
1024
|
* <li>
|
|
1024
|
-
*
|
|
1025
|
+
* <p>HSM connection</p>
|
|
1025
1026
|
* </li>
|
|
1026
1027
|
* <li>
|
|
1027
|
-
*
|
|
1028
|
+
* <p>HSM certificate</p>
|
|
1028
1029
|
* </li>
|
|
1029
1030
|
* <li>
|
|
1030
|
-
*
|
|
1031
|
+
* <p>Parameter group</p>
|
|
1031
1032
|
* </li>
|
|
1032
1033
|
* </ul>
|
|
1033
|
-
*
|
|
1034
|
+
* <p>For more information about Amazon Redshift resource types and constructing ARNs, go to
|
|
1034
1035
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions">Constructing an Amazon Redshift Amazon Resource Name (ARN)</a> in the
|
|
1035
1036
|
* Amazon Redshift Cluster Management Guide. </p>
|
|
1036
1037
|
*/
|
|
@@ -1071,9 +1072,9 @@ export interface DescribeUsageLimitsMessage {
|
|
|
1071
1072
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1072
1073
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
1073
1074
|
* set of records by retrying the command with the returned marker value. </p>
|
|
1074
|
-
*
|
|
1075
|
-
*
|
|
1076
|
-
*
|
|
1075
|
+
* <p>Default: <code>100</code>
|
|
1076
|
+
* </p>
|
|
1077
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
1077
1078
|
*/
|
|
1078
1079
|
MaxRecords?: number;
|
|
1079
1080
|
/**
|
|
@@ -1125,8 +1126,8 @@ export interface UsageLimitList {
|
|
|
1125
1126
|
export interface DisableLoggingMessage {
|
|
1126
1127
|
/**
|
|
1127
1128
|
* <p>The identifier of the cluster on which logging is to be stopped.</p>
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1129
|
+
* <p>Example: <code>examplecluster</code>
|
|
1130
|
+
* </p>
|
|
1130
1131
|
*/
|
|
1131
1132
|
ClusterIdentifier: string | undefined;
|
|
1132
1133
|
}
|
|
@@ -1137,7 +1138,7 @@ export interface DisableSnapshotCopyMessage {
|
|
|
1137
1138
|
/**
|
|
1138
1139
|
* <p>The unique identifier of the source cluster that you want to disable copying of
|
|
1139
1140
|
* snapshots to a destination region.</p>
|
|
1140
|
-
*
|
|
1141
|
+
* <p>Constraints: Must be the valid name of an existing cluster that has cross-region
|
|
1141
1142
|
* snapshot copy enabled.</p>
|
|
1142
1143
|
*/
|
|
1143
1144
|
ClusterIdentifier: string | undefined;
|
|
@@ -1185,49 +1186,49 @@ export interface DisassociateDataShareConsumerMessage {
|
|
|
1185
1186
|
export interface EnableLoggingMessage {
|
|
1186
1187
|
/**
|
|
1187
1188
|
* <p>The identifier of the cluster on which logging is to be started.</p>
|
|
1188
|
-
*
|
|
1189
|
-
*
|
|
1189
|
+
* <p>Example: <code>examplecluster</code>
|
|
1190
|
+
* </p>
|
|
1190
1191
|
*/
|
|
1191
1192
|
ClusterIdentifier: string | undefined;
|
|
1192
1193
|
/**
|
|
1193
1194
|
* <p>The name of an existing S3 bucket where the log files are to be stored.</p>
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1195
|
+
* <p>Constraints:</p>
|
|
1196
|
+
* <ul>
|
|
1196
1197
|
* <li>
|
|
1197
|
-
*
|
|
1198
|
+
* <p>Must be in the same region as the cluster</p>
|
|
1198
1199
|
* </li>
|
|
1199
1200
|
* <li>
|
|
1200
|
-
*
|
|
1201
|
+
* <p>The cluster must have read bucket and put object permissions</p>
|
|
1201
1202
|
* </li>
|
|
1202
1203
|
* </ul>
|
|
1203
1204
|
*/
|
|
1204
1205
|
BucketName?: string;
|
|
1205
1206
|
/**
|
|
1206
1207
|
* <p>The prefix applied to the log file names.</p>
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1208
|
+
* <p>Constraints:</p>
|
|
1209
|
+
* <ul>
|
|
1209
1210
|
* <li>
|
|
1210
|
-
*
|
|
1211
|
+
* <p>Cannot exceed 512 characters</p>
|
|
1211
1212
|
* </li>
|
|
1212
1213
|
* <li>
|
|
1213
|
-
*
|
|
1214
|
+
* <p>Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash
|
|
1214
1215
|
* (\), or control characters. The hexadecimal codes for invalid characters are: </p>
|
|
1215
|
-
*
|
|
1216
|
+
* <ul>
|
|
1216
1217
|
* <li>
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1218
|
+
* <p>x00 to x20</p>
|
|
1219
|
+
* </li>
|
|
1219
1220
|
* <li>
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1221
|
+
* <p>x22</p>
|
|
1222
|
+
* </li>
|
|
1222
1223
|
* <li>
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
1224
|
+
* <p>x27</p>
|
|
1225
|
+
* </li>
|
|
1225
1226
|
* <li>
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1227
|
+
* <p>x5c</p>
|
|
1228
|
+
* </li>
|
|
1228
1229
|
* <li>
|
|
1229
|
-
*
|
|
1230
|
-
*
|
|
1230
|
+
* <p>x7f or larger</p>
|
|
1231
|
+
* </li>
|
|
1231
1232
|
* </ul>
|
|
1232
1233
|
* </li>
|
|
1233
1234
|
* </ul>
|
|
@@ -1238,7 +1239,7 @@ export interface EnableLoggingMessage {
|
|
|
1238
1239
|
*/
|
|
1239
1240
|
LogDestinationType?: LogDestinationType | string;
|
|
1240
1241
|
/**
|
|
1241
|
-
* <p>The collection of exported log types.
|
|
1242
|
+
* <p>The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>.</p>
|
|
1242
1243
|
*/
|
|
1243
1244
|
LogExports?: string[];
|
|
1244
1245
|
}
|
|
@@ -1286,13 +1287,13 @@ export declare class InvalidS3KeyPrefixFault extends __BaseException {
|
|
|
1286
1287
|
export interface EnableSnapshotCopyMessage {
|
|
1287
1288
|
/**
|
|
1288
1289
|
* <p>The unique identifier of the source cluster to copy snapshots from.</p>
|
|
1289
|
-
*
|
|
1290
|
+
* <p>Constraints: Must be the valid name of an existing cluster that does not already
|
|
1290
1291
|
* have cross-region snapshot copy enabled.</p>
|
|
1291
1292
|
*/
|
|
1292
1293
|
ClusterIdentifier: string | undefined;
|
|
1293
1294
|
/**
|
|
1294
1295
|
* <p>The destination Amazon Web Services Region that you want to copy snapshots to.</p>
|
|
1295
|
-
*
|
|
1296
|
+
* <p>Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see
|
|
1296
1297
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.
|
|
1297
1298
|
* </p>
|
|
1298
1299
|
*/
|
|
@@ -1300,8 +1301,8 @@ export interface EnableSnapshotCopyMessage {
|
|
|
1300
1301
|
/**
|
|
1301
1302
|
* <p>The number of days to retain automated snapshots in the destination region after
|
|
1302
1303
|
* they are copied from the source region.</p>
|
|
1303
|
-
*
|
|
1304
|
-
*
|
|
1304
|
+
* <p>Default: 7.</p>
|
|
1305
|
+
* <p>Constraints: Must be at least 1 and no more than 35.</p>
|
|
1305
1306
|
*/
|
|
1306
1307
|
RetentionPeriod?: number;
|
|
1307
1308
|
/**
|
|
@@ -1313,7 +1314,7 @@ export interface EnableSnapshotCopyMessage {
|
|
|
1313
1314
|
* <p>The number of days to retain newly copied snapshots in the destination Amazon Web Services Region
|
|
1314
1315
|
* after they are copied from the source Amazon Web Services Region. If the value is -1, the manual
|
|
1315
1316
|
* snapshot is retained indefinitely. </p>
|
|
1316
|
-
*
|
|
1317
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
1317
1318
|
*/
|
|
1318
1319
|
ManualSnapshotRetentionPeriod?: number;
|
|
1319
1320
|
}
|
|
@@ -1380,26 +1381,26 @@ export interface GetClusterCredentialsMessage {
|
|
|
1380
1381
|
* doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command
|
|
1381
1382
|
* succeeds but the connection attempt will fail because the user doesn't exist in the
|
|
1382
1383
|
* database.</p>
|
|
1383
|
-
*
|
|
1384
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon
|
|
1384
1385
|
* Redshift Database Developer Guide. </p>
|
|
1385
|
-
*
|
|
1386
|
-
*
|
|
1386
|
+
* <p>Constraints:</p>
|
|
1387
|
+
* <ul>
|
|
1387
1388
|
* <li>
|
|
1388
|
-
*
|
|
1389
|
+
* <p>Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be
|
|
1389
1390
|
* <code>PUBLIC</code>.</p>
|
|
1390
1391
|
* </li>
|
|
1391
1392
|
* <li>
|
|
1392
|
-
*
|
|
1393
|
+
* <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
|
|
1393
1394
|
* (dot), at symbol (@), or hyphen.</p>
|
|
1394
1395
|
* </li>
|
|
1395
1396
|
* <li>
|
|
1396
|
-
*
|
|
1397
|
+
* <p>First character must be a letter.</p>
|
|
1397
1398
|
* </li>
|
|
1398
1399
|
* <li>
|
|
1399
|
-
*
|
|
1400
|
+
* <p>Must not contain a colon ( : ) or slash ( / ). </p>
|
|
1400
1401
|
* </li>
|
|
1401
1402
|
* <li>
|
|
1402
|
-
*
|
|
1403
|
+
* <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon
|
|
1403
1404
|
* Redshift Database Developer Guide.</p>
|
|
1404
1405
|
* </li>
|
|
1405
1406
|
* </ul>
|
|
@@ -1409,23 +1410,23 @@ export interface GetClusterCredentialsMessage {
|
|
|
1409
1410
|
* <p>The name of a database that <code>DbUser</code> is authorized to log on to. If
|
|
1410
1411
|
* <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing
|
|
1411
1412
|
* database.</p>
|
|
1412
|
-
*
|
|
1413
|
-
*
|
|
1413
|
+
* <p>Constraints:</p>
|
|
1414
|
+
* <ul>
|
|
1414
1415
|
* <li>
|
|
1415
|
-
*
|
|
1416
|
+
* <p>Must be 1 to 64 alphanumeric characters or hyphens</p>
|
|
1416
1417
|
* </li>
|
|
1417
1418
|
* <li>
|
|
1418
|
-
*
|
|
1419
|
+
* <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
|
|
1419
1420
|
* (dot), at symbol (@), or hyphen.</p>
|
|
1420
1421
|
* </li>
|
|
1421
1422
|
* <li>
|
|
1422
|
-
*
|
|
1423
|
+
* <p>First character must be a letter.</p>
|
|
1423
1424
|
* </li>
|
|
1424
1425
|
* <li>
|
|
1425
|
-
*
|
|
1426
|
+
* <p>Must not contain a colon ( : ) or slash ( / ). </p>
|
|
1426
1427
|
* </li>
|
|
1427
1428
|
* <li>
|
|
1428
|
-
*
|
|
1429
|
+
* <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon
|
|
1429
1430
|
* Redshift Database Developer Guide.</p>
|
|
1430
1431
|
* </li>
|
|
1431
1432
|
* </ul>
|
|
@@ -1438,8 +1439,8 @@ export interface GetClusterCredentialsMessage {
|
|
|
1438
1439
|
ClusterIdentifier: string | undefined;
|
|
1439
1440
|
/**
|
|
1440
1441
|
* <p>The number of seconds until the returned temporary password expires.</p>
|
|
1441
|
-
*
|
|
1442
|
-
*
|
|
1442
|
+
* <p>Constraint: minimum 900, maximum 3600.</p>
|
|
1443
|
+
* <p>Default: 900</p>
|
|
1443
1444
|
*/
|
|
1444
1445
|
DurationSeconds?: number;
|
|
1445
1446
|
/**
|
|
@@ -1452,23 +1453,23 @@ export interface GetClusterCredentialsMessage {
|
|
|
1452
1453
|
* <code>DbUser</code> will join for the current session, in addition to any group
|
|
1453
1454
|
* memberships for an existing user. If not specified, a new user is added only to
|
|
1454
1455
|
* PUBLIC.</p>
|
|
1455
|
-
*
|
|
1456
|
-
*
|
|
1456
|
+
* <p>Database group name constraints</p>
|
|
1457
|
+
* <ul>
|
|
1457
1458
|
* <li>
|
|
1458
|
-
*
|
|
1459
|
+
* <p>Must be 1 to 64 alphanumeric characters or hyphens</p>
|
|
1459
1460
|
* </li>
|
|
1460
1461
|
* <li>
|
|
1461
|
-
*
|
|
1462
|
+
* <p>Must contain only lowercase letters, numbers, underscore, plus sign, period
|
|
1462
1463
|
* (dot), at symbol (@), or hyphen.</p>
|
|
1463
1464
|
* </li>
|
|
1464
1465
|
* <li>
|
|
1465
|
-
*
|
|
1466
|
+
* <p>First character must be a letter.</p>
|
|
1466
1467
|
* </li>
|
|
1467
1468
|
* <li>
|
|
1468
|
-
*
|
|
1469
|
+
* <p>Must not contain a colon ( : ) or slash ( / ). </p>
|
|
1469
1470
|
* </li>
|
|
1470
1471
|
* <li>
|
|
1471
|
-
*
|
|
1472
|
+
* <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon
|
|
1472
1473
|
* Redshift Database Developer Guide.</p>
|
|
1473
1474
|
* </li>
|
|
1474
1475
|
* </ul>
|
|
@@ -1489,7 +1490,7 @@ export interface GetClusterCredentialsWithIAMMessage {
|
|
|
1489
1490
|
ClusterIdentifier: string | undefined;
|
|
1490
1491
|
/**
|
|
1491
1492
|
* <p>The number of seconds until the returned temporary password expires.</p>
|
|
1492
|
-
*
|
|
1493
|
+
* <p>Range: 900-3600. Default: 900.</p>
|
|
1493
1494
|
*/
|
|
1494
1495
|
DurationSeconds?: number;
|
|
1495
1496
|
}
|
|
@@ -1672,29 +1673,28 @@ export interface ModifyAuthenticationProfileResult {
|
|
|
1672
1673
|
export interface ModifyClusterMessage {
|
|
1673
1674
|
/**
|
|
1674
1675
|
* <p>The unique identifier of the cluster to be modified.</p>
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1676
|
+
* <p>Example: <code>examplecluster</code>
|
|
1677
|
+
* </p>
|
|
1677
1678
|
*/
|
|
1678
1679
|
ClusterIdentifier: string | undefined;
|
|
1679
1680
|
/**
|
|
1680
1681
|
* <p>The new cluster type.</p>
|
|
1681
|
-
*
|
|
1682
|
+
* <p>When you submit your cluster resize request, your existing cluster goes into a
|
|
1682
1683
|
* read-only mode. After Amazon Redshift provisions a new cluster based on your resize
|
|
1683
1684
|
* requirements, there will be outage for a period while the old cluster is deleted and
|
|
1684
1685
|
* your connection is switched to the new cluster. You can use <a>DescribeResize</a> to track the progress of the resize request. </p>
|
|
1685
|
-
*
|
|
1686
|
-
*
|
|
1686
|
+
* <p>Valid Values: <code> multi-node | single-node </code>
|
|
1687
|
+
* </p>
|
|
1687
1688
|
*/
|
|
1688
1689
|
ClusterType?: string;
|
|
1689
1690
|
/**
|
|
1690
1691
|
* <p>The new node type of the cluster. If you specify a new node type, you must also
|
|
1691
1692
|
* specify the number of nodes parameter.</p>
|
|
1692
|
-
*
|
|
1693
|
+
* <p>
|
|
1693
1694
|
* For more information about resizing clusters, go to
|
|
1694
1695
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a>
|
|
1695
1696
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
1696
|
-
*
|
|
1697
|
-
* <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> |
|
|
1697
|
+
* <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> |
|
|
1698
1698
|
* <code>dc1.large</code> | <code>dc1.8xlarge</code> |
|
|
1699
1699
|
* <code>dc2.large</code> | <code>dc2.8xlarge</code> |
|
|
1700
1700
|
* <code>ra3.xlplus</code> | <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code>
|
|
@@ -1704,29 +1704,28 @@ export interface ModifyClusterMessage {
|
|
|
1704
1704
|
/**
|
|
1705
1705
|
* <p>The new number of nodes of the cluster. If you specify a new number of nodes, you
|
|
1706
1706
|
* must also specify the node type parameter.</p>
|
|
1707
|
-
*
|
|
1707
|
+
* <p>
|
|
1708
1708
|
* For more information about resizing clusters, go to
|
|
1709
1709
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a>
|
|
1710
1710
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
1711
|
-
*
|
|
1712
|
-
* <p>Valid Values: Integer greater than <code>0</code>.</p>
|
|
1711
|
+
* <p>Valid Values: Integer greater than <code>0</code>.</p>
|
|
1713
1712
|
*/
|
|
1714
1713
|
NumberOfNodes?: number;
|
|
1715
1714
|
/**
|
|
1716
1715
|
* <p>A list of cluster security groups to be authorized on this cluster. This change is
|
|
1717
1716
|
* asynchronously applied as soon as possible.</p>
|
|
1718
|
-
*
|
|
1717
|
+
* <p>Security groups currently associated with the cluster, and not in the list of
|
|
1719
1718
|
* groups to apply, will be revoked from the cluster.</p>
|
|
1720
|
-
*
|
|
1721
|
-
*
|
|
1719
|
+
* <p>Constraints:</p>
|
|
1720
|
+
* <ul>
|
|
1722
1721
|
* <li>
|
|
1723
|
-
*
|
|
1722
|
+
* <p>Must be 1 to 255 alphanumeric characters or hyphens</p>
|
|
1724
1723
|
* </li>
|
|
1725
1724
|
* <li>
|
|
1726
|
-
*
|
|
1725
|
+
* <p>First character must be a letter</p>
|
|
1727
1726
|
* </li>
|
|
1728
1727
|
* <li>
|
|
1729
|
-
*
|
|
1728
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p>
|
|
1730
1729
|
* </li>
|
|
1731
1730
|
* </ul>
|
|
1732
1731
|
*/
|
|
@@ -1741,28 +1740,28 @@ export interface ModifyClusterMessage {
|
|
|
1741
1740
|
* as soon as possible. Between the time of the request and the completion of the request,
|
|
1742
1741
|
* the <code>MasterUserPassword</code> element exists in the
|
|
1743
1742
|
* <code>PendingModifiedValues</code> element of the operation response. </p>
|
|
1744
|
-
*
|
|
1743
|
+
* <note>
|
|
1745
1744
|
* <p>Operations never return the password, so this operation provides a way to
|
|
1746
1745
|
* regain access to the admin user account for a cluster if the password is
|
|
1747
1746
|
* lost.</p>
|
|
1748
|
-
*
|
|
1749
|
-
*
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
1747
|
+
* </note>
|
|
1748
|
+
* <p>Default: Uses existing setting.</p>
|
|
1749
|
+
* <p>Constraints:</p>
|
|
1750
|
+
* <ul>
|
|
1752
1751
|
* <li>
|
|
1753
|
-
*
|
|
1752
|
+
* <p>Must be between 8 and 64 characters in length.</p>
|
|
1754
1753
|
* </li>
|
|
1755
1754
|
* <li>
|
|
1756
|
-
*
|
|
1755
|
+
* <p>Must contain at least one uppercase letter.</p>
|
|
1757
1756
|
* </li>
|
|
1758
1757
|
* <li>
|
|
1759
|
-
*
|
|
1758
|
+
* <p>Must contain at least one lowercase letter.</p>
|
|
1760
1759
|
* </li>
|
|
1761
1760
|
* <li>
|
|
1762
|
-
*
|
|
1761
|
+
* <p>Must contain one number.</p>
|
|
1763
1762
|
* </li>
|
|
1764
1763
|
* <li>
|
|
1765
|
-
*
|
|
1764
|
+
* <p>Can be any printable ASCII character (ASCII code 33-126) except <code>'</code>
|
|
1766
1765
|
* (single quote), <code>"</code> (double quote), <code>\</code>, <code>/</code>, or <code>@</code>.</p>
|
|
1767
1766
|
* </li>
|
|
1768
1767
|
* </ul>
|
|
@@ -1771,8 +1770,8 @@ export interface ModifyClusterMessage {
|
|
|
1771
1770
|
/**
|
|
1772
1771
|
* <p>The name of the cluster parameter group to apply to this cluster. This change is
|
|
1773
1772
|
* applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. </p>
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1773
|
+
* <p>Default: Uses existing setting.</p>
|
|
1774
|
+
* <p>Constraints: The cluster parameter group must be in the same parameter group family
|
|
1776
1775
|
* that matches the cluster version.</p>
|
|
1777
1776
|
*/
|
|
1778
1777
|
ClusterParameterGroupName?: string;
|
|
@@ -1780,55 +1779,54 @@ export interface ModifyClusterMessage {
|
|
|
1780
1779
|
* <p>The number of days that automated snapshots are retained. If the value is 0,
|
|
1781
1780
|
* automated snapshots are disabled. Even if automated snapshots are disabled, you can
|
|
1782
1781
|
* still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
|
|
1783
|
-
*
|
|
1782
|
+
* <p>If you decrease the automated snapshot retention period from its current value,
|
|
1784
1783
|
* existing automated snapshots that fall outside of the new retention period will be
|
|
1785
1784
|
* immediately deleted.</p>
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
* <p>Constraints: Must be a value from 0 to 35.</p>
|
|
1785
|
+
* <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p>
|
|
1786
|
+
* <p>Default: Uses existing setting.</p>
|
|
1787
|
+
* <p>Constraints: Must be a value from 0 to 35.</p>
|
|
1790
1788
|
*/
|
|
1791
1789
|
AutomatedSnapshotRetentionPeriod?: number;
|
|
1792
1790
|
/**
|
|
1793
1791
|
* <p>The default for number of days that a newly created manual snapshot is retained. If
|
|
1794
1792
|
* the value is -1, the manual snapshot is retained indefinitely. This value doesn't
|
|
1795
1793
|
* retroactively change the retention periods of existing manual snapshots.</p>
|
|
1796
|
-
*
|
|
1797
|
-
*
|
|
1794
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
1795
|
+
* <p>The default value is -1.</p>
|
|
1798
1796
|
*/
|
|
1799
1797
|
ManualSnapshotRetentionPeriod?: number;
|
|
1800
1798
|
/**
|
|
1801
1799
|
* <p>The weekly time range (in UTC) during which system maintenance can occur, if
|
|
1802
1800
|
* necessary. If system maintenance is necessary during the window, it may result in an
|
|
1803
1801
|
* outage.</p>
|
|
1804
|
-
*
|
|
1802
|
+
* <p>This maintenance window change is made immediately. If the new maintenance window
|
|
1805
1803
|
* indicates the current time, there must be at least 120 minutes between the current time
|
|
1806
1804
|
* and end of the window in order to ensure that pending changes are applied.</p>
|
|
1807
|
-
*
|
|
1808
|
-
*
|
|
1805
|
+
* <p>Default: Uses existing setting.</p>
|
|
1806
|
+
* <p>Format: ddd:hh24:mi-ddd:hh24:mi, for example
|
|
1809
1807
|
* <code>wed:07:30-wed:08:00</code>.</p>
|
|
1810
|
-
*
|
|
1811
|
-
*
|
|
1808
|
+
* <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p>
|
|
1809
|
+
* <p>Constraints: Must be at least 30 minutes.</p>
|
|
1812
1810
|
*/
|
|
1813
1811
|
PreferredMaintenanceWindow?: string;
|
|
1814
1812
|
/**
|
|
1815
1813
|
* <p>The new version number of the Amazon Redshift engine to upgrade to.</p>
|
|
1816
|
-
*
|
|
1814
|
+
* <p>For major version upgrades, if a non-default cluster parameter group is currently
|
|
1817
1815
|
* in use, a new cluster parameter group in the cluster parameter group family for the new
|
|
1818
1816
|
* version must be specified. The new cluster parameter group can be the default for that
|
|
1819
1817
|
* cluster parameter group family.
|
|
1820
1818
|
* For more information about parameters and parameter groups, go to
|
|
1821
1819
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
1822
1820
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
1823
|
-
*
|
|
1824
|
-
*
|
|
1821
|
+
* <p>Example: <code>1.0</code>
|
|
1822
|
+
* </p>
|
|
1825
1823
|
*/
|
|
1826
1824
|
ClusterVersion?: string;
|
|
1827
1825
|
/**
|
|
1828
1826
|
* <p>If <code>true</code>, major version upgrades will be applied automatically to the
|
|
1829
1827
|
* cluster during the maintenance window. </p>
|
|
1830
|
-
*
|
|
1831
|
-
*
|
|
1828
|
+
* <p>Default: <code>false</code>
|
|
1829
|
+
* </p>
|
|
1832
1830
|
*/
|
|
1833
1831
|
AllowVersionUpgrade?: boolean;
|
|
1834
1832
|
/**
|
|
@@ -1861,9 +1859,8 @@ export interface ModifyClusterMessage {
|
|
|
1861
1859
|
* <p>Must be unique for all clusters within an Amazon Web Services account.</p>
|
|
1862
1860
|
* </li>
|
|
1863
1861
|
* </ul>
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1866
|
-
* </p>
|
|
1862
|
+
* <p>Example: <code>examplecluster</code>
|
|
1863
|
+
* </p>
|
|
1867
1864
|
*/
|
|
1868
1865
|
NewClusterIdentifier?: string;
|
|
1869
1866
|
/**
|
|
@@ -1873,7 +1870,7 @@ export interface ModifyClusterMessage {
|
|
|
1873
1870
|
PubliclyAccessible?: boolean;
|
|
1874
1871
|
/**
|
|
1875
1872
|
* <p>The Elastic IP (EIP) address for the cluster.</p>
|
|
1876
|
-
*
|
|
1873
|
+
* <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible
|
|
1877
1874
|
* through an Internet gateway. For more information about provisioning clusters in
|
|
1878
1875
|
* EC2-VPC, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported
|
|
1879
1876
|
* Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide.</p>
|
|
@@ -1884,8 +1881,8 @@ export interface ModifyClusterMessage {
|
|
|
1884
1881
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
1885
1882
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
1886
1883
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
1887
|
-
*
|
|
1888
|
-
*
|
|
1884
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
1885
|
+
* <p>Default: false</p>
|
|
1889
1886
|
*/
|
|
1890
1887
|
EnhancedVpcRouting?: boolean;
|
|
1891
1888
|
/**
|
|
@@ -1902,7 +1899,7 @@ export interface ModifyClusterMessage {
|
|
|
1902
1899
|
* provide a value for the <code>KmsKeyId</code> parameter, we encrypt the cluster
|
|
1903
1900
|
* with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>,
|
|
1904
1901
|
* we encrypt with the default key. </p>
|
|
1905
|
-
*
|
|
1902
|
+
* <p>If the value is not encrypted (false), then the cluster is decrypted. </p>
|
|
1906
1903
|
*/
|
|
1907
1904
|
Encrypted?: boolean;
|
|
1908
1905
|
/**
|
|
@@ -1955,8 +1952,8 @@ export declare class UnsupportedOptionFault extends __BaseException {
|
|
|
1955
1952
|
export interface ModifyClusterDbRevisionMessage {
|
|
1956
1953
|
/**
|
|
1957
1954
|
* <p>The unique identifier of a cluster whose database revision you want to modify. </p>
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1955
|
+
* <p>Example: <code>examplecluster</code>
|
|
1956
|
+
* </p>
|
|
1960
1957
|
*/
|
|
1961
1958
|
ClusterIdentifier: string | undefined;
|
|
1962
1959
|
/**
|
|
@@ -2045,9 +2042,9 @@ export interface ModifyClusterParameterGroupMessage {
|
|
|
2045
2042
|
/**
|
|
2046
2043
|
* <p>An array of parameters to be modified. A maximum of 20 parameters can be modified
|
|
2047
2044
|
* in a single request.</p>
|
|
2048
|
-
*
|
|
2045
|
+
* <p>For each parameter to be modified, you must supply at least the parameter name and
|
|
2049
2046
|
* parameter value; other name-value pairs of the parameter are optional.</p>
|
|
2050
|
-
*
|
|
2047
|
+
* <p>For the workload management (WLM) configuration, you must supply all the name-value
|
|
2051
2048
|
* pairs in the wlm_json_configuration parameter.</p>
|
|
2052
2049
|
*/
|
|
2053
2050
|
Parameters: Parameter[] | undefined;
|
|
@@ -2060,9 +2057,9 @@ export interface ModifyClusterSnapshotMessage {
|
|
|
2060
2057
|
/**
|
|
2061
2058
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
2062
2059
|
* snapshot is retained indefinitely.</p>
|
|
2063
|
-
*
|
|
2060
|
+
* <p>If the manual snapshot falls outside of the new retention period, you can specify the
|
|
2064
2061
|
* force option to immediately delete the snapshot.</p>
|
|
2065
|
-
*
|
|
2062
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
2066
2063
|
*/
|
|
2067
2064
|
ManualSnapshotRetentionPeriod?: number;
|
|
2068
2065
|
/**
|
|
@@ -2157,7 +2154,7 @@ export interface ModifyEventSubscriptionMessage {
|
|
|
2157
2154
|
* be notified of events generated by a cluster, you would set this parameter to cluster.
|
|
2158
2155
|
* If this value is not specified, events are returned for all Amazon Redshift objects in your
|
|
2159
2156
|
* Amazon Web Services account. You must specify a source type in order to specify source IDs.</p>
|
|
2160
|
-
*
|
|
2157
|
+
* <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.</p>
|
|
2161
2158
|
*/
|
|
2162
2159
|
SourceType?: string;
|
|
2163
2160
|
/**
|
|
@@ -2166,20 +2163,20 @@ export interface ModifyEventSubscriptionMessage {
|
|
|
2166
2163
|
* subscription will return only events generated by the specified objects. If not
|
|
2167
2164
|
* specified, then events are returned for all objects within the source type
|
|
2168
2165
|
* specified.</p>
|
|
2169
|
-
*
|
|
2170
|
-
*
|
|
2166
|
+
* <p>Example: my-cluster-1, my-cluster-2</p>
|
|
2167
|
+
* <p>Example: my-snapshot-20131010</p>
|
|
2171
2168
|
*/
|
|
2172
2169
|
SourceIds?: string[];
|
|
2173
2170
|
/**
|
|
2174
2171
|
* <p>Specifies the Amazon Redshift event categories to be published by the event notification
|
|
2175
2172
|
* subscription.</p>
|
|
2176
|
-
*
|
|
2173
|
+
* <p>Values: configuration, management, monitoring, security, pending</p>
|
|
2177
2174
|
*/
|
|
2178
2175
|
EventCategories?: string[];
|
|
2179
2176
|
/**
|
|
2180
2177
|
* <p>Specifies the Amazon Redshift event severity to be published by the event notification
|
|
2181
2178
|
* subscription.</p>
|
|
2182
|
-
*
|
|
2179
|
+
* <p>Values: ERROR, INFO</p>
|
|
2183
2180
|
*/
|
|
2184
2181
|
Severity?: string;
|
|
2185
2182
|
/**
|
|
@@ -2240,24 +2237,24 @@ export interface ModifySnapshotCopyRetentionPeriodMessage {
|
|
|
2240
2237
|
/**
|
|
2241
2238
|
* <p>The unique identifier of the cluster for which you want to change the retention
|
|
2242
2239
|
* period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.</p>
|
|
2243
|
-
*
|
|
2240
|
+
* <p>Constraints: Must be the valid name of an existing cluster that has cross-region
|
|
2244
2241
|
* snapshot copy enabled.</p>
|
|
2245
2242
|
*/
|
|
2246
2243
|
ClusterIdentifier: string | undefined;
|
|
2247
2244
|
/**
|
|
2248
2245
|
* <p>The number of days to retain automated snapshots in the destination Amazon Web Services Region
|
|
2249
2246
|
* after they are copied from the source Amazon Web Services Region.</p>
|
|
2250
|
-
*
|
|
2251
|
-
*
|
|
2247
|
+
* <p>By default, this only changes the retention period of copied automated snapshots. </p>
|
|
2248
|
+
* <p>If you decrease the retention period for automated snapshots that are copied to a
|
|
2252
2249
|
* destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were
|
|
2253
2250
|
* copied to the destination Amazon Web Services Region and that fall outside of the new retention
|
|
2254
2251
|
* period.</p>
|
|
2255
|
-
*
|
|
2256
|
-
*
|
|
2252
|
+
* <p>Constraints: Must be at least 1 and no more than 35 for automated snapshots. </p>
|
|
2253
|
+
* <p>If you specify the <code>manual</code> option, only newly copied manual snapshots will
|
|
2257
2254
|
* have the new retention period. </p>
|
|
2258
|
-
*
|
|
2255
|
+
* <p>If you specify the value of -1 newly copied manual snapshots are retained
|
|
2259
2256
|
* indefinitely.</p>
|
|
2260
|
-
*
|
|
2257
|
+
* <p>Constraints: The number of days must be either -1 or an integer between 1 and 3,653
|
|
2261
2258
|
* for manual snapshots.</p>
|
|
2262
2259
|
*/
|
|
2263
2260
|
RetentionPeriod: number | undefined;
|
|
@@ -2339,8 +2336,8 @@ export interface PurchaseReservedNodeOfferingMessage {
|
|
|
2339
2336
|
ReservedNodeOfferingId: string | undefined;
|
|
2340
2337
|
/**
|
|
2341
2338
|
* <p>The number of reserved nodes that you want to purchase.</p>
|
|
2342
|
-
*
|
|
2343
|
-
*
|
|
2339
|
+
* <p>Default: <code>1</code>
|
|
2340
|
+
* </p>
|
|
2344
2341
|
*/
|
|
2345
2342
|
NodeCount?: number;
|
|
2346
2343
|
}
|
|
@@ -2397,15 +2394,15 @@ export interface ResetClusterParameterGroupMessage {
|
|
|
2397
2394
|
/**
|
|
2398
2395
|
* <p>If <code>true</code>, all parameters in the specified parameter group will be reset
|
|
2399
2396
|
* to their default values. </p>
|
|
2400
|
-
*
|
|
2401
|
-
*
|
|
2397
|
+
* <p>Default: <code>true</code>
|
|
2398
|
+
* </p>
|
|
2402
2399
|
*/
|
|
2403
2400
|
ResetAllParameters?: boolean;
|
|
2404
2401
|
/**
|
|
2405
2402
|
* <p>An array of names of parameters to be reset. If
|
|
2406
2403
|
* <i>ResetAllParameters</i> option is not used, then at least one
|
|
2407
2404
|
* parameter name must be supplied. </p>
|
|
2408
|
-
*
|
|
2405
|
+
* <p>Constraints: A maximum of 20 parameters can be reset in a single request.</p>
|
|
2409
2406
|
*/
|
|
2410
2407
|
Parameters?: Parameter[];
|
|
2411
2408
|
}
|
|
@@ -2444,13 +2441,13 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2444
2441
|
ClusterIdentifier: string | undefined;
|
|
2445
2442
|
/**
|
|
2446
2443
|
* <p>The name of the snapshot from which to create the new cluster. This parameter isn't
|
|
2447
|
-
* case sensitive. You
|
|
2448
|
-
*
|
|
2449
|
-
*
|
|
2444
|
+
* case sensitive. You must specify this parameter or <code>snapshotArn</code>, but not both.</p>
|
|
2445
|
+
* <p>Example: <code>my-snapshot-id</code>
|
|
2446
|
+
* </p>
|
|
2450
2447
|
*/
|
|
2451
2448
|
SnapshotIdentifier?: string;
|
|
2452
2449
|
/**
|
|
2453
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You
|
|
2450
|
+
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify
|
|
2454
2451
|
* this parameter or <code>snapshotIdentifier</code>, but not both.</p>
|
|
2455
2452
|
*/
|
|
2456
2453
|
SnapshotArn?: string;
|
|
@@ -2462,27 +2459,27 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2462
2459
|
SnapshotClusterIdentifier?: string;
|
|
2463
2460
|
/**
|
|
2464
2461
|
* <p>The port number on which the cluster accepts connections.</p>
|
|
2465
|
-
*
|
|
2466
|
-
*
|
|
2462
|
+
* <p>Default: The same port as the original cluster.</p>
|
|
2463
|
+
* <p>Constraints: Must be between <code>1115</code> and <code>65535</code>.</p>
|
|
2467
2464
|
*/
|
|
2468
2465
|
Port?: number;
|
|
2469
2466
|
/**
|
|
2470
2467
|
* <p>The Amazon EC2 Availability Zone in which to restore the cluster.</p>
|
|
2471
|
-
*
|
|
2472
|
-
*
|
|
2473
|
-
*
|
|
2468
|
+
* <p>Default: A random, system-chosen Availability Zone.</p>
|
|
2469
|
+
* <p>Example: <code>us-east-2a</code>
|
|
2470
|
+
* </p>
|
|
2474
2471
|
*/
|
|
2475
2472
|
AvailabilityZone?: string;
|
|
2476
2473
|
/**
|
|
2477
2474
|
* <p>If <code>true</code>, major version upgrades can be applied during the maintenance
|
|
2478
2475
|
* window to the Amazon Redshift engine that is running on the cluster. </p>
|
|
2479
|
-
*
|
|
2480
|
-
*
|
|
2476
|
+
* <p>Default: <code>true</code>
|
|
2477
|
+
* </p>
|
|
2481
2478
|
*/
|
|
2482
2479
|
AllowVersionUpgrade?: boolean;
|
|
2483
2480
|
/**
|
|
2484
2481
|
* <p>The name of the subnet group where you want to cluster restored.</p>
|
|
2485
|
-
*
|
|
2482
|
+
* <p>A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must
|
|
2486
2483
|
* provide subnet group name where you want the cluster restored.</p>
|
|
2487
2484
|
*/
|
|
2488
2485
|
ClusterSubnetGroupName?: string;
|
|
@@ -2512,63 +2509,62 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2512
2509
|
ElasticIp?: string;
|
|
2513
2510
|
/**
|
|
2514
2511
|
* <p>The name of the parameter group to be associated with this cluster.</p>
|
|
2515
|
-
*
|
|
2512
|
+
* <p>Default: The default Amazon Redshift cluster parameter group. For information about the
|
|
2516
2513
|
* default parameter group, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon
|
|
2517
2514
|
* Redshift Parameter Groups</a>.</p>
|
|
2518
|
-
*
|
|
2519
|
-
*
|
|
2515
|
+
* <p>Constraints:</p>
|
|
2516
|
+
* <ul>
|
|
2520
2517
|
* <li>
|
|
2521
|
-
*
|
|
2518
|
+
* <p>Must be 1 to 255 alphanumeric characters or hyphens.</p>
|
|
2522
2519
|
* </li>
|
|
2523
2520
|
* <li>
|
|
2524
|
-
*
|
|
2521
|
+
* <p>First character must be a letter.</p>
|
|
2525
2522
|
* </li>
|
|
2526
2523
|
* <li>
|
|
2527
|
-
*
|
|
2524
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
2528
2525
|
* </li>
|
|
2529
2526
|
* </ul>
|
|
2530
2527
|
*/
|
|
2531
2528
|
ClusterParameterGroupName?: string;
|
|
2532
2529
|
/**
|
|
2533
2530
|
* <p>A list of security groups to be associated with this cluster.</p>
|
|
2534
|
-
*
|
|
2535
|
-
*
|
|
2531
|
+
* <p>Default: The default cluster security group for Amazon Redshift.</p>
|
|
2532
|
+
* <p>Cluster security groups only apply to clusters outside of VPCs.</p>
|
|
2536
2533
|
*/
|
|
2537
2534
|
ClusterSecurityGroups?: string[];
|
|
2538
2535
|
/**
|
|
2539
2536
|
* <p>A list of Virtual Private Cloud (VPC) security groups to be associated with the
|
|
2540
2537
|
* cluster.</p>
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
2538
|
+
* <p>Default: The default VPC security group is associated with the cluster.</p>
|
|
2539
|
+
* <p>VPC security groups only apply to clusters in VPCs.</p>
|
|
2543
2540
|
*/
|
|
2544
2541
|
VpcSecurityGroupIds?: string[];
|
|
2545
2542
|
/**
|
|
2546
2543
|
* <p>The weekly time range (in UTC) during which automated cluster maintenance can
|
|
2547
2544
|
* occur.</p>
|
|
2548
|
-
*
|
|
2549
|
-
*
|
|
2550
|
-
*
|
|
2545
|
+
* <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
2546
|
+
* </p>
|
|
2547
|
+
* <p> Default: The value selected for the cluster from which the snapshot was taken. For
|
|
2551
2548
|
* more information about the time blocks for each region, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. </p>
|
|
2552
|
-
*
|
|
2553
|
-
*
|
|
2549
|
+
* <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p>
|
|
2550
|
+
* <p>Constraints: Minimum 30-minute window.</p>
|
|
2554
2551
|
*/
|
|
2555
2552
|
PreferredMaintenanceWindow?: string;
|
|
2556
2553
|
/**
|
|
2557
2554
|
* <p>The number of days that automated snapshots are retained. If the value is 0,
|
|
2558
2555
|
* automated snapshots are disabled. Even if automated snapshots are disabled, you can
|
|
2559
2556
|
* still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
2562
|
-
* <p>Default: The value selected for the cluster from which the snapshot was
|
|
2557
|
+
* <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p>
|
|
2558
|
+
* <p>Default: The value selected for the cluster from which the snapshot was
|
|
2563
2559
|
* taken.</p>
|
|
2564
|
-
*
|
|
2560
|
+
* <p>Constraints: Must be a value from 0 to 35.</p>
|
|
2565
2561
|
*/
|
|
2566
2562
|
AutomatedSnapshotRetentionPeriod?: number;
|
|
2567
2563
|
/**
|
|
2568
2564
|
* <p>The default number of days to retain a manual snapshot. If the value is -1, the
|
|
2569
2565
|
* snapshot is retained indefinitely. This setting doesn't change the retention period
|
|
2570
2566
|
* of existing snapshots.</p>
|
|
2571
|
-
*
|
|
2567
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
2572
2568
|
*/
|
|
2573
2569
|
ManualSnapshotRetentionPeriod?: number;
|
|
2574
2570
|
/**
|
|
@@ -2582,7 +2578,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2582
2578
|
KmsKeyId?: string;
|
|
2583
2579
|
/**
|
|
2584
2580
|
* <p>The node type that the restored cluster will be provisioned with.</p>
|
|
2585
|
-
*
|
|
2581
|
+
* <p>Default: The node type of the cluster from which the snapshot was taken. You can
|
|
2586
2582
|
* modify this if you are using any DS node type. In that case, you can choose to restore
|
|
2587
2583
|
* into another DS node type of the same size. For example, you can restore ds1.8xlarge
|
|
2588
2584
|
* into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you
|
|
@@ -2599,8 +2595,8 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2599
2595
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
2600
2596
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
2601
2597
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
2602
|
-
*
|
|
2603
|
-
*
|
|
2598
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
2599
|
+
* <p>Default: false</p>
|
|
2604
2600
|
*/
|
|
2605
2601
|
EnhancedVpcRouting?: boolean;
|
|
2606
2602
|
/**
|
|
@@ -2611,7 +2607,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
2611
2607
|
* <p>A list of Identity and Access Management (IAM) roles that can be used by the
|
|
2612
2608
|
* cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon
|
|
2613
2609
|
* Resource Name (ARN) format. </p>
|
|
2614
|
-
*
|
|
2610
|
+
* <p>The maximum number of IAM roles that you can associate is subject to a quota.
|
|
2615
2611
|
* For more information, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Quotas and limits</a>
|
|
2616
2612
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
2617
2613
|
*/
|
|
@@ -2752,8 +2748,8 @@ export interface RevokeClusterSecurityGroupIngressMessage {
|
|
|
2752
2748
|
* acceptable value. If <code>EC2SecurityGroupOwnerId</code> is specified,
|
|
2753
2749
|
* <code>EC2SecurityGroupName</code> must also be provided. and <code>CIDRIP</code>
|
|
2754
2750
|
* cannot be provided. </p>
|
|
2755
|
-
*
|
|
2756
|
-
*
|
|
2751
|
+
* <p>Example: <code>111122223333</code>
|
|
2752
|
+
* </p>
|
|
2757
2753
|
*/
|
|
2758
2754
|
EC2SecurityGroupOwnerId?: string;
|
|
2759
2755
|
}
|
|
@@ -2819,7 +2815,7 @@ export interface RotateEncryptionKeyMessage {
|
|
|
2819
2815
|
/**
|
|
2820
2816
|
* <p>The unique identifier of the cluster that you want to rotate the encryption keys
|
|
2821
2817
|
* for.</p>
|
|
2822
|
-
*
|
|
2818
|
+
* <p>Constraints: Must be the name of valid cluster that has encryption
|
|
2823
2819
|
* enabled.</p>
|
|
2824
2820
|
*/
|
|
2825
2821
|
ClusterIdentifier: string | undefined;
|