@aws-sdk/client-redshift 3.262.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-es/endpoint/ruleset.js +3 -3
- 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
|
@@ -75,24 +75,24 @@ export interface ReservedNode {
|
|
|
75
75
|
NodeCount?: number;
|
|
76
76
|
/**
|
|
77
77
|
* <p>The state of the reserved compute node.</p>
|
|
78
|
-
*
|
|
79
|
-
*
|
|
78
|
+
* <p>Possible Values:</p>
|
|
79
|
+
* <ul>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
81
|
+
* <p>pending-payment-This reserved node has recently been purchased, and the
|
|
82
82
|
* sale has been approved, but payment has not yet been confirmed.</p>
|
|
83
83
|
* </li>
|
|
84
84
|
* <li>
|
|
85
|
-
*
|
|
85
|
+
* <p>active-This reserved node is owned by the caller and is available for
|
|
86
86
|
* use.</p>
|
|
87
87
|
* </li>
|
|
88
88
|
* <li>
|
|
89
|
-
*
|
|
89
|
+
* <p>payment-failed-Payment failed for the purchase attempt.</p>
|
|
90
90
|
* </li>
|
|
91
91
|
* <li>
|
|
92
|
-
*
|
|
92
|
+
* <p>retired-The reserved node is no longer available. </p>
|
|
93
93
|
* </li>
|
|
94
94
|
* <li>
|
|
95
|
-
*
|
|
95
|
+
* <p>exchanging-The owner is exchanging the reserved node for another reserved
|
|
96
96
|
* node.</p>
|
|
97
97
|
* </li>
|
|
98
98
|
* </ul>
|
|
@@ -576,8 +576,8 @@ export interface AuthorizeClusterSecurityGroupIngressMessage {
|
|
|
576
576
|
* <p>The Amazon Web Services account number of the owner of the security group specified by the
|
|
577
577
|
* <i>EC2SecurityGroupName</i> parameter. The Amazon Web Services Access Key ID is not an
|
|
578
578
|
* acceptable value. </p>
|
|
579
|
-
*
|
|
580
|
-
*
|
|
579
|
+
* <p>Example: <code>111122223333</code>
|
|
580
|
+
* </p>
|
|
581
581
|
*/
|
|
582
582
|
EC2SecurityGroupOwnerId?: string;
|
|
583
583
|
}
|
|
@@ -821,7 +821,7 @@ export interface AuthorizeSnapshotAccessMessage {
|
|
|
821
821
|
/**
|
|
822
822
|
* <p>The identifier of the Amazon Web Services account authorized to restore the specified
|
|
823
823
|
* snapshot.</p>
|
|
824
|
-
*
|
|
824
|
+
* <p>To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.</p>
|
|
825
825
|
*/
|
|
826
826
|
AccountWithRestoreAccess: string | undefined;
|
|
827
827
|
}
|
|
@@ -844,19 +844,19 @@ export interface Snapshot {
|
|
|
844
844
|
SnapshotCreateTime?: Date;
|
|
845
845
|
/**
|
|
846
846
|
* <p>The snapshot status. The value of the status depends on the API operation used: </p>
|
|
847
|
-
*
|
|
847
|
+
* <ul>
|
|
848
848
|
* <li>
|
|
849
|
-
*
|
|
850
|
-
*
|
|
849
|
+
* <p>
|
|
850
|
+
* <a>CreateClusterSnapshot</a> and <a>CopyClusterSnapshot</a> returns status as "creating". </p>
|
|
851
851
|
* </li>
|
|
852
852
|
* <li>
|
|
853
|
-
*
|
|
854
|
-
*
|
|
853
|
+
* <p>
|
|
854
|
+
* <a>DescribeClusterSnapshots</a> returns status as "creating",
|
|
855
855
|
* "available", "final snapshot", or "failed".</p>
|
|
856
856
|
* </li>
|
|
857
857
|
* <li>
|
|
858
|
-
*
|
|
859
|
-
*
|
|
858
|
+
* <p>
|
|
859
|
+
* <a>DeleteClusterSnapshot</a> returns status as "deleted".</p>
|
|
860
860
|
* </li>
|
|
861
861
|
* </ul>
|
|
862
862
|
*/
|
|
@@ -981,8 +981,8 @@ export interface Snapshot {
|
|
|
981
981
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
982
982
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
983
983
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
984
|
-
*
|
|
985
|
-
*
|
|
984
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
985
|
+
* <p>Default: false</p>
|
|
986
986
|
*/
|
|
987
987
|
EnhancedVpcRouting?: boolean;
|
|
988
988
|
/**
|
|
@@ -992,8 +992,7 @@ export interface Snapshot {
|
|
|
992
992
|
/**
|
|
993
993
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
994
994
|
* snapshot is retained indefinitely. </p>
|
|
995
|
-
*
|
|
996
|
-
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
995
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
997
996
|
*/
|
|
998
997
|
ManualSnapshotRetentionPeriod?: number;
|
|
999
998
|
/**
|
|
@@ -1085,7 +1084,7 @@ export interface AvailabilityZone {
|
|
|
1085
1084
|
export interface DeleteClusterSnapshotMessage {
|
|
1086
1085
|
/**
|
|
1087
1086
|
* <p>The unique identifier of the manual snapshot to be deleted.</p>
|
|
1088
|
-
*
|
|
1087
|
+
* <p>Constraints: Must be the name of an existing snapshot that is in the
|
|
1089
1088
|
* <code>available</code>, <code>failed</code>, or <code>cancelled</code>
|
|
1090
1089
|
* state.</p>
|
|
1091
1090
|
*/
|
|
@@ -1094,7 +1093,7 @@ export interface DeleteClusterSnapshotMessage {
|
|
|
1094
1093
|
* <p>The unique identifier of the cluster the snapshot was created from. This parameter
|
|
1095
1094
|
* is required if your IAM user has a policy containing a snapshot resource element that
|
|
1096
1095
|
* specifies anything other than * for the cluster name.</p>
|
|
1097
|
-
*
|
|
1096
|
+
* <p>Constraints: Must be the name of valid cluster.</p>
|
|
1098
1097
|
*/
|
|
1099
1098
|
SnapshotClusterIdentifier?: string;
|
|
1100
1099
|
}
|
|
@@ -1167,8 +1166,8 @@ export interface BatchModifyClusterSnapshotsMessage {
|
|
|
1167
1166
|
/**
|
|
1168
1167
|
* <p>The number of days that a manual snapshot is retained. If you specify the value -1,
|
|
1169
1168
|
* the manual snapshot is retained indefinitely.</p>
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1169
|
+
* <p>The number must be either -1 or an integer between 1 and 3,653.</p>
|
|
1170
|
+
* <p>If you decrease the manual snapshot retention period from its current value, existing
|
|
1172
1171
|
* manual snapshots that fall outside of the new retention period will return an error. If
|
|
1173
1172
|
* you want to suppress the errors and delete the snapshots, use the force option. </p>
|
|
1174
1173
|
*/
|
|
@@ -1191,7 +1190,7 @@ export interface BatchModifyClusterSnapshotsOutputMessage {
|
|
|
1191
1190
|
}
|
|
1192
1191
|
/**
|
|
1193
1192
|
* <p>The retention period specified is either in the past or is not a valid value.</p>
|
|
1194
|
-
*
|
|
1193
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
1195
1194
|
*/
|
|
1196
1195
|
export declare class InvalidRetentionPeriodFault extends __BaseException {
|
|
1197
1196
|
readonly name: "InvalidRetentionPeriodFault";
|
|
@@ -1246,30 +1245,30 @@ export interface ResizeProgressMessage {
|
|
|
1246
1245
|
TargetNumberOfNodes?: number;
|
|
1247
1246
|
/**
|
|
1248
1247
|
* <p>The cluster type after the resize operation is complete.</p>
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1248
|
+
* <p>Valid Values: <code>multi-node</code> | <code>single-node</code>
|
|
1249
|
+
* </p>
|
|
1251
1250
|
*/
|
|
1252
1251
|
TargetClusterType?: string;
|
|
1253
1252
|
/**
|
|
1254
1253
|
* <p>The status of the resize operation.</p>
|
|
1255
|
-
*
|
|
1254
|
+
* <p>Valid Values: <code>NONE</code> | <code>IN_PROGRESS</code> | <code>FAILED</code> |
|
|
1256
1255
|
* <code>SUCCEEDED</code> | <code>CANCELLING</code>
|
|
1257
|
-
*
|
|
1256
|
+
* </p>
|
|
1258
1257
|
*/
|
|
1259
1258
|
Status?: string;
|
|
1260
1259
|
/**
|
|
1261
1260
|
* <p>The names of tables that have been completely imported .</p>
|
|
1262
|
-
*
|
|
1261
|
+
* <p>Valid Values: List of table names.</p>
|
|
1263
1262
|
*/
|
|
1264
1263
|
ImportTablesCompleted?: string[];
|
|
1265
1264
|
/**
|
|
1266
1265
|
* <p>The names of tables that are being currently imported.</p>
|
|
1267
|
-
*
|
|
1266
|
+
* <p>Valid Values: List of table names.</p>
|
|
1268
1267
|
*/
|
|
1269
1268
|
ImportTablesInProgress?: string[];
|
|
1270
1269
|
/**
|
|
1271
1270
|
* <p>The names of tables that have not been yet imported.</p>
|
|
1272
|
-
*
|
|
1271
|
+
* <p>Valid Values: List of table names</p>
|
|
1273
1272
|
*/
|
|
1274
1273
|
ImportTablesNotStarted?: string[];
|
|
1275
1274
|
/**
|
|
@@ -1316,7 +1315,7 @@ export interface ResizeProgressMessage {
|
|
|
1316
1315
|
Message?: string;
|
|
1317
1316
|
/**
|
|
1318
1317
|
* <p>The type of encryption for the cluster after the resize is complete.</p>
|
|
1319
|
-
*
|
|
1318
|
+
* <p>Possible values are <code>KMS</code> and <code>None</code>. </p>
|
|
1320
1319
|
*/
|
|
1321
1320
|
TargetEncryptionType?: string;
|
|
1322
1321
|
/**
|
|
@@ -1353,41 +1352,41 @@ export interface ClusterParameterStatus {
|
|
|
1353
1352
|
* <p>The status of the parameter that indicates whether the parameter is in sync with
|
|
1354
1353
|
* the database, waiting for a cluster reboot, or encountered an error when being
|
|
1355
1354
|
* applied.</p>
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1355
|
+
* <p>The following are possible statuses and descriptions.</p>
|
|
1356
|
+
* <ul>
|
|
1358
1357
|
* <li>
|
|
1359
|
-
*
|
|
1360
|
-
*
|
|
1358
|
+
* <p>
|
|
1359
|
+
* <code>in-sync</code>: The parameter value is in sync with the
|
|
1361
1360
|
* database.</p>
|
|
1362
1361
|
* </li>
|
|
1363
1362
|
* <li>
|
|
1364
|
-
*
|
|
1365
|
-
*
|
|
1363
|
+
* <p>
|
|
1364
|
+
* <code>pending-reboot</code>: The parameter value will be applied after the
|
|
1366
1365
|
* cluster reboots.</p>
|
|
1367
1366
|
* </li>
|
|
1368
1367
|
* <li>
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1368
|
+
* <p>
|
|
1369
|
+
* <code>applying</code>: The parameter value is being applied to the
|
|
1371
1370
|
* database.</p>
|
|
1372
1371
|
* </li>
|
|
1373
1372
|
* <li>
|
|
1374
|
-
*
|
|
1375
|
-
*
|
|
1373
|
+
* <p>
|
|
1374
|
+
* <code>invalid-parameter</code>: Cannot apply the parameter value because it has
|
|
1376
1375
|
* an invalid value or syntax.</p>
|
|
1377
1376
|
* </li>
|
|
1378
1377
|
* <li>
|
|
1379
|
-
*
|
|
1380
|
-
*
|
|
1378
|
+
* <p>
|
|
1379
|
+
* <code>apply-deferred</code>: The parameter contains static property changes. The
|
|
1381
1380
|
* changes are deferred until the cluster reboots.</p>
|
|
1382
1381
|
* </li>
|
|
1383
1382
|
* <li>
|
|
1384
|
-
*
|
|
1385
|
-
*
|
|
1383
|
+
* <p>
|
|
1384
|
+
* <code>apply-error</code>: Cannot connect to the cluster. The parameter change
|
|
1386
1385
|
* will be applied after the cluster reboots.</p>
|
|
1387
1386
|
* </li>
|
|
1388
1387
|
* <li>
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1388
|
+
* <p>
|
|
1389
|
+
* <code>unknown-error</code>: Cannot apply the parameter change right now. The
|
|
1391
1390
|
* change will be applied after the cluster reboots.</p>
|
|
1392
1391
|
* </li>
|
|
1393
1392
|
* </ul>
|
|
@@ -1413,7 +1412,7 @@ export interface ClusterParameterGroupStatus {
|
|
|
1413
1412
|
ParameterApplyStatus?: string;
|
|
1414
1413
|
/**
|
|
1415
1414
|
* <p>The list of parameter statuses.</p>
|
|
1416
|
-
*
|
|
1415
|
+
* <p>
|
|
1417
1416
|
* For more information about parameters and parameter groups, go to
|
|
1418
1417
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
1419
1418
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -1452,7 +1451,7 @@ export interface ClusterSnapshotCopyStatus {
|
|
|
1452
1451
|
* <p>The number of days that automated snapshots are retained in the destination region
|
|
1453
1452
|
* after they are copied from a source region. If the value is -1, the manual snapshot is
|
|
1454
1453
|
* retained indefinitely. </p>
|
|
1455
|
-
*
|
|
1454
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
1456
1455
|
*/
|
|
1457
1456
|
ManualSnapshotRetentionPeriod?: number;
|
|
1458
1457
|
/**
|
|
@@ -1593,7 +1592,7 @@ export interface HsmStatus {
|
|
|
1593
1592
|
/**
|
|
1594
1593
|
* <p>Reports whether the Amazon Redshift cluster has finished applying any HSM settings
|
|
1595
1594
|
* changes specified in a modify cluster command.</p>
|
|
1596
|
-
*
|
|
1595
|
+
* <p>Values: active, applying</p>
|
|
1597
1596
|
*/
|
|
1598
1597
|
Status?: string;
|
|
1599
1598
|
}
|
|
@@ -1610,20 +1609,20 @@ export interface ClusterIamRole {
|
|
|
1610
1609
|
/**
|
|
1611
1610
|
* <p>A value that describes the status of the IAM role's association with an Amazon
|
|
1612
1611
|
* Redshift cluster.</p>
|
|
1613
|
-
*
|
|
1614
|
-
*
|
|
1612
|
+
* <p>The following are possible statuses and descriptions.</p>
|
|
1613
|
+
* <ul>
|
|
1615
1614
|
* <li>
|
|
1616
|
-
*
|
|
1617
|
-
*
|
|
1615
|
+
* <p>
|
|
1616
|
+
* <code>in-sync</code>: The role is available for use by the cluster.</p>
|
|
1618
1617
|
* </li>
|
|
1619
1618
|
* <li>
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1619
|
+
* <p>
|
|
1620
|
+
* <code>adding</code>: The role is in the process of being associated with the
|
|
1622
1621
|
* cluster.</p>
|
|
1623
1622
|
* </li>
|
|
1624
1623
|
* <li>
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1624
|
+
* <p>
|
|
1625
|
+
* <code>removing</code>: The role is in the process of being disassociated with
|
|
1627
1626
|
* the cluster.</p>
|
|
1628
1627
|
* </li>
|
|
1629
1628
|
* </ul>
|
|
@@ -1675,8 +1674,8 @@ export interface PendingModifiedValues {
|
|
|
1675
1674
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
1676
1675
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
1677
1676
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1677
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
1678
|
+
* <p>Default: false</p>
|
|
1680
1679
|
*/
|
|
1681
1680
|
EnhancedVpcRouting?: boolean;
|
|
1682
1681
|
/**
|
|
@@ -1819,113 +1818,113 @@ export interface Cluster {
|
|
|
1819
1818
|
NodeType?: string;
|
|
1820
1819
|
/**
|
|
1821
1820
|
* <p> The current state of the cluster. Possible values are the following:</p>
|
|
1822
|
-
*
|
|
1821
|
+
* <ul>
|
|
1823
1822
|
* <li>
|
|
1824
|
-
*
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1823
|
+
* <p>
|
|
1824
|
+
* <code>available</code>
|
|
1825
|
+
* </p>
|
|
1827
1826
|
* </li>
|
|
1828
1827
|
* <li>
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1831
|
-
*
|
|
1828
|
+
* <p>
|
|
1829
|
+
* <code>available, prep-for-resize</code>
|
|
1830
|
+
* </p>
|
|
1832
1831
|
* </li>
|
|
1833
1832
|
* <li>
|
|
1834
|
-
*
|
|
1835
|
-
*
|
|
1836
|
-
*
|
|
1833
|
+
* <p>
|
|
1834
|
+
* <code>available, resize-cleanup</code>
|
|
1835
|
+
* </p>
|
|
1837
1836
|
* </li>
|
|
1838
1837
|
* <li>
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1838
|
+
* <p>
|
|
1839
|
+
* <code>cancelling-resize</code>
|
|
1840
|
+
* </p>
|
|
1842
1841
|
* </li>
|
|
1843
1842
|
* <li>
|
|
1844
|
-
*
|
|
1845
|
-
*
|
|
1846
|
-
*
|
|
1843
|
+
* <p>
|
|
1844
|
+
* <code>creating</code>
|
|
1845
|
+
* </p>
|
|
1847
1846
|
* </li>
|
|
1848
1847
|
* <li>
|
|
1849
|
-
*
|
|
1850
|
-
*
|
|
1851
|
-
*
|
|
1848
|
+
* <p>
|
|
1849
|
+
* <code>deleting</code>
|
|
1850
|
+
* </p>
|
|
1852
1851
|
* </li>
|
|
1853
1852
|
* <li>
|
|
1854
|
-
*
|
|
1855
|
-
*
|
|
1856
|
-
*
|
|
1853
|
+
* <p>
|
|
1854
|
+
* <code>final-snapshot</code>
|
|
1855
|
+
* </p>
|
|
1857
1856
|
* </li>
|
|
1858
1857
|
* <li>
|
|
1859
|
-
*
|
|
1860
|
-
*
|
|
1861
|
-
*
|
|
1858
|
+
* <p>
|
|
1859
|
+
* <code>hardware-failure</code>
|
|
1860
|
+
* </p>
|
|
1862
1861
|
* </li>
|
|
1863
1862
|
* <li>
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1866
|
-
*
|
|
1863
|
+
* <p>
|
|
1864
|
+
* <code>incompatible-hsm</code>
|
|
1865
|
+
* </p>
|
|
1867
1866
|
* </li>
|
|
1868
1867
|
* <li>
|
|
1869
|
-
*
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1868
|
+
* <p>
|
|
1869
|
+
* <code>incompatible-network</code>
|
|
1870
|
+
* </p>
|
|
1872
1871
|
* </li>
|
|
1873
1872
|
* <li>
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
*
|
|
1873
|
+
* <p>
|
|
1874
|
+
* <code>incompatible-parameters</code>
|
|
1875
|
+
* </p>
|
|
1877
1876
|
* </li>
|
|
1878
1877
|
* <li>
|
|
1879
|
-
*
|
|
1880
|
-
*
|
|
1881
|
-
*
|
|
1878
|
+
* <p>
|
|
1879
|
+
* <code>incompatible-restore</code>
|
|
1880
|
+
* </p>
|
|
1882
1881
|
* </li>
|
|
1883
1882
|
* <li>
|
|
1884
|
-
*
|
|
1885
|
-
*
|
|
1886
|
-
*
|
|
1883
|
+
* <p>
|
|
1884
|
+
* <code>modifying</code>
|
|
1885
|
+
* </p>
|
|
1887
1886
|
* </li>
|
|
1888
1887
|
* <li>
|
|
1889
|
-
*
|
|
1890
|
-
*
|
|
1891
|
-
*
|
|
1888
|
+
* <p>
|
|
1889
|
+
* <code>paused</code>
|
|
1890
|
+
* </p>
|
|
1892
1891
|
* </li>
|
|
1893
1892
|
* <li>
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1896
|
-
*
|
|
1893
|
+
* <p>
|
|
1894
|
+
* <code>rebooting</code>
|
|
1895
|
+
* </p>
|
|
1897
1896
|
* </li>
|
|
1898
1897
|
* <li>
|
|
1899
|
-
*
|
|
1900
|
-
*
|
|
1901
|
-
*
|
|
1898
|
+
* <p>
|
|
1899
|
+
* <code>renaming</code>
|
|
1900
|
+
* </p>
|
|
1902
1901
|
* </li>
|
|
1903
1902
|
* <li>
|
|
1904
|
-
*
|
|
1905
|
-
*
|
|
1906
|
-
*
|
|
1903
|
+
* <p>
|
|
1904
|
+
* <code>resizing</code>
|
|
1905
|
+
* </p>
|
|
1907
1906
|
* </li>
|
|
1908
1907
|
* <li>
|
|
1909
|
-
*
|
|
1910
|
-
*
|
|
1911
|
-
*
|
|
1908
|
+
* <p>
|
|
1909
|
+
* <code>rotating-keys</code>
|
|
1910
|
+
* </p>
|
|
1912
1911
|
* </li>
|
|
1913
1912
|
* <li>
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
1916
|
-
*
|
|
1913
|
+
* <p>
|
|
1914
|
+
* <code>storage-full</code>
|
|
1915
|
+
* </p>
|
|
1917
1916
|
* </li>
|
|
1918
1917
|
* <li>
|
|
1919
|
-
*
|
|
1920
|
-
*
|
|
1921
|
-
*
|
|
1918
|
+
* <p>
|
|
1919
|
+
* <code>updating-hsm</code>
|
|
1920
|
+
* </p>
|
|
1922
1921
|
* </li>
|
|
1923
1922
|
* </ul>
|
|
1924
1923
|
*/
|
|
1925
1924
|
ClusterStatus?: string;
|
|
1926
1925
|
/**
|
|
1927
1926
|
* <p>The availability status of the cluster for queries. Possible values are the following:</p>
|
|
1928
|
-
*
|
|
1927
|
+
* <ul>
|
|
1929
1928
|
* <li>
|
|
1930
1929
|
* <p>Available - The cluster is available for queries. </p>
|
|
1931
1930
|
* </li>
|
|
@@ -1975,7 +1974,7 @@ export interface Cluster {
|
|
|
1975
1974
|
* <p>The default number of days to retain a manual snapshot. If the value is -1, the
|
|
1976
1975
|
* snapshot is retained indefinitely. This setting doesn't change the retention period
|
|
1977
1976
|
* of existing snapshots.</p>
|
|
1978
|
-
*
|
|
1977
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
1979
1978
|
*/
|
|
1980
1979
|
ManualSnapshotRetentionPeriod?: number;
|
|
1981
1980
|
/**
|
|
@@ -1983,7 +1982,7 @@ export interface Cluster {
|
|
|
1983
1982
|
* security group is represented by an element that contains
|
|
1984
1983
|
* <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code>
|
|
1985
1984
|
* subelements. </p>
|
|
1986
|
-
*
|
|
1985
|
+
* <p>Cluster security groups are used when the cluster is not created in an Amazon
|
|
1987
1986
|
* Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups,
|
|
1988
1987
|
* which are listed by the <b>VpcSecurityGroups</b> parameter.
|
|
1989
1988
|
* </p>
|
|
@@ -2059,7 +2058,7 @@ export interface Cluster {
|
|
|
2059
2058
|
* <p>A value that reports whether the Amazon Redshift cluster has finished applying any
|
|
2060
2059
|
* hardware security module (HSM) settings changes specified in a modify cluster
|
|
2061
2060
|
* command.</p>
|
|
2062
|
-
*
|
|
2061
|
+
* <p>Values: active, applying</p>
|
|
2063
2062
|
*/
|
|
2064
2063
|
HsmStatus?: HsmStatus;
|
|
2065
2064
|
/**
|
|
@@ -2097,8 +2096,8 @@ export interface Cluster {
|
|
|
2097
2096
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
2098
2097
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
2099
2098
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2099
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
2100
|
+
* <p>Default: false</p>
|
|
2102
2101
|
*/
|
|
2103
2102
|
EnhancedVpcRouting?: boolean;
|
|
2104
2103
|
/**
|
|
@@ -2137,7 +2136,7 @@ export interface Cluster {
|
|
|
2137
2136
|
ExpectedNextSnapshotScheduleTime?: Date;
|
|
2138
2137
|
/**
|
|
2139
2138
|
* <p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p>
|
|
2140
|
-
*
|
|
2139
|
+
* <ul>
|
|
2141
2140
|
* <li>
|
|
2142
2141
|
* <p>OnTrack - The next snapshot is expected to be taken on time. </p>
|
|
2143
2142
|
* </li>
|
|
@@ -2153,13 +2152,13 @@ export interface Cluster {
|
|
|
2153
2152
|
NextMaintenanceWindowStartTime?: Date;
|
|
2154
2153
|
/**
|
|
2155
2154
|
* <p>Returns the following:</p>
|
|
2156
|
-
*
|
|
2155
|
+
* <ul>
|
|
2157
2156
|
* <li>
|
|
2158
|
-
*
|
|
2157
|
+
* <p>AllowCancelResize: a boolean value indicating if the resize operation can be
|
|
2159
2158
|
* cancelled.</p>
|
|
2160
2159
|
* </li>
|
|
2161
2160
|
* <li>
|
|
2162
|
-
*
|
|
2161
|
+
* <p>ResizeType: Returns ClassicResize</p>
|
|
2163
2162
|
* </li>
|
|
2164
2163
|
* </ul>
|
|
2165
2164
|
*/
|
|
@@ -2732,10 +2731,10 @@ export interface ClusterVersionsMessage {
|
|
|
2732
2731
|
export interface CopyClusterSnapshotMessage {
|
|
2733
2732
|
/**
|
|
2734
2733
|
* <p>The identifier for the source snapshot.</p>
|
|
2735
|
-
*
|
|
2736
|
-
*
|
|
2734
|
+
* <p>Constraints:</p>
|
|
2735
|
+
* <ul>
|
|
2737
2736
|
* <li>
|
|
2738
|
-
*
|
|
2737
|
+
* <p>Must be the identifier for a valid automated snapshot whose state is
|
|
2739
2738
|
* <code>available</code>.</p>
|
|
2740
2739
|
* </li>
|
|
2741
2740
|
* </ul>
|
|
@@ -2745,32 +2744,32 @@ export interface CopyClusterSnapshotMessage {
|
|
|
2745
2744
|
* <p>The identifier of the cluster the source snapshot was created from. This parameter
|
|
2746
2745
|
* is required if your IAM user has a policy containing a snapshot resource element that
|
|
2747
2746
|
* specifies anything other than * for the cluster name.</p>
|
|
2748
|
-
*
|
|
2749
|
-
*
|
|
2747
|
+
* <p>Constraints:</p>
|
|
2748
|
+
* <ul>
|
|
2750
2749
|
* <li>
|
|
2751
|
-
*
|
|
2750
|
+
* <p>Must be the identifier for a valid cluster.</p>
|
|
2752
2751
|
* </li>
|
|
2753
2752
|
* </ul>
|
|
2754
2753
|
*/
|
|
2755
2754
|
SourceSnapshotClusterIdentifier?: string;
|
|
2756
2755
|
/**
|
|
2757
2756
|
* <p>The identifier given to the new manual snapshot.</p>
|
|
2758
|
-
*
|
|
2759
|
-
*
|
|
2757
|
+
* <p>Constraints:</p>
|
|
2758
|
+
* <ul>
|
|
2760
2759
|
* <li>
|
|
2761
|
-
*
|
|
2760
|
+
* <p>Cannot be null, empty, or blank.</p>
|
|
2762
2761
|
* </li>
|
|
2763
2762
|
* <li>
|
|
2764
|
-
*
|
|
2763
|
+
* <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p>
|
|
2765
2764
|
* </li>
|
|
2766
2765
|
* <li>
|
|
2767
|
-
*
|
|
2766
|
+
* <p>First character must be a letter.</p>
|
|
2768
2767
|
* </li>
|
|
2769
2768
|
* <li>
|
|
2770
|
-
*
|
|
2769
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
2771
2770
|
* </li>
|
|
2772
2771
|
* <li>
|
|
2773
|
-
*
|
|
2772
|
+
* <p>Must be unique for the Amazon Web Services account that is making the request.</p>
|
|
2774
2773
|
* </li>
|
|
2775
2774
|
* </ul>
|
|
2776
2775
|
*/
|
|
@@ -2778,8 +2777,8 @@ export interface CopyClusterSnapshotMessage {
|
|
|
2778
2777
|
/**
|
|
2779
2778
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
2780
2779
|
* snapshot is retained indefinitely. </p>
|
|
2781
|
-
*
|
|
2782
|
-
*
|
|
2780
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
2781
|
+
* <p>The default value is -1.</p>
|
|
2783
2782
|
*/
|
|
2784
2783
|
ManualSnapshotRetentionPeriod?: number;
|
|
2785
2784
|
}
|
|
@@ -2840,22 +2839,22 @@ export declare class InvalidAuthenticationProfileRequestFault extends __BaseExce
|
|
|
2840
2839
|
export interface CreateClusterMessage {
|
|
2841
2840
|
/**
|
|
2842
2841
|
* <p>The name of the first database to be created when the cluster is created.</p>
|
|
2843
|
-
*
|
|
2842
|
+
* <p>To create additional databases after the cluster is created, connect to the cluster
|
|
2844
2843
|
* with a SQL client and use SQL commands to create a database. For more information, go to
|
|
2845
2844
|
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html">Create
|
|
2846
2845
|
* a Database</a> in the Amazon Redshift Database Developer Guide. </p>
|
|
2847
|
-
*
|
|
2848
|
-
*
|
|
2849
|
-
*
|
|
2850
|
-
*
|
|
2846
|
+
* <p>Default: <code>dev</code>
|
|
2847
|
+
* </p>
|
|
2848
|
+
* <p>Constraints:</p>
|
|
2849
|
+
* <ul>
|
|
2851
2850
|
* <li>
|
|
2852
|
-
*
|
|
2851
|
+
* <p>Must contain 1 to 64 alphanumeric characters.</p>
|
|
2853
2852
|
* </li>
|
|
2854
2853
|
* <li>
|
|
2855
|
-
*
|
|
2854
|
+
* <p>Must contain only lowercase letters.</p>
|
|
2856
2855
|
* </li>
|
|
2857
2856
|
* <li>
|
|
2858
|
-
*
|
|
2857
|
+
* <p>Cannot be a word that is reserved by the service. A list of reserved words
|
|
2859
2858
|
* can be found in <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the
|
|
2860
2859
|
* Amazon Redshift Database Developer Guide. </p>
|
|
2861
2860
|
* </li>
|
|
@@ -2884,36 +2883,35 @@ export interface CreateClusterMessage {
|
|
|
2884
2883
|
* <p>Must be unique for all clusters within an Amazon Web Services account.</p>
|
|
2885
2884
|
* </li>
|
|
2886
2885
|
* </ul>
|
|
2887
|
-
*
|
|
2888
|
-
*
|
|
2889
|
-
* </p>
|
|
2886
|
+
* <p>Example: <code>myexamplecluster</code>
|
|
2887
|
+
* </p>
|
|
2890
2888
|
*/
|
|
2891
2889
|
ClusterIdentifier: string | undefined;
|
|
2892
2890
|
/**
|
|
2893
2891
|
* <p>The type of the cluster. When cluster type is specified as</p>
|
|
2894
|
-
*
|
|
2892
|
+
* <ul>
|
|
2895
2893
|
* <li>
|
|
2896
|
-
*
|
|
2897
|
-
*
|
|
2894
|
+
* <p>
|
|
2895
|
+
* <code>single-node</code>, the <b>NumberOfNodes</b>
|
|
2898
2896
|
* parameter is not required.</p>
|
|
2899
2897
|
* </li>
|
|
2900
2898
|
* <li>
|
|
2901
|
-
*
|
|
2902
|
-
*
|
|
2899
|
+
* <p>
|
|
2900
|
+
* <code>multi-node</code>, the <b>NumberOfNodes</b>
|
|
2903
2901
|
* parameter is required.</p>
|
|
2904
2902
|
* </li>
|
|
2905
2903
|
* </ul>
|
|
2906
|
-
*
|
|
2907
|
-
*
|
|
2908
|
-
*
|
|
2909
|
-
*
|
|
2904
|
+
* <p>Valid Values: <code>multi-node</code> | <code>single-node</code>
|
|
2905
|
+
* </p>
|
|
2906
|
+
* <p>Default: <code>multi-node</code>
|
|
2907
|
+
* </p>
|
|
2910
2908
|
*/
|
|
2911
2909
|
ClusterType?: string;
|
|
2912
2910
|
/**
|
|
2913
2911
|
* <p>The node type to be provisioned for the cluster. For information about node types,
|
|
2914
2912
|
* go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with
|
|
2915
2913
|
* Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>
|
|
2916
|
-
*
|
|
2914
|
+
* <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> |
|
|
2917
2915
|
* <code>dc1.large</code> | <code>dc1.8xlarge</code> |
|
|
2918
2916
|
* <code>dc2.large</code> | <code>dc2.8xlarge</code> |
|
|
2919
2917
|
* <code>ra3.xlplus</code> | <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code>
|
|
@@ -2923,18 +2921,17 @@ export interface CreateClusterMessage {
|
|
|
2923
2921
|
/**
|
|
2924
2922
|
* <p>The user name associated with the admin user account for the cluster that is being
|
|
2925
2923
|
* created.</p>
|
|
2926
|
-
*
|
|
2927
|
-
*
|
|
2924
|
+
* <p>Constraints:</p>
|
|
2925
|
+
* <ul>
|
|
2928
2926
|
* <li>
|
|
2929
|
-
*
|
|
2927
|
+
* <p>Must be 1 - 128 alphanumeric characters. The user name can't be
|
|
2930
2928
|
* <code>PUBLIC</code>.</p>
|
|
2931
2929
|
* </li>
|
|
2932
2930
|
* <li>
|
|
2933
|
-
*
|
|
2931
|
+
* <p>First character must be a letter.</p>
|
|
2934
2932
|
* </li>
|
|
2935
2933
|
* <li>
|
|
2936
|
-
*
|
|
2937
|
-
* <p>Cannot be a reserved word. A list of reserved words can be found in <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved
|
|
2934
|
+
* <p>Cannot be a reserved word. A list of reserved words can be found in <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved
|
|
2938
2935
|
* Words</a> in the Amazon Redshift Database Developer Guide. </p>
|
|
2939
2936
|
* </li>
|
|
2940
2937
|
* </ul>
|
|
@@ -2943,22 +2940,22 @@ export interface CreateClusterMessage {
|
|
|
2943
2940
|
/**
|
|
2944
2941
|
* <p>The password associated with the admin user account for the cluster that is being
|
|
2945
2942
|
* created.</p>
|
|
2946
|
-
*
|
|
2947
|
-
*
|
|
2943
|
+
* <p>Constraints:</p>
|
|
2944
|
+
* <ul>
|
|
2948
2945
|
* <li>
|
|
2949
|
-
*
|
|
2946
|
+
* <p>Must be between 8 and 64 characters in length.</p>
|
|
2950
2947
|
* </li>
|
|
2951
2948
|
* <li>
|
|
2952
|
-
*
|
|
2949
|
+
* <p>Must contain at least one uppercase letter.</p>
|
|
2953
2950
|
* </li>
|
|
2954
2951
|
* <li>
|
|
2955
|
-
*
|
|
2952
|
+
* <p>Must contain at least one lowercase letter.</p>
|
|
2956
2953
|
* </li>
|
|
2957
2954
|
* <li>
|
|
2958
|
-
*
|
|
2955
|
+
* <p>Must contain one number.</p>
|
|
2959
2956
|
* </li>
|
|
2960
2957
|
* <li>
|
|
2961
|
-
*
|
|
2958
|
+
* <p>Can be any printable ASCII character (ASCII code 33-126) except <code>'</code>
|
|
2962
2959
|
* (single quote), <code>"</code> (double quote), <code>\</code>, <code>/</code>, or <code>@</code>.</p>
|
|
2963
2960
|
* </li>
|
|
2964
2961
|
* </ul>
|
|
@@ -2966,18 +2963,18 @@ export interface CreateClusterMessage {
|
|
|
2966
2963
|
MasterUserPassword: string | undefined;
|
|
2967
2964
|
/**
|
|
2968
2965
|
* <p>A list of security groups to be associated with this cluster.</p>
|
|
2969
|
-
*
|
|
2966
|
+
* <p>Default: The default cluster security group for Amazon Redshift.</p>
|
|
2970
2967
|
*/
|
|
2971
2968
|
ClusterSecurityGroups?: string[];
|
|
2972
2969
|
/**
|
|
2973
2970
|
* <p>A list of Virtual Private Cloud (VPC) security groups to be associated with the
|
|
2974
2971
|
* cluster.</p>
|
|
2975
|
-
*
|
|
2972
|
+
* <p>Default: The default VPC security group is associated with the cluster.</p>
|
|
2976
2973
|
*/
|
|
2977
2974
|
VpcSecurityGroupIds?: string[];
|
|
2978
2975
|
/**
|
|
2979
2976
|
* <p>The name of a cluster subnet group to be associated with this cluster.</p>
|
|
2980
|
-
*
|
|
2977
|
+
* <p>If this parameter is not provided the resulting cluster will be deployed outside
|
|
2981
2978
|
* virtual private cloud (VPC).</p>
|
|
2982
2979
|
*/
|
|
2983
2980
|
ClusterSubnetGroupName?: string;
|
|
@@ -2986,42 +2983,42 @@ export interface CreateClusterMessage {
|
|
|
2986
2983
|
* cluster. For example, if you have several EC2 instances running in a specific
|
|
2987
2984
|
* Availability Zone, then you might want the cluster to be provisioned in the same zone in
|
|
2988
2985
|
* order to decrease network latency.</p>
|
|
2989
|
-
*
|
|
2986
|
+
* <p>Default: A random, system-chosen Availability Zone in the region that is specified
|
|
2990
2987
|
* by the endpoint.</p>
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2988
|
+
* <p>Example: <code>us-east-2d</code>
|
|
2989
|
+
* </p>
|
|
2990
|
+
* <p>Constraint: The specified Availability Zone must be in the same region as the
|
|
2994
2991
|
* current endpoint.</p>
|
|
2995
2992
|
*/
|
|
2996
2993
|
AvailabilityZone?: string;
|
|
2997
2994
|
/**
|
|
2998
2995
|
* <p>The weekly time range (in UTC) during which automated cluster maintenance can
|
|
2999
2996
|
* occur.</p>
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
2997
|
+
* <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
2998
|
+
* </p>
|
|
2999
|
+
* <p> Default: A 30-minute window selected at random from an 8-hour block of time per
|
|
3003
3000
|
* region, occurring on a random day of the week. For more information about the time
|
|
3004
3001
|
* 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>
|
|
3005
|
-
*
|
|
3006
|
-
*
|
|
3002
|
+
* <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p>
|
|
3003
|
+
* <p>Constraints: Minimum 30-minute window.</p>
|
|
3007
3004
|
*/
|
|
3008
3005
|
PreferredMaintenanceWindow?: string;
|
|
3009
3006
|
/**
|
|
3010
3007
|
* <p>The name of the parameter group to be associated with this cluster.</p>
|
|
3011
|
-
*
|
|
3008
|
+
* <p>Default: The default Amazon Redshift cluster parameter group. For information about the
|
|
3012
3009
|
* default parameter group, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon
|
|
3013
3010
|
* Redshift Parameter Groups</a>
|
|
3014
|
-
*
|
|
3015
|
-
*
|
|
3016
|
-
*
|
|
3011
|
+
* </p>
|
|
3012
|
+
* <p>Constraints:</p>
|
|
3013
|
+
* <ul>
|
|
3017
3014
|
* <li>
|
|
3018
|
-
*
|
|
3015
|
+
* <p>Must be 1 to 255 alphanumeric characters or hyphens.</p>
|
|
3019
3016
|
* </li>
|
|
3020
3017
|
* <li>
|
|
3021
|
-
*
|
|
3018
|
+
* <p>First character must be a letter.</p>
|
|
3022
3019
|
* </li>
|
|
3023
3020
|
* <li>
|
|
3024
|
-
*
|
|
3021
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
3025
3022
|
* </li>
|
|
3026
3023
|
* </ul>
|
|
3027
3024
|
*/
|
|
@@ -3030,62 +3027,61 @@ export interface CreateClusterMessage {
|
|
|
3030
3027
|
* <p>The number of days that automated snapshots are retained. If the value is 0,
|
|
3031
3028
|
* automated snapshots are disabled. Even if automated snapshots are disabled, you can
|
|
3032
3029
|
* still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
|
|
3033
|
-
*
|
|
3034
|
-
*
|
|
3035
|
-
*
|
|
3036
|
-
*
|
|
3037
|
-
* <p>Constraints: Must be a value from 0 to 35.</p>
|
|
3030
|
+
* <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p>
|
|
3031
|
+
* <p>Default: <code>1</code>
|
|
3032
|
+
* </p>
|
|
3033
|
+
* <p>Constraints: Must be a value from 0 to 35.</p>
|
|
3038
3034
|
*/
|
|
3039
3035
|
AutomatedSnapshotRetentionPeriod?: number;
|
|
3040
3036
|
/**
|
|
3041
3037
|
* <p>The default number of days to retain a manual snapshot. If the value is -1, the
|
|
3042
3038
|
* snapshot is retained indefinitely. This setting doesn't change the retention period
|
|
3043
3039
|
* of existing snapshots.</p>
|
|
3044
|
-
*
|
|
3040
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
3045
3041
|
*/
|
|
3046
3042
|
ManualSnapshotRetentionPeriod?: number;
|
|
3047
3043
|
/**
|
|
3048
3044
|
* <p>The port number on which the cluster accepts incoming connections.</p>
|
|
3049
|
-
*
|
|
3045
|
+
* <p>The cluster is accessible only via the JDBC and ODBC connection strings. Part of
|
|
3050
3046
|
* the connection string requires the port on which the cluster will listen for incoming
|
|
3051
3047
|
* connections.</p>
|
|
3052
|
-
*
|
|
3053
|
-
*
|
|
3054
|
-
*
|
|
3055
|
-
*
|
|
3048
|
+
* <p>Default: <code>5439</code>
|
|
3049
|
+
* </p>
|
|
3050
|
+
* <p>Valid Values: <code>1150-65535</code>
|
|
3051
|
+
* </p>
|
|
3056
3052
|
*/
|
|
3057
3053
|
Port?: number;
|
|
3058
3054
|
/**
|
|
3059
3055
|
* <p>The version of the Amazon Redshift engine software that you want to deploy on the
|
|
3060
3056
|
* cluster.</p>
|
|
3061
|
-
*
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3057
|
+
* <p>The version selected runs on all the nodes in the cluster.</p>
|
|
3058
|
+
* <p>Constraints: Only version 1.0 is currently available.</p>
|
|
3059
|
+
* <p>Example: <code>1.0</code>
|
|
3060
|
+
* </p>
|
|
3065
3061
|
*/
|
|
3066
3062
|
ClusterVersion?: string;
|
|
3067
3063
|
/**
|
|
3068
3064
|
* <p>If <code>true</code>, major version upgrades can be applied during the maintenance
|
|
3069
3065
|
* window to the Amazon Redshift engine that is running on the cluster.</p>
|
|
3070
|
-
*
|
|
3066
|
+
* <p>When a new major version of the Amazon Redshift engine is released, you can request that
|
|
3071
3067
|
* the service automatically apply upgrades during the maintenance window to the Amazon Redshift
|
|
3072
3068
|
* engine that is running on your cluster.</p>
|
|
3073
|
-
*
|
|
3074
|
-
*
|
|
3069
|
+
* <p>Default: <code>true</code>
|
|
3070
|
+
* </p>
|
|
3075
3071
|
*/
|
|
3076
3072
|
AllowVersionUpgrade?: boolean;
|
|
3077
3073
|
/**
|
|
3078
3074
|
* <p>The number of compute nodes in the cluster. This parameter is required when the
|
|
3079
3075
|
* <b>ClusterType</b> parameter is specified as
|
|
3080
3076
|
* <code>multi-node</code>. </p>
|
|
3081
|
-
*
|
|
3077
|
+
* <p>For information about determining how many nodes you need, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with
|
|
3082
3078
|
* Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>
|
|
3083
|
-
*
|
|
3079
|
+
* <p>If you don't specify this parameter, you get a single-node cluster. When requesting
|
|
3084
3080
|
* a multi-node cluster, you must specify the number of nodes that you want in the
|
|
3085
3081
|
* cluster.</p>
|
|
3086
|
-
*
|
|
3087
|
-
*
|
|
3088
|
-
*
|
|
3082
|
+
* <p>Default: <code>1</code>
|
|
3083
|
+
* </p>
|
|
3084
|
+
* <p>Constraints: Value must be at least 1 and no more than 100.</p>
|
|
3089
3085
|
*/
|
|
3090
3086
|
NumberOfNodes?: number;
|
|
3091
3087
|
/**
|
|
@@ -3094,7 +3090,7 @@ export interface CreateClusterMessage {
|
|
|
3094
3090
|
PubliclyAccessible?: boolean;
|
|
3095
3091
|
/**
|
|
3096
3092
|
* <p>If <code>true</code>, the data in the cluster is encrypted at rest. </p>
|
|
3097
|
-
*
|
|
3093
|
+
* <p>Default: false</p>
|
|
3098
3094
|
*/
|
|
3099
3095
|
Encrypted?: boolean;
|
|
3100
3096
|
/**
|
|
@@ -3109,7 +3105,7 @@ export interface CreateClusterMessage {
|
|
|
3109
3105
|
HsmConfigurationIdentifier?: string;
|
|
3110
3106
|
/**
|
|
3111
3107
|
* <p>The Elastic IP (EIP) address for the cluster.</p>
|
|
3112
|
-
*
|
|
3108
|
+
* <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible
|
|
3113
3109
|
* through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible
|
|
3114
3110
|
* cluster with availability zone relocation turned on. For more information about provisioning clusters in
|
|
3115
3111
|
* EC2-VPC, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported
|
|
@@ -3130,8 +3126,8 @@ export interface CreateClusterMessage {
|
|
|
3130
3126
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
3131
3127
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
3132
3128
|
* the Amazon Redshift Cluster Management Guide.</p>
|
|
3133
|
-
*
|
|
3134
|
-
*
|
|
3129
|
+
* <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p>
|
|
3130
|
+
* <p>Default: false</p>
|
|
3135
3131
|
*/
|
|
3136
3132
|
EnhancedVpcRouting?: boolean;
|
|
3137
3133
|
/**
|
|
@@ -3142,7 +3138,7 @@ export interface CreateClusterMessage {
|
|
|
3142
3138
|
* <p>A list of Identity and Access Management (IAM) roles that can be used by the
|
|
3143
3139
|
* cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon
|
|
3144
3140
|
* Resource Name (ARN) format. </p>
|
|
3145
|
-
*
|
|
3141
|
+
* <p>The maximum number of IAM roles that you can associate is subject to a quota.
|
|
3146
3142
|
* For more information, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Quotas and limits</a>
|
|
3147
3143
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
3148
3144
|
*/
|
|
@@ -3347,30 +3343,30 @@ export declare class UnauthorizedOperation extends __BaseException {
|
|
|
3347
3343
|
export interface CreateClusterParameterGroupMessage {
|
|
3348
3344
|
/**
|
|
3349
3345
|
* <p>The name of the cluster parameter group.</p>
|
|
3350
|
-
*
|
|
3351
|
-
*
|
|
3346
|
+
* <p>Constraints:</p>
|
|
3347
|
+
* <ul>
|
|
3352
3348
|
* <li>
|
|
3353
|
-
*
|
|
3349
|
+
* <p>Must be 1 to 255 alphanumeric characters or hyphens</p>
|
|
3354
3350
|
* </li>
|
|
3355
3351
|
* <li>
|
|
3356
|
-
*
|
|
3352
|
+
* <p>First character must be a letter.</p>
|
|
3357
3353
|
* </li>
|
|
3358
3354
|
* <li>
|
|
3359
|
-
*
|
|
3355
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
3360
3356
|
* </li>
|
|
3361
3357
|
* <li>
|
|
3362
|
-
*
|
|
3358
|
+
* <p>Must be unique withing your Amazon Web Services account.</p>
|
|
3363
3359
|
* </li>
|
|
3364
3360
|
* </ul>
|
|
3365
|
-
*
|
|
3361
|
+
* <note>
|
|
3366
3362
|
* <p>This value is stored as a lower-case string.</p>
|
|
3367
|
-
*
|
|
3363
|
+
* </note>
|
|
3368
3364
|
*/
|
|
3369
3365
|
ParameterGroupName: string | undefined;
|
|
3370
3366
|
/**
|
|
3371
3367
|
* <p>The Amazon Redshift engine version to which the cluster parameter group applies. The
|
|
3372
3368
|
* cluster engine version determines the set of parameters.</p>
|
|
3373
|
-
*
|
|
3369
|
+
* <p>To get a list of valid parameter group family names, you can call <a>DescribeClusterParameterGroups</a>. By default, Amazon Redshift returns a list of
|
|
3374
3370
|
* all the parameter groups that are owned by your Amazon Web Services account, including the default
|
|
3375
3371
|
* parameter groups for each Amazon Redshift engine version. The parameter group family names
|
|
3376
3372
|
* associated with the default parameter groups provide you the valid values. For example,
|
|
@@ -3399,20 +3395,20 @@ export interface CreateClusterSecurityGroupMessage {
|
|
|
3399
3395
|
/**
|
|
3400
3396
|
* <p>The name for the security group. Amazon Redshift stores the value as a lowercase
|
|
3401
3397
|
* string.</p>
|
|
3402
|
-
*
|
|
3403
|
-
*
|
|
3398
|
+
* <p>Constraints:</p>
|
|
3399
|
+
* <ul>
|
|
3404
3400
|
* <li>
|
|
3405
|
-
*
|
|
3401
|
+
* <p>Must contain no more than 255 alphanumeric characters or hyphens.</p>
|
|
3406
3402
|
* </li>
|
|
3407
3403
|
* <li>
|
|
3408
|
-
*
|
|
3404
|
+
* <p>Must not be "Default".</p>
|
|
3409
3405
|
* </li>
|
|
3410
3406
|
* <li>
|
|
3411
|
-
*
|
|
3407
|
+
* <p>Must be unique for all security groups that are created by your Amazon Web Services account.</p>
|
|
3412
3408
|
* </li>
|
|
3413
3409
|
* </ul>
|
|
3414
|
-
*
|
|
3415
|
-
*
|
|
3410
|
+
* <p>Example: <code>examplesecuritygroup</code>
|
|
3411
|
+
* </p>
|
|
3416
3412
|
*/
|
|
3417
3413
|
ClusterSecurityGroupName: string | undefined;
|
|
3418
3414
|
/**
|
|
@@ -3437,23 +3433,23 @@ export interface CreateClusterSnapshotMessage {
|
|
|
3437
3433
|
/**
|
|
3438
3434
|
* <p>A unique identifier for the snapshot that you are requesting. This identifier must
|
|
3439
3435
|
* be unique for all snapshots within the Amazon Web Services account.</p>
|
|
3440
|
-
*
|
|
3441
|
-
*
|
|
3436
|
+
* <p>Constraints:</p>
|
|
3437
|
+
* <ul>
|
|
3442
3438
|
* <li>
|
|
3443
|
-
*
|
|
3439
|
+
* <p>Cannot be null, empty, or blank</p>
|
|
3444
3440
|
* </li>
|
|
3445
3441
|
* <li>
|
|
3446
|
-
*
|
|
3442
|
+
* <p>Must contain from 1 to 255 alphanumeric characters or hyphens</p>
|
|
3447
3443
|
* </li>
|
|
3448
3444
|
* <li>
|
|
3449
|
-
*
|
|
3445
|
+
* <p>First character must be a letter</p>
|
|
3450
3446
|
* </li>
|
|
3451
3447
|
* <li>
|
|
3452
|
-
*
|
|
3448
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p>
|
|
3453
3449
|
* </li>
|
|
3454
3450
|
* </ul>
|
|
3455
|
-
*
|
|
3456
|
-
*
|
|
3451
|
+
* <p>Example: <code>my-snapshot-id</code>
|
|
3452
|
+
* </p>
|
|
3457
3453
|
*/
|
|
3458
3454
|
SnapshotIdentifier: string | undefined;
|
|
3459
3455
|
/**
|
|
@@ -3463,10 +3459,8 @@ export interface CreateClusterSnapshotMessage {
|
|
|
3463
3459
|
/**
|
|
3464
3460
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
3465
3461
|
* snapshot is retained indefinitely. </p>
|
|
3466
|
-
*
|
|
3467
|
-
*
|
|
3468
|
-
*
|
|
3469
|
-
* <p>The default value is -1.</p>
|
|
3462
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
3463
|
+
* <p>The default value is -1.</p>
|
|
3470
3464
|
*/
|
|
3471
3465
|
ManualSnapshotRetentionPeriod?: number;
|
|
3472
3466
|
/**
|
|
@@ -3487,20 +3481,20 @@ export interface CreateClusterSubnetGroupMessage {
|
|
|
3487
3481
|
/**
|
|
3488
3482
|
* <p>The name for the subnet group. Amazon Redshift stores the value as a lowercase
|
|
3489
3483
|
* string.</p>
|
|
3490
|
-
*
|
|
3491
|
-
*
|
|
3484
|
+
* <p>Constraints:</p>
|
|
3485
|
+
* <ul>
|
|
3492
3486
|
* <li>
|
|
3493
|
-
*
|
|
3487
|
+
* <p>Must contain no more than 255 alphanumeric characters or hyphens.</p>
|
|
3494
3488
|
* </li>
|
|
3495
3489
|
* <li>
|
|
3496
|
-
*
|
|
3490
|
+
* <p>Must not be "Default".</p>
|
|
3497
3491
|
* </li>
|
|
3498
3492
|
* <li>
|
|
3499
|
-
*
|
|
3493
|
+
* <p>Must be unique for all subnet groups that are created by your Amazon Web Services account.</p>
|
|
3500
3494
|
* </li>
|
|
3501
3495
|
* </ul>
|
|
3502
|
-
*
|
|
3503
|
-
*
|
|
3496
|
+
* <p>Example: <code>examplesubnetgroup</code>
|
|
3497
|
+
* </p>
|
|
3504
3498
|
*/
|
|
3505
3499
|
ClusterSubnetGroupName: string | undefined;
|
|
3506
3500
|
/**
|
|
@@ -3633,19 +3627,19 @@ export declare class EndpointsPerClusterLimitExceededFault extends __BaseExcepti
|
|
|
3633
3627
|
export interface CreateEventSubscriptionMessage {
|
|
3634
3628
|
/**
|
|
3635
3629
|
* <p>The name of the event subscription to be created.</p>
|
|
3636
|
-
*
|
|
3637
|
-
*
|
|
3630
|
+
* <p>Constraints:</p>
|
|
3631
|
+
* <ul>
|
|
3638
3632
|
* <li>
|
|
3639
|
-
*
|
|
3633
|
+
* <p>Cannot be null, empty, or blank.</p>
|
|
3640
3634
|
* </li>
|
|
3641
3635
|
* <li>
|
|
3642
|
-
*
|
|
3636
|
+
* <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p>
|
|
3643
3637
|
* </li>
|
|
3644
3638
|
* <li>
|
|
3645
|
-
*
|
|
3639
|
+
* <p>First character must be a letter.</p>
|
|
3646
3640
|
* </li>
|
|
3647
3641
|
* <li>
|
|
3648
|
-
*
|
|
3642
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
3649
3643
|
* </li>
|
|
3650
3644
|
* </ul>
|
|
3651
3645
|
*/
|
|
@@ -3661,7 +3655,7 @@ export interface CreateEventSubscriptionMessage {
|
|
|
3661
3655
|
* be notified of events generated by a cluster, you would set this parameter to cluster.
|
|
3662
3656
|
* If this value is not specified, events are returned for all Amazon Redshift objects in your
|
|
3663
3657
|
* Amazon Web Services account. You must specify a source type in order to specify source IDs.</p>
|
|
3664
|
-
*
|
|
3658
|
+
* <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.</p>
|
|
3665
3659
|
*/
|
|
3666
3660
|
SourceType?: string;
|
|
3667
3661
|
/**
|
|
@@ -3670,20 +3664,20 @@ export interface CreateEventSubscriptionMessage {
|
|
|
3670
3664
|
* subscription will return only events generated by the specified objects. If not
|
|
3671
3665
|
* specified, then events are returned for all objects within the source type
|
|
3672
3666
|
* specified.</p>
|
|
3673
|
-
*
|
|
3674
|
-
*
|
|
3667
|
+
* <p>Example: my-cluster-1, my-cluster-2</p>
|
|
3668
|
+
* <p>Example: my-snapshot-20131010</p>
|
|
3675
3669
|
*/
|
|
3676
3670
|
SourceIds?: string[];
|
|
3677
3671
|
/**
|
|
3678
3672
|
* <p>Specifies the Amazon Redshift event categories to be published by the event notification
|
|
3679
3673
|
* subscription.</p>
|
|
3680
|
-
*
|
|
3674
|
+
* <p>Values: configuration, management, monitoring, security, pending</p>
|
|
3681
3675
|
*/
|
|
3682
3676
|
EventCategories?: string[];
|
|
3683
3677
|
/**
|
|
3684
3678
|
* <p>Specifies the Amazon Redshift event severity to be published by the event notification
|
|
3685
3679
|
* subscription.</p>
|
|
3686
|
-
*
|
|
3680
|
+
* <p>Values: ERROR, INFO</p>
|
|
3687
3681
|
*/
|
|
3688
3682
|
Severity?: string;
|
|
3689
3683
|
/**
|
|
@@ -3716,14 +3710,14 @@ export interface EventSubscription {
|
|
|
3716
3710
|
SnsTopicArn?: string;
|
|
3717
3711
|
/**
|
|
3718
3712
|
* <p>The status of the Amazon Redshift event notification subscription.</p>
|
|
3719
|
-
*
|
|
3720
|
-
*
|
|
3713
|
+
* <p>Constraints:</p>
|
|
3714
|
+
* <ul>
|
|
3721
3715
|
* <li>
|
|
3722
|
-
*
|
|
3716
|
+
* <p>Can be one of the following: active | no-permission |
|
|
3723
3717
|
* topic-not-exist</p>
|
|
3724
3718
|
* </li>
|
|
3725
3719
|
* <li>
|
|
3726
|
-
*
|
|
3720
|
+
* <p>The status "no-permission" indicates that Amazon Redshift no longer has
|
|
3727
3721
|
* permission to post to the Amazon SNS topic. The status "topic-not-exist"
|
|
3728
3722
|
* indicates that the topic was deleted after the subscription was
|
|
3729
3723
|
* created.</p>
|
|
@@ -3749,13 +3743,13 @@ export interface EventSubscription {
|
|
|
3749
3743
|
/**
|
|
3750
3744
|
* <p>The list of Amazon Redshift event categories specified in the event notification
|
|
3751
3745
|
* subscription.</p>
|
|
3752
|
-
*
|
|
3746
|
+
* <p>Values: Configuration, Management, Monitoring, Security, Pending</p>
|
|
3753
3747
|
*/
|
|
3754
3748
|
EventCategoriesList?: string[];
|
|
3755
3749
|
/**
|
|
3756
3750
|
* <p>The event severity specified in the Amazon Redshift event notification
|
|
3757
3751
|
* subscription.</p>
|
|
3758
|
-
*
|
|
3752
|
+
* <p>Values: ERROR, INFO</p>
|
|
3759
3753
|
*/
|
|
3760
3754
|
Severity?: string;
|
|
3761
3755
|
/**
|
|
@@ -4199,14 +4193,14 @@ export interface ScheduledAction {
|
|
|
4199
4193
|
ScheduledActionName?: string;
|
|
4200
4194
|
/**
|
|
4201
4195
|
* <p>A JSON format string of the Amazon Redshift API operation with input parameters. </p>
|
|
4202
|
-
*
|
|
4196
|
+
* <p>"<code>{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}</code>". </p>
|
|
4203
4197
|
*/
|
|
4204
4198
|
TargetAction?: ScheduledActionType;
|
|
4205
4199
|
/**
|
|
4206
4200
|
* <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action.
|
|
4207
4201
|
* Schedule invocations must be separated by at least one hour.</p>
|
|
4208
|
-
*
|
|
4209
|
-
*
|
|
4202
|
+
* <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
|
|
4203
|
+
* <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>".
|
|
4210
4204
|
* For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see
|
|
4211
4205
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a>
|
|
4212
4206
|
* in the <i>Amazon CloudWatch Events User Guide</i>.</p>
|
|
@@ -4318,7 +4312,7 @@ export interface CreateSnapshotCopyGrantMessage {
|
|
|
4318
4312
|
* <p>The snapshot copy grant that grants Amazon Redshift permission to encrypt copied
|
|
4319
4313
|
* snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination
|
|
4320
4314
|
* region.</p>
|
|
4321
|
-
*
|
|
4315
|
+
* <p>
|
|
4322
4316
|
* For more information about managing snapshot copy grants, go to
|
|
4323
4317
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a>
|
|
4324
4318
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.
|
|
@@ -4344,7 +4338,7 @@ export interface CreateSnapshotCopyGrantResult {
|
|
|
4344
4338
|
* <p>The snapshot copy grant that grants Amazon Redshift permission to encrypt copied
|
|
4345
4339
|
* snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination
|
|
4346
4340
|
* region.</p>
|
|
4347
|
-
*
|
|
4341
|
+
* <p>
|
|
4348
4342
|
* For more information about managing snapshot copy grants, go to
|
|
4349
4343
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a>
|
|
4350
4344
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.
|
|
@@ -4703,19 +4697,19 @@ export interface DeleteAuthenticationProfileResult {
|
|
|
4703
4697
|
export interface DeleteClusterMessage {
|
|
4704
4698
|
/**
|
|
4705
4699
|
* <p>The identifier of the cluster to be deleted.</p>
|
|
4706
|
-
*
|
|
4707
|
-
*
|
|
4700
|
+
* <p>Constraints:</p>
|
|
4701
|
+
* <ul>
|
|
4708
4702
|
* <li>
|
|
4709
|
-
*
|
|
4703
|
+
* <p>Must contain lowercase characters.</p>
|
|
4710
4704
|
* </li>
|
|
4711
4705
|
* <li>
|
|
4712
|
-
*
|
|
4706
|
+
* <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p>
|
|
4713
4707
|
* </li>
|
|
4714
4708
|
* <li>
|
|
4715
|
-
*
|
|
4709
|
+
* <p>First character must be a letter.</p>
|
|
4716
4710
|
* </li>
|
|
4717
4711
|
* <li>
|
|
4718
|
-
*
|
|
4712
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
4719
4713
|
* </li>
|
|
4720
4714
|
* </ul>
|
|
4721
4715
|
*/
|
|
@@ -4725,29 +4719,29 @@ export interface DeleteClusterMessage {
|
|
|
4725
4719
|
* deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If
|
|
4726
4720
|
* <code>false</code>, a final cluster snapshot is created before the cluster is
|
|
4727
4721
|
* deleted. </p>
|
|
4728
|
-
*
|
|
4722
|
+
* <note>
|
|
4729
4723
|
* <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be
|
|
4730
4724
|
* specified if <i>SkipFinalClusterSnapshot</i> is
|
|
4731
4725
|
* <code>false</code>.</p>
|
|
4732
|
-
*
|
|
4733
|
-
*
|
|
4734
|
-
*
|
|
4726
|
+
* </note>
|
|
4727
|
+
* <p>Default: <code>false</code>
|
|
4728
|
+
* </p>
|
|
4735
4729
|
*/
|
|
4736
4730
|
SkipFinalClusterSnapshot?: boolean;
|
|
4737
4731
|
/**
|
|
4738
4732
|
* <p>The identifier of the final snapshot that is to be created immediately before
|
|
4739
4733
|
* deleting the cluster. If this parameter is provided,
|
|
4740
4734
|
* <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. </p>
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4735
|
+
* <p>Constraints:</p>
|
|
4736
|
+
* <ul>
|
|
4743
4737
|
* <li>
|
|
4744
|
-
*
|
|
4738
|
+
* <p>Must be 1 to 255 alphanumeric characters.</p>
|
|
4745
4739
|
* </li>
|
|
4746
4740
|
* <li>
|
|
4747
|
-
*
|
|
4741
|
+
* <p>First character must be a letter.</p>
|
|
4748
4742
|
* </li>
|
|
4749
4743
|
* <li>
|
|
4750
|
-
*
|
|
4744
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
|
|
4751
4745
|
* </li>
|
|
4752
4746
|
* </ul>
|
|
4753
4747
|
*/
|
|
@@ -4755,8 +4749,8 @@ export interface DeleteClusterMessage {
|
|
|
4755
4749
|
/**
|
|
4756
4750
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
4757
4751
|
* snapshot is retained indefinitely.</p>
|
|
4758
|
-
*
|
|
4759
|
-
*
|
|
4752
|
+
* <p>The value must be either -1 or an integer between 1 and 3,653.</p>
|
|
4753
|
+
* <p>The default value is -1.</p>
|
|
4760
4754
|
*/
|
|
4761
4755
|
FinalClusterSnapshotRetentionPeriod?: number;
|
|
4762
4756
|
}
|
|
@@ -4772,13 +4766,13 @@ export interface DeleteClusterResult {
|
|
|
4772
4766
|
export interface DeleteClusterParameterGroupMessage {
|
|
4773
4767
|
/**
|
|
4774
4768
|
* <p>The name of the parameter group to be deleted.</p>
|
|
4775
|
-
*
|
|
4776
|
-
*
|
|
4769
|
+
* <p>Constraints:</p>
|
|
4770
|
+
* <ul>
|
|
4777
4771
|
* <li>
|
|
4778
|
-
*
|
|
4772
|
+
* <p>Must be the name of an existing cluster parameter group.</p>
|
|
4779
4773
|
* </li>
|
|
4780
4774
|
* <li>
|
|
4781
|
-
*
|
|
4775
|
+
* <p>Cannot delete a default cluster parameter group.</p>
|
|
4782
4776
|
* </li>
|
|
4783
4777
|
* </ul>
|
|
4784
4778
|
*/
|
|
@@ -5064,8 +5058,8 @@ export interface DescribeClusterDbRevisionsMessage {
|
|
|
5064
5058
|
* in the <code>marker</code> field of the response. You can retrieve the next set of
|
|
5065
5059
|
* response records by providing the returned <code>marker</code> value in the
|
|
5066
5060
|
* <code>marker</code> parameter and retrying the request. </p>
|
|
5067
|
-
*
|
|
5068
|
-
*
|
|
5061
|
+
* <p>Default: 100</p>
|
|
5062
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5069
5063
|
*/
|
|
5070
5064
|
MaxRecords?: number;
|
|
5071
5065
|
/**
|
|
@@ -5075,7 +5069,7 @@ export interface DescribeClusterDbRevisionsMessage {
|
|
|
5075
5069
|
* in the <code>marker</code> field of the response. You can retrieve the next set of
|
|
5076
5070
|
* response records by providing the returned <code>marker</code> value in the
|
|
5077
5071
|
* <code>marker</code> parameter and retrying the request. </p>
|
|
5078
|
-
*
|
|
5072
|
+
* <p>Constraints: You can specify either the <code>ClusterIdentifier</code> parameter, or
|
|
5079
5073
|
* the <code>marker</code> parameter, but not both.</p>
|
|
5080
5074
|
*/
|
|
5081
5075
|
Marker?: string;
|
|
@@ -5095,9 +5089,9 @@ export interface DescribeClusterParameterGroupsMessage {
|
|
|
5095
5089
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5096
5090
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5097
5091
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5098
|
-
*
|
|
5099
|
-
*
|
|
5100
|
-
*
|
|
5092
|
+
* <p>Default: <code>100</code>
|
|
5093
|
+
* </p>
|
|
5094
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5101
5095
|
*/
|
|
5102
5096
|
MaxRecords?: number;
|
|
5103
5097
|
/**
|
|
@@ -5140,9 +5134,9 @@ export interface DescribeClusterParametersMessage {
|
|
|
5140
5134
|
* <p>The parameter types to return. Specify <code>user</code> to show parameters that
|
|
5141
5135
|
* are different form the default. Similarly, specify <code>engine-default</code> to show
|
|
5142
5136
|
* parameters that are the same as the default parameter group. </p>
|
|
5143
|
-
*
|
|
5144
|
-
*
|
|
5145
|
-
*
|
|
5137
|
+
* <p>Default: All parameter types returned.</p>
|
|
5138
|
+
* <p>Valid Values: <code>user</code> | <code>engine-default</code>
|
|
5139
|
+
* </p>
|
|
5146
5140
|
*/
|
|
5147
5141
|
Source?: string;
|
|
5148
5142
|
/**
|
|
@@ -5150,9 +5144,9 @@ export interface DescribeClusterParametersMessage {
|
|
|
5150
5144
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5151
5145
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5152
5146
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5153
|
-
*
|
|
5154
|
-
*
|
|
5155
|
-
*
|
|
5147
|
+
* <p>Default: <code>100</code>
|
|
5148
|
+
* </p>
|
|
5149
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5156
5150
|
*/
|
|
5157
5151
|
MaxRecords?: number;
|
|
5158
5152
|
/**
|
|
@@ -5172,7 +5166,7 @@ export interface DescribeClustersMessage {
|
|
|
5172
5166
|
/**
|
|
5173
5167
|
* <p>The unique identifier of a cluster whose properties you are requesting. This
|
|
5174
5168
|
* parameter is case sensitive.</p>
|
|
5175
|
-
*
|
|
5169
|
+
* <p>The default is that all clusters defined for an account are returned.</p>
|
|
5176
5170
|
*/
|
|
5177
5171
|
ClusterIdentifier?: string;
|
|
5178
5172
|
/**
|
|
@@ -5180,9 +5174,9 @@ export interface DescribeClustersMessage {
|
|
|
5180
5174
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5181
5175
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5182
5176
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5183
|
-
*
|
|
5184
|
-
*
|
|
5185
|
-
*
|
|
5177
|
+
* <p>Default: <code>100</code>
|
|
5178
|
+
* </p>
|
|
5179
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5186
5180
|
*/
|
|
5187
5181
|
MaxRecords?: number;
|
|
5188
5182
|
/**
|
|
@@ -5192,7 +5186,7 @@ export interface DescribeClustersMessage {
|
|
|
5192
5186
|
* <code>Marker</code> field of the response. You can retrieve the next set of response
|
|
5193
5187
|
* records by providing the returned marker value in the <code>Marker</code> parameter and
|
|
5194
5188
|
* retrying the request. </p>
|
|
5195
|
-
*
|
|
5189
|
+
* <p>Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. </p>
|
|
5196
5190
|
*/
|
|
5197
5191
|
Marker?: string;
|
|
5198
5192
|
/**
|
|
@@ -5220,8 +5214,8 @@ export interface DescribeClusterSecurityGroupsMessage {
|
|
|
5220
5214
|
/**
|
|
5221
5215
|
* <p>The name of a cluster security group for which you are requesting details. You can
|
|
5222
5216
|
* specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. </p>
|
|
5223
|
-
*
|
|
5224
|
-
*
|
|
5217
|
+
* <p> Example: <code>securitygroup1</code>
|
|
5218
|
+
* </p>
|
|
5225
5219
|
*/
|
|
5226
5220
|
ClusterSecurityGroupName?: string;
|
|
5227
5221
|
/**
|
|
@@ -5229,9 +5223,9 @@ export interface DescribeClusterSecurityGroupsMessage {
|
|
|
5229
5223
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5230
5224
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5231
5225
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5232
|
-
*
|
|
5233
|
-
*
|
|
5234
|
-
*
|
|
5226
|
+
* <p>Default: <code>100</code>
|
|
5227
|
+
* </p>
|
|
5228
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5235
5229
|
*/
|
|
5236
5230
|
MaxRecords?: number;
|
|
5237
5231
|
/**
|
|
@@ -5241,7 +5235,7 @@ export interface DescribeClusterSecurityGroupsMessage {
|
|
|
5241
5235
|
* <code>Marker</code> field of the response. You can retrieve the next set of response
|
|
5242
5236
|
* records by providing the returned marker value in the <code>Marker</code> parameter and
|
|
5243
5237
|
* retrying the request. </p>
|
|
5244
|
-
*
|
|
5238
|
+
* <p>Constraints: You can specify either the <b>ClusterSecurityGroupName</b> parameter or the <b>Marker</b> parameter, but not both. </p>
|
|
5245
5239
|
*/
|
|
5246
5240
|
Marker?: string;
|
|
5247
5241
|
/**
|
|
@@ -5305,17 +5299,17 @@ export interface DescribeClusterSnapshotsMessage {
|
|
|
5305
5299
|
/**
|
|
5306
5300
|
* <p>The type of snapshots for which you are requesting information. By default,
|
|
5307
5301
|
* snapshots of all types are returned.</p>
|
|
5308
|
-
*
|
|
5309
|
-
*
|
|
5302
|
+
* <p>Valid Values: <code>automated</code> | <code>manual</code>
|
|
5303
|
+
* </p>
|
|
5310
5304
|
*/
|
|
5311
5305
|
SnapshotType?: string;
|
|
5312
5306
|
/**
|
|
5313
5307
|
* <p>A value that requests only snapshots created at or after the specified time. The
|
|
5314
5308
|
* time value is specified in ISO 8601 format. For more information about ISO 8601, go to
|
|
5315
5309
|
* the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
|
|
5316
|
-
*
|
|
5317
|
-
*
|
|
5318
|
-
*
|
|
5310
|
+
* </p>
|
|
5311
|
+
* <p>Example: <code>2012-07-16T18:00:00Z</code>
|
|
5312
|
+
* </p>
|
|
5319
5313
|
*/
|
|
5320
5314
|
StartTime?: Date;
|
|
5321
5315
|
/**
|
|
@@ -5323,9 +5317,9 @@ export interface DescribeClusterSnapshotsMessage {
|
|
|
5323
5317
|
* The time value is specified in ISO 8601 format. For more information about ISO 8601, go
|
|
5324
5318
|
* to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia
|
|
5325
5319
|
* page.</a>
|
|
5326
|
-
*
|
|
5327
|
-
*
|
|
5328
|
-
*
|
|
5320
|
+
* </p>
|
|
5321
|
+
* <p>Example: <code>2012-07-16T18:00:00Z</code>
|
|
5322
|
+
* </p>
|
|
5329
5323
|
*/
|
|
5330
5324
|
EndTime?: Date;
|
|
5331
5325
|
/**
|
|
@@ -5333,9 +5327,9 @@ export interface DescribeClusterSnapshotsMessage {
|
|
|
5333
5327
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5334
5328
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5335
5329
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5336
|
-
*
|
|
5337
|
-
*
|
|
5338
|
-
*
|
|
5330
|
+
* <p>Default: <code>100</code>
|
|
5331
|
+
* </p>
|
|
5332
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5339
5333
|
*/
|
|
5340
5334
|
MaxRecords?: number;
|
|
5341
5335
|
/**
|
|
@@ -5376,23 +5370,23 @@ export interface DescribeClusterSnapshotsMessage {
|
|
|
5376
5370
|
* <p>A value that indicates whether to return snapshots only for an existing cluster.
|
|
5377
5371
|
* You can perform table-level restore only by using a snapshot of an existing cluster,
|
|
5378
5372
|
* that is, a cluster that has not been deleted. Values for this parameter work as follows: </p>
|
|
5379
|
-
*
|
|
5373
|
+
* <ul>
|
|
5380
5374
|
* <li>
|
|
5381
|
-
*
|
|
5375
|
+
* <p>If <code>ClusterExists</code> is set to <code>true</code>,
|
|
5382
5376
|
* <code>ClusterIdentifier</code> is required.</p>
|
|
5383
5377
|
* </li>
|
|
5384
5378
|
* <li>
|
|
5385
|
-
*
|
|
5379
|
+
* <p>If <code>ClusterExists</code> is set to <code>false</code> and
|
|
5386
5380
|
* <code>ClusterIdentifier</code> isn't specified, all snapshots
|
|
5387
5381
|
* associated with deleted clusters (orphaned snapshots) are returned. </p>
|
|
5388
5382
|
* </li>
|
|
5389
5383
|
* <li>
|
|
5390
|
-
*
|
|
5384
|
+
* <p>If <code>ClusterExists</code> is set to <code>false</code> and
|
|
5391
5385
|
* <code>ClusterIdentifier</code> is specified for a deleted cluster, snapshots
|
|
5392
5386
|
* associated with that cluster are returned.</p>
|
|
5393
5387
|
* </li>
|
|
5394
5388
|
* <li>
|
|
5395
|
-
*
|
|
5389
|
+
* <p>If <code>ClusterExists</code> is set to <code>false</code> and
|
|
5396
5390
|
* <code>ClusterIdentifier</code> is specified for an existing cluster, no
|
|
5397
5391
|
* snapshots are returned. </p>
|
|
5398
5392
|
* </li>
|
|
@@ -5435,9 +5429,9 @@ export interface DescribeClusterSubnetGroupsMessage {
|
|
|
5435
5429
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5436
5430
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5437
5431
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5438
|
-
*
|
|
5439
|
-
*
|
|
5440
|
-
*
|
|
5432
|
+
* <p>Default: <code>100</code>
|
|
5433
|
+
* </p>
|
|
5434
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5441
5435
|
*/
|
|
5442
5436
|
MaxRecords?: number;
|
|
5443
5437
|
/**
|
|
@@ -5555,23 +5549,23 @@ export interface TrackListMessage {
|
|
|
5555
5549
|
export interface DescribeClusterVersionsMessage {
|
|
5556
5550
|
/**
|
|
5557
5551
|
* <p>The specific cluster version to return.</p>
|
|
5558
|
-
*
|
|
5559
|
-
*
|
|
5552
|
+
* <p>Example: <code>1.0</code>
|
|
5553
|
+
* </p>
|
|
5560
5554
|
*/
|
|
5561
5555
|
ClusterVersion?: string;
|
|
5562
5556
|
/**
|
|
5563
5557
|
* <p>The name of a specific cluster parameter group family to return details
|
|
5564
5558
|
* for.</p>
|
|
5565
|
-
*
|
|
5566
|
-
*
|
|
5559
|
+
* <p>Constraints:</p>
|
|
5560
|
+
* <ul>
|
|
5567
5561
|
* <li>
|
|
5568
|
-
*
|
|
5562
|
+
* <p>Must be 1 to 255 alphanumeric characters</p>
|
|
5569
5563
|
* </li>
|
|
5570
5564
|
* <li>
|
|
5571
|
-
*
|
|
5565
|
+
* <p>First character must be a letter</p>
|
|
5572
5566
|
* </li>
|
|
5573
5567
|
* <li>
|
|
5574
|
-
*
|
|
5568
|
+
* <p>Cannot end with a hyphen or contain two consecutive hyphens</p>
|
|
5575
5569
|
* </li>
|
|
5576
5570
|
* </ul>
|
|
5577
5571
|
*/
|
|
@@ -5581,9 +5575,9 @@ export interface DescribeClusterVersionsMessage {
|
|
|
5581
5575
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5582
5576
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5583
5577
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5584
|
-
*
|
|
5585
|
-
*
|
|
5586
|
-
*
|
|
5578
|
+
* <p>Default: <code>100</code>
|
|
5579
|
+
* </p>
|
|
5580
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5587
5581
|
*/
|
|
5588
5582
|
MaxRecords?: number;
|
|
5589
5583
|
/**
|
|
@@ -5720,9 +5714,9 @@ export interface DescribeDefaultClusterParametersMessage {
|
|
|
5720
5714
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5721
5715
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5722
5716
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5723
|
-
*
|
|
5724
|
-
*
|
|
5725
|
-
*
|
|
5717
|
+
* <p>Default: <code>100</code>
|
|
5718
|
+
* </p>
|
|
5719
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5726
5720
|
*/
|
|
5727
5721
|
MaxRecords?: number;
|
|
5728
5722
|
/**
|
|
@@ -5835,7 +5829,7 @@ export interface DescribeEventCategoriesMessage {
|
|
|
5835
5829
|
/**
|
|
5836
5830
|
* <p>The source type, such as cluster or parameter group, to which the described event
|
|
5837
5831
|
* categories apply.</p>
|
|
5838
|
-
*
|
|
5832
|
+
* <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.</p>
|
|
5839
5833
|
*/
|
|
5840
5834
|
SourceType?: string;
|
|
5841
5835
|
}
|
|
@@ -5857,7 +5851,7 @@ export interface EventInfoMap {
|
|
|
5857
5851
|
EventDescription?: string;
|
|
5858
5852
|
/**
|
|
5859
5853
|
* <p>The severity of the event.</p>
|
|
5860
|
-
*
|
|
5854
|
+
* <p>Values: ERROR, INFO</p>
|
|
5861
5855
|
*/
|
|
5862
5856
|
Severity?: string;
|
|
5863
5857
|
}
|
|
@@ -5898,24 +5892,24 @@ export interface DescribeEventsMessage {
|
|
|
5898
5892
|
/**
|
|
5899
5893
|
* <p>The identifier of the event source for which events will be returned. If this
|
|
5900
5894
|
* parameter is not specified, then all sources are included in the response.</p>
|
|
5901
|
-
*
|
|
5902
|
-
*
|
|
5895
|
+
* <p>Constraints:</p>
|
|
5896
|
+
* <p>If <i>SourceIdentifier</i> is supplied,
|
|
5903
5897
|
* <i>SourceType</i> must also be provided.</p>
|
|
5904
|
-
*
|
|
5898
|
+
* <ul>
|
|
5905
5899
|
* <li>
|
|
5906
|
-
*
|
|
5900
|
+
* <p>Specify a cluster identifier when <i>SourceType</i> is
|
|
5907
5901
|
* <code>cluster</code>.</p>
|
|
5908
5902
|
* </li>
|
|
5909
5903
|
* <li>
|
|
5910
|
-
*
|
|
5904
|
+
* <p>Specify a cluster security group name when <i>SourceType</i>
|
|
5911
5905
|
* is <code>cluster-security-group</code>.</p>
|
|
5912
5906
|
* </li>
|
|
5913
5907
|
* <li>
|
|
5914
|
-
*
|
|
5908
|
+
* <p>Specify a cluster parameter group name when <i>SourceType</i>
|
|
5915
5909
|
* is <code>cluster-parameter-group</code>.</p>
|
|
5916
5910
|
* </li>
|
|
5917
5911
|
* <li>
|
|
5918
|
-
*
|
|
5912
|
+
* <p>Specify a cluster snapshot identifier when <i>SourceType</i>
|
|
5919
5913
|
* is <code>cluster-snapshot</code>.</p>
|
|
5920
5914
|
* </li>
|
|
5921
5915
|
* </ul>
|
|
@@ -5924,26 +5918,26 @@ export interface DescribeEventsMessage {
|
|
|
5924
5918
|
/**
|
|
5925
5919
|
* <p>The event source to retrieve events for. If no value is specified, all events are
|
|
5926
5920
|
* returned.</p>
|
|
5927
|
-
*
|
|
5928
|
-
*
|
|
5921
|
+
* <p>Constraints:</p>
|
|
5922
|
+
* <p>If <i>SourceType</i> is supplied,
|
|
5929
5923
|
* <i>SourceIdentifier</i> must also be provided.</p>
|
|
5930
|
-
*
|
|
5924
|
+
* <ul>
|
|
5931
5925
|
* <li>
|
|
5932
|
-
*
|
|
5926
|
+
* <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is
|
|
5933
5927
|
* a cluster identifier.</p>
|
|
5934
5928
|
* </li>
|
|
5935
5929
|
* <li>
|
|
5936
|
-
*
|
|
5930
|
+
* <p>Specify <code>cluster-security-group</code> when
|
|
5937
5931
|
* <i>SourceIdentifier</i> is a cluster security group
|
|
5938
5932
|
* name.</p>
|
|
5939
5933
|
* </li>
|
|
5940
5934
|
* <li>
|
|
5941
|
-
*
|
|
5935
|
+
* <p>Specify <code>cluster-parameter-group</code> when
|
|
5942
5936
|
* <i>SourceIdentifier</i> is a cluster parameter group
|
|
5943
5937
|
* name.</p>
|
|
5944
5938
|
* </li>
|
|
5945
5939
|
* <li>
|
|
5946
|
-
*
|
|
5940
|
+
* <p>Specify <code>cluster-snapshot</code> when
|
|
5947
5941
|
* <i>SourceIdentifier</i> is a cluster snapshot
|
|
5948
5942
|
* identifier.</p>
|
|
5949
5943
|
* </li>
|
|
@@ -5953,25 +5947,25 @@ export interface DescribeEventsMessage {
|
|
|
5953
5947
|
/**
|
|
5954
5948
|
* <p>The beginning of the time interval to retrieve events for, specified in ISO 8601
|
|
5955
5949
|
* format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
|
|
5956
|
-
*
|
|
5957
|
-
*
|
|
5958
|
-
*
|
|
5950
|
+
* </p>
|
|
5951
|
+
* <p>Example: <code>2009-07-08T18:00Z</code>
|
|
5952
|
+
* </p>
|
|
5959
5953
|
*/
|
|
5960
5954
|
StartTime?: Date;
|
|
5961
5955
|
/**
|
|
5962
5956
|
* <p>The end of the time interval for which to retrieve events, specified in ISO 8601
|
|
5963
5957
|
* format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
|
|
5964
|
-
*
|
|
5965
|
-
*
|
|
5966
|
-
*
|
|
5958
|
+
* </p>
|
|
5959
|
+
* <p>Example: <code>2009-07-08T18:00Z</code>
|
|
5960
|
+
* </p>
|
|
5967
5961
|
*/
|
|
5968
5962
|
EndTime?: Date;
|
|
5969
5963
|
/**
|
|
5970
5964
|
* <p>The number of minutes prior to the time of the request for which to retrieve
|
|
5971
5965
|
* events. For example, if the request is sent at 18:00 and you specify a duration of 60,
|
|
5972
5966
|
* then only events which have occurred after 17:00 will be returned.</p>
|
|
5973
|
-
*
|
|
5974
|
-
*
|
|
5967
|
+
* <p>Default: <code>60</code>
|
|
5968
|
+
* </p>
|
|
5975
5969
|
*/
|
|
5976
5970
|
Duration?: number;
|
|
5977
5971
|
/**
|
|
@@ -5979,9 +5973,9 @@ export interface DescribeEventsMessage {
|
|
|
5979
5973
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
5980
5974
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
5981
5975
|
* set of records by retrying the command with the returned marker value. </p>
|
|
5982
|
-
*
|
|
5983
|
-
*
|
|
5984
|
-
*
|
|
5976
|
+
* <p>Default: <code>100</code>
|
|
5977
|
+
* </p>
|
|
5978
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
5985
5979
|
*/
|
|
5986
5980
|
MaxRecords?: number;
|
|
5987
5981
|
/**
|
|
@@ -6012,12 +6006,12 @@ export interface Event {
|
|
|
6012
6006
|
Message?: string;
|
|
6013
6007
|
/**
|
|
6014
6008
|
* <p>A list of the event categories.</p>
|
|
6015
|
-
*
|
|
6009
|
+
* <p>Values: Configuration, Management, Monitoring, Security, Pending</p>
|
|
6016
6010
|
*/
|
|
6017
6011
|
EventCategories?: string[];
|
|
6018
6012
|
/**
|
|
6019
6013
|
* <p>The severity of the event.</p>
|
|
6020
|
-
*
|
|
6014
|
+
* <p>Values: ERROR, INFO</p>
|
|
6021
6015
|
*/
|
|
6022
6016
|
Severity?: string;
|
|
6023
6017
|
/**
|
|
@@ -6060,9 +6054,9 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
6060
6054
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
6061
6055
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
6062
6056
|
* set of records by retrying the command with the returned marker value. </p>
|
|
6063
|
-
*
|
|
6064
|
-
*
|
|
6065
|
-
*
|
|
6057
|
+
* <p>Default: <code>100</code>
|
|
6058
|
+
* </p>
|
|
6059
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
6066
6060
|
*/
|
|
6067
6061
|
MaxRecords?: number;
|
|
6068
6062
|
/**
|
|
@@ -6125,9 +6119,9 @@ export interface DescribeHsmClientCertificatesMessage {
|
|
|
6125
6119
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
6126
6120
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
6127
6121
|
* set of records by retrying the command with the returned marker value. </p>
|
|
6128
|
-
*
|
|
6129
|
-
*
|
|
6130
|
-
*
|
|
6122
|
+
* <p>Default: <code>100</code>
|
|
6123
|
+
* </p>
|
|
6124
|
+
* <p>Constraints: minimum 20, maximum 100.</p>
|
|
6131
6125
|
*/
|
|
6132
6126
|
MaxRecords?: number;
|
|
6133
6127
|
/**
|