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