@aws-sdk/client-rds 3.438.0 → 3.441.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 +24 -0
- package/dist-cjs/RDS.js +6 -0
- package/dist-cjs/commands/CreateIntegrationCommand.js +51 -0
- package/dist-cjs/commands/DeleteIntegrationCommand.js +51 -0
- package/dist-cjs/commands/DescribeIntegrationsCommand.js +51 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +77 -3
- package/dist-cjs/pagination/DescribeIntegrationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_query.js +466 -6
- package/dist-es/RDS.js +6 -0
- package/dist-es/commands/CreateIntegrationCommand.js +47 -0
- package/dist-es/commands/DeleteIntegrationCommand.js +47 -0
- package/dist-es/commands/DescribeIntegrationsCommand.js +47 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +69 -0
- package/dist-es/pagination/DescribeIntegrationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_query.js +455 -1
- package/dist-types/RDS.d.ts +21 -0
- package/dist-types/RDSClient.d.ts +5 -2
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +3 -0
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +2 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +12 -0
- package/dist-types/commands/CreateIntegrationCommand.d.ts +130 -0
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +2 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +107 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +9 -1
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeIntegrationsCommand.d.ts +115 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +2 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/RebootDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +3 -0
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +8 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +12 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +12 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +256 -423
- package/dist-types/models/models_1.d.ts +481 -1
- package/dist-types/pagination/DescribeIntegrationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_query.d.ts +27 -0
- package/dist-types/ts3.4/RDS.d.ts +51 -0
- package/dist-types/ts3.4/RDSClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/CreateIntegrationCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/DeleteIntegrationCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/DescribeDBClusterParametersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDBClusterSnapshotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDBClustersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDBEngineVersionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeIntegrationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +85 -55
- package/dist-types/ts3.4/models/models_1.d.ts +71 -1
- package/dist-types/ts3.4/pagination/DescribeIntegrationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +36 -0
- package/package.json +4 -4
|
@@ -545,6 +545,18 @@ export declare class DBSnapshotNotFoundFault extends __BaseException {
|
|
|
545
545
|
*/
|
|
546
546
|
constructor(opts: __ExceptionOptionType<DBSnapshotNotFoundFault, __BaseException>);
|
|
547
547
|
}
|
|
548
|
+
/**
|
|
549
|
+
* @public
|
|
550
|
+
* <p>The specified integration could not be found.</p>
|
|
551
|
+
*/
|
|
552
|
+
export declare class IntegrationNotFoundFault extends __BaseException {
|
|
553
|
+
readonly name: "IntegrationNotFoundFault";
|
|
554
|
+
readonly $fault: "client";
|
|
555
|
+
/**
|
|
556
|
+
* @internal
|
|
557
|
+
*/
|
|
558
|
+
constructor(opts: __ExceptionOptionType<IntegrationNotFoundFault, __BaseException>);
|
|
559
|
+
}
|
|
548
560
|
/**
|
|
549
561
|
* @public
|
|
550
562
|
* <p></p>
|
|
@@ -3203,6 +3215,12 @@ export interface UpgradeTarget {
|
|
|
3203
3215
|
* <p>Valid for: Aurora DB clusters only</p>
|
|
3204
3216
|
*/
|
|
3205
3217
|
SupportsLocalWriteForwarding?: boolean;
|
|
3218
|
+
/**
|
|
3219
|
+
* @public
|
|
3220
|
+
* <p>Indicates whether the DB engine version supports Aurora zero-ETL integrations with
|
|
3221
|
+
* Amazon Redshift.</p>
|
|
3222
|
+
*/
|
|
3223
|
+
SupportsIntegrations?: boolean;
|
|
3206
3224
|
}
|
|
3207
3225
|
/**
|
|
3208
3226
|
* @public
|
|
@@ -3400,6 +3418,12 @@ export interface DBEngineVersion {
|
|
|
3400
3418
|
* <p>Valid for: Aurora DB clusters only</p>
|
|
3401
3419
|
*/
|
|
3402
3420
|
SupportsLocalWriteForwarding?: boolean;
|
|
3421
|
+
/**
|
|
3422
|
+
* @public
|
|
3423
|
+
* <p>Indicates whether the DB engine version supports Aurora zero-ETL integrations with
|
|
3424
|
+
* Amazon Redshift.</p>
|
|
3425
|
+
*/
|
|
3426
|
+
SupportsIntegrations?: boolean;
|
|
3403
3427
|
}
|
|
3404
3428
|
/**
|
|
3405
3429
|
* @public
|
|
@@ -3413,6 +3437,22 @@ export declare class Ec2ImagePropertiesNotSupportedFault extends __BaseException
|
|
|
3413
3437
|
*/
|
|
3414
3438
|
constructor(opts: __ExceptionOptionType<Ec2ImagePropertiesNotSupportedFault, __BaseException>);
|
|
3415
3439
|
}
|
|
3440
|
+
/**
|
|
3441
|
+
* @public
|
|
3442
|
+
* <p>Reserved for future use.</p>
|
|
3443
|
+
*/
|
|
3444
|
+
export interface RdsCustomClusterConfiguration {
|
|
3445
|
+
/**
|
|
3446
|
+
* @public
|
|
3447
|
+
* <p>Reserved for future use.</p>
|
|
3448
|
+
*/
|
|
3449
|
+
InterconnectSubnetId?: string;
|
|
3450
|
+
/**
|
|
3451
|
+
* @public
|
|
3452
|
+
* <p>Reserved for future use.</p>
|
|
3453
|
+
*/
|
|
3454
|
+
TransitGatewayMulticastDomainId?: string;
|
|
3455
|
+
}
|
|
3416
3456
|
/**
|
|
3417
3457
|
* @public
|
|
3418
3458
|
* <p>Contains the scaling configuration of an Aurora Serverless v1 DB cluster.</p>
|
|
@@ -3937,6 +3977,11 @@ export interface CreateDBClusterMessage {
|
|
|
3937
3977
|
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3938
3978
|
*/
|
|
3939
3979
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3980
|
+
/**
|
|
3981
|
+
* @public
|
|
3982
|
+
* <p>Reserved for future use.</p>
|
|
3983
|
+
*/
|
|
3984
|
+
RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;
|
|
3940
3985
|
/**
|
|
3941
3986
|
* @public
|
|
3942
3987
|
* <p>Specifies whether the DB cluster has deletion protection enabled.
|
|
@@ -4506,6 +4551,11 @@ export interface ClusterPendingModifiedValues {
|
|
|
4506
4551
|
* instead automatically adjusts as needed.</p>
|
|
4507
4552
|
*/
|
|
4508
4553
|
AllocatedStorage?: number;
|
|
4554
|
+
/**
|
|
4555
|
+
* @public
|
|
4556
|
+
* <p>Reserved for future use.</p>
|
|
4557
|
+
*/
|
|
4558
|
+
RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;
|
|
4509
4559
|
/**
|
|
4510
4560
|
* @public
|
|
4511
4561
|
* <p>The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
@@ -4859,6 +4909,11 @@ export interface DBCluster {
|
|
|
4859
4909
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
4860
4910
|
*/
|
|
4861
4911
|
ScalingConfigurationInfo?: ScalingConfigurationInfo;
|
|
4912
|
+
/**
|
|
4913
|
+
* @public
|
|
4914
|
+
* <p>Reserved for future use.</p>
|
|
4915
|
+
*/
|
|
4916
|
+
RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;
|
|
4862
4917
|
/**
|
|
4863
4918
|
* @public
|
|
4864
4919
|
* <p>Indicates whether the DB cluster has deletion protection enabled.
|
|
@@ -9981,6 +10036,185 @@ export declare class GlobalClusterQuotaExceededFault extends __BaseException {
|
|
|
9981
10036
|
*/
|
|
9982
10037
|
constructor(opts: __ExceptionOptionType<GlobalClusterQuotaExceededFault, __BaseException>);
|
|
9983
10038
|
}
|
|
10039
|
+
/**
|
|
10040
|
+
* @public
|
|
10041
|
+
*/
|
|
10042
|
+
export interface CreateIntegrationMessage {
|
|
10043
|
+
/**
|
|
10044
|
+
* @public
|
|
10045
|
+
* <p>The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for
|
|
10046
|
+
* replication.</p>
|
|
10047
|
+
*/
|
|
10048
|
+
SourceArn: string | undefined;
|
|
10049
|
+
/**
|
|
10050
|
+
* @public
|
|
10051
|
+
* <p>The ARN of the Redshift data warehouse to use as the target for replication.</p>
|
|
10052
|
+
*/
|
|
10053
|
+
TargetArn: string | undefined;
|
|
10054
|
+
/**
|
|
10055
|
+
* @public
|
|
10056
|
+
* <p>The name of the integration.</p>
|
|
10057
|
+
*/
|
|
10058
|
+
IntegrationName: string | undefined;
|
|
10059
|
+
/**
|
|
10060
|
+
* @public
|
|
10061
|
+
* <p>The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to
|
|
10062
|
+
* encrypt the integration. If you don't specify an encryption key, Aurora uses a default
|
|
10063
|
+
* Amazon Web Services owned key. </p>
|
|
10064
|
+
*/
|
|
10065
|
+
KMSKeyId?: string;
|
|
10066
|
+
/**
|
|
10067
|
+
* @public
|
|
10068
|
+
* <p>An optional set of non-secret key–value pairs that contains additional contextual
|
|
10069
|
+
* information about the data. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
10070
|
+
* context</a> in the <i>Amazon Web Services Key Management Service Developer
|
|
10071
|
+
* Guide</i>.</p>
|
|
10072
|
+
* <p>You can only include this parameter if you specify the <code>KMSKeyId</code> parameter.</p>
|
|
10073
|
+
*/
|
|
10074
|
+
AdditionalEncryptionContext?: Record<string, string>;
|
|
10075
|
+
/**
|
|
10076
|
+
* @public
|
|
10077
|
+
* <p>A list of tags.
|
|
10078
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i>
|
|
10079
|
+
* </p>
|
|
10080
|
+
*/
|
|
10081
|
+
Tags?: Tag[];
|
|
10082
|
+
}
|
|
10083
|
+
/**
|
|
10084
|
+
* @public
|
|
10085
|
+
* <p>An error associated with a zero-ETL integration with Amazon Redshift.</p>
|
|
10086
|
+
*/
|
|
10087
|
+
export interface IntegrationError {
|
|
10088
|
+
/**
|
|
10089
|
+
* @public
|
|
10090
|
+
* <p>The error code associated with the integration.</p>
|
|
10091
|
+
*/
|
|
10092
|
+
ErrorCode: string | undefined;
|
|
10093
|
+
/**
|
|
10094
|
+
* @public
|
|
10095
|
+
* <p>A message explaining the error.</p>
|
|
10096
|
+
*/
|
|
10097
|
+
ErrorMessage?: string;
|
|
10098
|
+
}
|
|
10099
|
+
/**
|
|
10100
|
+
* @public
|
|
10101
|
+
* @enum
|
|
10102
|
+
*/
|
|
10103
|
+
export declare const IntegrationStatus: {
|
|
10104
|
+
readonly ACTIVE: "active";
|
|
10105
|
+
readonly CREATING: "creating";
|
|
10106
|
+
readonly DELETING: "deleting";
|
|
10107
|
+
readonly FAILED: "failed";
|
|
10108
|
+
readonly MODIFYING: "modifying";
|
|
10109
|
+
readonly NEEDS_ATTENTION: "needs_attention";
|
|
10110
|
+
readonly SYNCING: "syncing";
|
|
10111
|
+
};
|
|
10112
|
+
/**
|
|
10113
|
+
* @public
|
|
10114
|
+
*/
|
|
10115
|
+
export type IntegrationStatus = (typeof IntegrationStatus)[keyof typeof IntegrationStatus];
|
|
10116
|
+
/**
|
|
10117
|
+
* @public
|
|
10118
|
+
* <p>An Aurora zero-ETL integration with Amazon Redshift. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.html">Working
|
|
10119
|
+
* with Amazon Aurora zero-ETL integrations with Amazon Redshift</a> in the
|
|
10120
|
+
* <i>Amazon Aurora User Guide</i>.</p>
|
|
10121
|
+
*/
|
|
10122
|
+
export interface Integration {
|
|
10123
|
+
/**
|
|
10124
|
+
* @public
|
|
10125
|
+
* <p>The Amazon Resource Name (ARN) of the Aurora DB cluster used as the source for
|
|
10126
|
+
* replication.</p>
|
|
10127
|
+
*/
|
|
10128
|
+
SourceArn?: string;
|
|
10129
|
+
/**
|
|
10130
|
+
* @public
|
|
10131
|
+
* <p>The ARN of the Redshift data warehouse used as the target for replication.</p>
|
|
10132
|
+
*/
|
|
10133
|
+
TargetArn?: string;
|
|
10134
|
+
/**
|
|
10135
|
+
* @public
|
|
10136
|
+
* <p>The name of the integration.</p>
|
|
10137
|
+
*/
|
|
10138
|
+
IntegrationName?: string;
|
|
10139
|
+
/**
|
|
10140
|
+
* @public
|
|
10141
|
+
* <p>The ARN of the integration.</p>
|
|
10142
|
+
*/
|
|
10143
|
+
IntegrationArn?: string;
|
|
10144
|
+
/**
|
|
10145
|
+
* @public
|
|
10146
|
+
* <p>The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to
|
|
10147
|
+
* encrypt the integration. </p>
|
|
10148
|
+
*/
|
|
10149
|
+
KMSKeyId?: string;
|
|
10150
|
+
/**
|
|
10151
|
+
* @public
|
|
10152
|
+
* <p>The encryption context for the integration. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Amazon Web Services Key Management Service Developer
|
|
10153
|
+
* Guide</i>.</p>
|
|
10154
|
+
*/
|
|
10155
|
+
AdditionalEncryptionContext?: Record<string, string>;
|
|
10156
|
+
/**
|
|
10157
|
+
* @public
|
|
10158
|
+
* <p>The current status of the integration.</p>
|
|
10159
|
+
*/
|
|
10160
|
+
Status?: IntegrationStatus;
|
|
10161
|
+
/**
|
|
10162
|
+
* @public
|
|
10163
|
+
* <p>A list of tags.
|
|
10164
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i>
|
|
10165
|
+
* </p>
|
|
10166
|
+
*/
|
|
10167
|
+
Tags?: Tag[];
|
|
10168
|
+
/**
|
|
10169
|
+
* @public
|
|
10170
|
+
* <p>The time when the integration was created, in Universal Coordinated Time
|
|
10171
|
+
* (UTC).</p>
|
|
10172
|
+
*/
|
|
10173
|
+
CreateTime?: Date;
|
|
10174
|
+
/**
|
|
10175
|
+
* @public
|
|
10176
|
+
* <p>Any errors associated with the integration.</p>
|
|
10177
|
+
*/
|
|
10178
|
+
Errors?: IntegrationError[];
|
|
10179
|
+
}
|
|
10180
|
+
/**
|
|
10181
|
+
* @public
|
|
10182
|
+
* <p>The integration you are trying to create already exists.</p>
|
|
10183
|
+
*/
|
|
10184
|
+
export declare class IntegrationAlreadyExistsFault extends __BaseException {
|
|
10185
|
+
readonly name: "IntegrationAlreadyExistsFault";
|
|
10186
|
+
readonly $fault: "client";
|
|
10187
|
+
/**
|
|
10188
|
+
* @internal
|
|
10189
|
+
*/
|
|
10190
|
+
constructor(opts: __ExceptionOptionType<IntegrationAlreadyExistsFault, __BaseException>);
|
|
10191
|
+
}
|
|
10192
|
+
/**
|
|
10193
|
+
* @public
|
|
10194
|
+
* <p>A conflicting conditional operation is currently in progress against this resource.
|
|
10195
|
+
* Typically occurs when there are multiple requests being made to the same resource at the same time,
|
|
10196
|
+
* and these requests conflict with each other.</p>
|
|
10197
|
+
*/
|
|
10198
|
+
export declare class IntegrationConflictOperationFault extends __BaseException {
|
|
10199
|
+
readonly name: "IntegrationConflictOperationFault";
|
|
10200
|
+
readonly $fault: "client";
|
|
10201
|
+
/**
|
|
10202
|
+
* @internal
|
|
10203
|
+
*/
|
|
10204
|
+
constructor(opts: __ExceptionOptionType<IntegrationConflictOperationFault, __BaseException>);
|
|
10205
|
+
}
|
|
10206
|
+
/**
|
|
10207
|
+
* @public
|
|
10208
|
+
* <p>You can't crate any more zero-ETL integrations because the quota has been reached.</p>
|
|
10209
|
+
*/
|
|
10210
|
+
export declare class IntegrationQuotaExceededFault extends __BaseException {
|
|
10211
|
+
readonly name: "IntegrationQuotaExceededFault";
|
|
10212
|
+
readonly $fault: "client";
|
|
10213
|
+
/**
|
|
10214
|
+
* @internal
|
|
10215
|
+
*/
|
|
10216
|
+
constructor(opts: __ExceptionOptionType<IntegrationQuotaExceededFault, __BaseException>);
|
|
10217
|
+
}
|
|
9984
10218
|
/**
|
|
9985
10219
|
* @public
|
|
9986
10220
|
* <p></p>
|
|
@@ -11136,6 +11370,28 @@ export interface DeleteGlobalClusterResult {
|
|
|
11136
11370
|
*/
|
|
11137
11371
|
GlobalCluster?: GlobalCluster;
|
|
11138
11372
|
}
|
|
11373
|
+
/**
|
|
11374
|
+
* @public
|
|
11375
|
+
*/
|
|
11376
|
+
export interface DeleteIntegrationMessage {
|
|
11377
|
+
/**
|
|
11378
|
+
* @public
|
|
11379
|
+
* <p>The unique identifier of the integration.</p>
|
|
11380
|
+
*/
|
|
11381
|
+
IntegrationIdentifier: string | undefined;
|
|
11382
|
+
}
|
|
11383
|
+
/**
|
|
11384
|
+
* @public
|
|
11385
|
+
* <p>The integration is in an invalid state and can't perform the requested operation.</p>
|
|
11386
|
+
*/
|
|
11387
|
+
export declare class InvalidIntegrationStateFault extends __BaseException {
|
|
11388
|
+
readonly name: "InvalidIntegrationStateFault";
|
|
11389
|
+
readonly $fault: "client";
|
|
11390
|
+
/**
|
|
11391
|
+
* @internal
|
|
11392
|
+
*/
|
|
11393
|
+
constructor(opts: __ExceptionOptionType<InvalidIntegrationStateFault, __BaseException>);
|
|
11394
|
+
}
|
|
11139
11395
|
/**
|
|
11140
11396
|
* @public
|
|
11141
11397
|
* <p></p>
|
|
@@ -11880,426 +12136,3 @@ export interface Parameter {
|
|
|
11880
12136
|
*/
|
|
11881
12137
|
SupportedEngineModes?: string[];
|
|
11882
12138
|
}
|
|
11883
|
-
/**
|
|
11884
|
-
* @public
|
|
11885
|
-
* <p>Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.</p>
|
|
11886
|
-
*/
|
|
11887
|
-
export interface DBClusterParameterGroupDetails {
|
|
11888
|
-
/**
|
|
11889
|
-
* @public
|
|
11890
|
-
* <p>Provides a list of parameters for the DB cluster parameter group.</p>
|
|
11891
|
-
*/
|
|
11892
|
-
Parameters?: Parameter[];
|
|
11893
|
-
/**
|
|
11894
|
-
* @public
|
|
11895
|
-
* <p>An optional pagination token provided by a previous
|
|
11896
|
-
* <code>DescribeDBClusterParameters</code> request.
|
|
11897
|
-
* If this parameter is specified, the response includes
|
|
11898
|
-
* only records beyond the marker,
|
|
11899
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
11900
|
-
*/
|
|
11901
|
-
Marker?: string;
|
|
11902
|
-
}
|
|
11903
|
-
/**
|
|
11904
|
-
* @public
|
|
11905
|
-
* <p></p>
|
|
11906
|
-
*/
|
|
11907
|
-
export interface DescribeDBClusterParametersMessage {
|
|
11908
|
-
/**
|
|
11909
|
-
* @public
|
|
11910
|
-
* <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
|
|
11911
|
-
* <p>Constraints:</p>
|
|
11912
|
-
* <ul>
|
|
11913
|
-
* <li>
|
|
11914
|
-
* <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
|
|
11915
|
-
* </li>
|
|
11916
|
-
* </ul>
|
|
11917
|
-
*/
|
|
11918
|
-
DBClusterParameterGroupName: string | undefined;
|
|
11919
|
-
/**
|
|
11920
|
-
* @public
|
|
11921
|
-
* <p>A specific source to return parameters for.</p>
|
|
11922
|
-
* <p>Valid Values:</p>
|
|
11923
|
-
* <ul>
|
|
11924
|
-
* <li>
|
|
11925
|
-
* <p>
|
|
11926
|
-
* <code>customer</code>
|
|
11927
|
-
* </p>
|
|
11928
|
-
* </li>
|
|
11929
|
-
* <li>
|
|
11930
|
-
* <p>
|
|
11931
|
-
* <code>engine</code>
|
|
11932
|
-
* </p>
|
|
11933
|
-
* </li>
|
|
11934
|
-
* <li>
|
|
11935
|
-
* <p>
|
|
11936
|
-
* <code>service</code>
|
|
11937
|
-
* </p>
|
|
11938
|
-
* </li>
|
|
11939
|
-
* </ul>
|
|
11940
|
-
*/
|
|
11941
|
-
Source?: string;
|
|
11942
|
-
/**
|
|
11943
|
-
* @public
|
|
11944
|
-
* <p>This parameter isn't currently supported.</p>
|
|
11945
|
-
*/
|
|
11946
|
-
Filters?: Filter[];
|
|
11947
|
-
/**
|
|
11948
|
-
* @public
|
|
11949
|
-
* <p>The maximum number of records to include in the response.
|
|
11950
|
-
* If more records exist than the specified <code>MaxRecords</code> value,
|
|
11951
|
-
* a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
|
|
11952
|
-
* <p>Default: 100</p>
|
|
11953
|
-
* <p>Constraints: Minimum 20, maximum 100.</p>
|
|
11954
|
-
*/
|
|
11955
|
-
MaxRecords?: number;
|
|
11956
|
-
/**
|
|
11957
|
-
* @public
|
|
11958
|
-
* <p>An optional pagination token provided by a previous
|
|
11959
|
-
* <code>DescribeDBClusterParameters</code> request.
|
|
11960
|
-
* If this parameter is specified, the response includes
|
|
11961
|
-
* only records beyond the marker,
|
|
11962
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
11963
|
-
*/
|
|
11964
|
-
Marker?: string;
|
|
11965
|
-
}
|
|
11966
|
-
/**
|
|
11967
|
-
* @public
|
|
11968
|
-
* <p>Contains the result of a successful invocation of the <code>DescribeDBClusters</code> action.</p>
|
|
11969
|
-
*/
|
|
11970
|
-
export interface DBClusterMessage {
|
|
11971
|
-
/**
|
|
11972
|
-
* @public
|
|
11973
|
-
* <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
|
|
11974
|
-
*/
|
|
11975
|
-
Marker?: string;
|
|
11976
|
-
/**
|
|
11977
|
-
* @public
|
|
11978
|
-
* <p>Contains a list of DB clusters for the user.</p>
|
|
11979
|
-
*/
|
|
11980
|
-
DBClusters?: DBCluster[];
|
|
11981
|
-
}
|
|
11982
|
-
/**
|
|
11983
|
-
* @public
|
|
11984
|
-
* <p></p>
|
|
11985
|
-
*/
|
|
11986
|
-
export interface DescribeDBClustersMessage {
|
|
11987
|
-
/**
|
|
11988
|
-
* @public
|
|
11989
|
-
* <p>The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified,
|
|
11990
|
-
* information for only the specific DB cluster is returned. This parameter isn't case-sensitive.</p>
|
|
11991
|
-
* <p>Constraints:</p>
|
|
11992
|
-
* <ul>
|
|
11993
|
-
* <li>
|
|
11994
|
-
* <p>If supplied, must match an existing DB cluster identifier.</p>
|
|
11995
|
-
* </li>
|
|
11996
|
-
* </ul>
|
|
11997
|
-
*/
|
|
11998
|
-
DBClusterIdentifier?: string;
|
|
11999
|
-
/**
|
|
12000
|
-
* @public
|
|
12001
|
-
* <p>A filter that specifies one or more DB clusters to describe.</p>
|
|
12002
|
-
* <p>Supported Filters:</p>
|
|
12003
|
-
* <ul>
|
|
12004
|
-
* <li>
|
|
12005
|
-
* <p>
|
|
12006
|
-
* <code>clone-group-id</code> - Accepts clone group identifiers.
|
|
12007
|
-
* The results list only includes information about
|
|
12008
|
-
* the DB clusters associated with these clone groups.</p>
|
|
12009
|
-
* </li>
|
|
12010
|
-
* <li>
|
|
12011
|
-
* <p>
|
|
12012
|
-
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB
|
|
12013
|
-
* cluster Amazon Resource Names (ARNs). The results list only includes information about
|
|
12014
|
-
* the DB clusters identified by these ARNs.</p>
|
|
12015
|
-
* </li>
|
|
12016
|
-
* <li>
|
|
12017
|
-
* <p>
|
|
12018
|
-
* <code>db-cluster-resource-id</code> - Accepts DB cluster resource identifiers.
|
|
12019
|
-
* The results list will only include information about the DB clusters identified
|
|
12020
|
-
* by these DB cluster resource identifiers.</p>
|
|
12021
|
-
* </li>
|
|
12022
|
-
* <li>
|
|
12023
|
-
* <p>
|
|
12024
|
-
* <code>domain</code> - Accepts Active Directory directory IDs.
|
|
12025
|
-
* The results list only includes information about
|
|
12026
|
-
* the DB clusters associated with these domains.</p>
|
|
12027
|
-
* </li>
|
|
12028
|
-
* <li>
|
|
12029
|
-
* <p>
|
|
12030
|
-
* <code>engine</code> - Accepts engine names.
|
|
12031
|
-
* The results list only includes information about
|
|
12032
|
-
* the DB clusters for these engines.</p>
|
|
12033
|
-
* </li>
|
|
12034
|
-
* </ul>
|
|
12035
|
-
*/
|
|
12036
|
-
Filters?: Filter[];
|
|
12037
|
-
/**
|
|
12038
|
-
* @public
|
|
12039
|
-
* <p>The maximum number of records to include in the response.
|
|
12040
|
-
* If more records exist than the specified <code>MaxRecords</code> value,
|
|
12041
|
-
* a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
|
|
12042
|
-
* <p>Default: 100</p>
|
|
12043
|
-
* <p>Constraints: Minimum 20, maximum 100.</p>
|
|
12044
|
-
*/
|
|
12045
|
-
MaxRecords?: number;
|
|
12046
|
-
/**
|
|
12047
|
-
* @public
|
|
12048
|
-
* <p>An optional pagination token provided by a previous
|
|
12049
|
-
* <code>DescribeDBClusters</code> request.
|
|
12050
|
-
* If this parameter is specified, the response includes
|
|
12051
|
-
* only records beyond the marker,
|
|
12052
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
12053
|
-
*/
|
|
12054
|
-
Marker?: string;
|
|
12055
|
-
/**
|
|
12056
|
-
* @public
|
|
12057
|
-
* <p>Specifies whether the output includes information about clusters
|
|
12058
|
-
* shared from other Amazon Web Services accounts.</p>
|
|
12059
|
-
*/
|
|
12060
|
-
IncludeShared?: boolean;
|
|
12061
|
-
}
|
|
12062
|
-
/**
|
|
12063
|
-
* @public
|
|
12064
|
-
* <p></p>
|
|
12065
|
-
*/
|
|
12066
|
-
export interface DescribeDBClusterSnapshotAttributesMessage {
|
|
12067
|
-
/**
|
|
12068
|
-
* @public
|
|
12069
|
-
* <p>The identifier for the DB cluster snapshot to describe the attributes for.</p>
|
|
12070
|
-
*/
|
|
12071
|
-
DBClusterSnapshotIdentifier: string | undefined;
|
|
12072
|
-
}
|
|
12073
|
-
/**
|
|
12074
|
-
* @public
|
|
12075
|
-
* <p>Contains the name and values of a manual DB cluster snapshot attribute.</p>
|
|
12076
|
-
* <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
|
|
12077
|
-
* to restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
|
|
12078
|
-
* API action.</p>
|
|
12079
|
-
*/
|
|
12080
|
-
export interface DBClusterSnapshotAttribute {
|
|
12081
|
-
/**
|
|
12082
|
-
* @public
|
|
12083
|
-
* <p>The name of the manual DB cluster snapshot attribute.</p>
|
|
12084
|
-
* <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
|
|
12085
|
-
* have permission to copy or restore the manual DB cluster snapshot. For more information,
|
|
12086
|
-
* see the <code>ModifyDBClusterSnapshotAttribute</code>
|
|
12087
|
-
* API action.</p>
|
|
12088
|
-
*/
|
|
12089
|
-
AttributeName?: string;
|
|
12090
|
-
/**
|
|
12091
|
-
* @public
|
|
12092
|
-
* <p>The value(s) for the manual DB cluster snapshot attribute.</p>
|
|
12093
|
-
* <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
|
|
12094
|
-
* returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
|
|
12095
|
-
* DB cluster snapshot. If a value of <code>all</code> is in the list, then the manual DB cluster snapshot
|
|
12096
|
-
* is public and available for any Amazon Web Services account to copy or restore.</p>
|
|
12097
|
-
*/
|
|
12098
|
-
AttributeValues?: string[];
|
|
12099
|
-
}
|
|
12100
|
-
/**
|
|
12101
|
-
* @public
|
|
12102
|
-
* <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
|
|
12103
|
-
* API action.</p>
|
|
12104
|
-
* <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
|
|
12105
|
-
* to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
|
|
12106
|
-
* API action.</p>
|
|
12107
|
-
*/
|
|
12108
|
-
export interface DBClusterSnapshotAttributesResult {
|
|
12109
|
-
/**
|
|
12110
|
-
* @public
|
|
12111
|
-
* <p>The identifier of the manual DB cluster snapshot that the attributes apply to.</p>
|
|
12112
|
-
*/
|
|
12113
|
-
DBClusterSnapshotIdentifier?: string;
|
|
12114
|
-
/**
|
|
12115
|
-
* @public
|
|
12116
|
-
* <p>The list of attributes and values for the manual DB cluster snapshot.</p>
|
|
12117
|
-
*/
|
|
12118
|
-
DBClusterSnapshotAttributes?: DBClusterSnapshotAttribute[];
|
|
12119
|
-
}
|
|
12120
|
-
/**
|
|
12121
|
-
* @public
|
|
12122
|
-
*/
|
|
12123
|
-
export interface DescribeDBClusterSnapshotAttributesResult {
|
|
12124
|
-
/**
|
|
12125
|
-
* @public
|
|
12126
|
-
* <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
|
|
12127
|
-
* API action.</p>
|
|
12128
|
-
* <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
|
|
12129
|
-
* to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
|
|
12130
|
-
* API action.</p>
|
|
12131
|
-
*/
|
|
12132
|
-
DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
|
|
12133
|
-
}
|
|
12134
|
-
/**
|
|
12135
|
-
* @public
|
|
12136
|
-
* <p>Provides a list of DB cluster snapshots for the user as the result of a call to the <code>DescribeDBClusterSnapshots</code> action.</p>
|
|
12137
|
-
*/
|
|
12138
|
-
export interface DBClusterSnapshotMessage {
|
|
12139
|
-
/**
|
|
12140
|
-
* @public
|
|
12141
|
-
* <p>An optional pagination token provided by a previous
|
|
12142
|
-
* <code>DescribeDBClusterSnapshots</code> request.
|
|
12143
|
-
* If this parameter is specified, the response includes
|
|
12144
|
-
* only records beyond the marker,
|
|
12145
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
12146
|
-
*/
|
|
12147
|
-
Marker?: string;
|
|
12148
|
-
/**
|
|
12149
|
-
* @public
|
|
12150
|
-
* <p>Provides a list of DB cluster snapshots for the user.</p>
|
|
12151
|
-
*/
|
|
12152
|
-
DBClusterSnapshots?: DBClusterSnapshot[];
|
|
12153
|
-
}
|
|
12154
|
-
/**
|
|
12155
|
-
* @public
|
|
12156
|
-
* <p></p>
|
|
12157
|
-
*/
|
|
12158
|
-
export interface DescribeDBClusterSnapshotsMessage {
|
|
12159
|
-
/**
|
|
12160
|
-
* @public
|
|
12161
|
-
* <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
|
|
12162
|
-
* This parameter can't be used in conjunction with the
|
|
12163
|
-
* <code>DBClusterSnapshotIdentifier</code> parameter.
|
|
12164
|
-
* This parameter isn't case-sensitive.</p>
|
|
12165
|
-
* <p>Constraints:</p>
|
|
12166
|
-
* <ul>
|
|
12167
|
-
* <li>
|
|
12168
|
-
* <p>If supplied, must match the identifier of an existing DBCluster.</p>
|
|
12169
|
-
* </li>
|
|
12170
|
-
* </ul>
|
|
12171
|
-
*/
|
|
12172
|
-
DBClusterIdentifier?: string;
|
|
12173
|
-
/**
|
|
12174
|
-
* @public
|
|
12175
|
-
* <p>A specific DB cluster snapshot identifier to describe.
|
|
12176
|
-
* This parameter can't be used in conjunction with the
|
|
12177
|
-
* <code>DBClusterIdentifier</code> parameter.
|
|
12178
|
-
* This value is stored as a lowercase string.</p>
|
|
12179
|
-
* <p>Constraints:</p>
|
|
12180
|
-
* <ul>
|
|
12181
|
-
* <li>
|
|
12182
|
-
* <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p>
|
|
12183
|
-
* </li>
|
|
12184
|
-
* <li>
|
|
12185
|
-
* <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p>
|
|
12186
|
-
* </li>
|
|
12187
|
-
* </ul>
|
|
12188
|
-
*/
|
|
12189
|
-
DBClusterSnapshotIdentifier?: string;
|
|
12190
|
-
/**
|
|
12191
|
-
* @public
|
|
12192
|
-
* <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
|
|
12193
|
-
* <ul>
|
|
12194
|
-
* <li>
|
|
12195
|
-
* <p>
|
|
12196
|
-
* <code>automated</code> - Return all DB cluster snapshots that have been automatically taken by
|
|
12197
|
-
* Amazon RDS for my Amazon Web Services account.</p>
|
|
12198
|
-
* </li>
|
|
12199
|
-
* <li>
|
|
12200
|
-
* <p>
|
|
12201
|
-
* <code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.</p>
|
|
12202
|
-
* </li>
|
|
12203
|
-
* <li>
|
|
12204
|
-
* <p>
|
|
12205
|
-
* <code>shared</code> - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.</p>
|
|
12206
|
-
* </li>
|
|
12207
|
-
* <li>
|
|
12208
|
-
* <p>
|
|
12209
|
-
* <code>public</code> - Return all DB cluster snapshots that have been marked as public.</p>
|
|
12210
|
-
* </li>
|
|
12211
|
-
* </ul>
|
|
12212
|
-
* <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are
|
|
12213
|
-
* returned. You can include shared DB cluster snapshots with these results by enabling the <code>IncludeShared</code>
|
|
12214
|
-
* parameter. You can include public DB cluster snapshots with these results by enabling the
|
|
12215
|
-
* <code>IncludePublic</code> parameter.</p>
|
|
12216
|
-
* <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values
|
|
12217
|
-
* of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is
|
|
12218
|
-
* set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to
|
|
12219
|
-
* <code>public</code>.</p>
|
|
12220
|
-
*/
|
|
12221
|
-
SnapshotType?: string;
|
|
12222
|
-
/**
|
|
12223
|
-
* @public
|
|
12224
|
-
* <p>A filter that specifies one or more DB cluster snapshots to describe.</p>
|
|
12225
|
-
* <p>Supported filters:</p>
|
|
12226
|
-
* <ul>
|
|
12227
|
-
* <li>
|
|
12228
|
-
* <p>
|
|
12229
|
-
* <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB
|
|
12230
|
-
* cluster Amazon Resource Names (ARNs).</p>
|
|
12231
|
-
* </li>
|
|
12232
|
-
* <li>
|
|
12233
|
-
* <p>
|
|
12234
|
-
* <code>db-cluster-snapshot-id</code> - Accepts DB cluster snapshot identifiers.</p>
|
|
12235
|
-
* </li>
|
|
12236
|
-
* <li>
|
|
12237
|
-
* <p>
|
|
12238
|
-
* <code>snapshot-type</code> - Accepts types of DB cluster snapshots.</p>
|
|
12239
|
-
* </li>
|
|
12240
|
-
* <li>
|
|
12241
|
-
* <p>
|
|
12242
|
-
* <code>engine</code> - Accepts names of database engines.</p>
|
|
12243
|
-
* </li>
|
|
12244
|
-
* </ul>
|
|
12245
|
-
*/
|
|
12246
|
-
Filters?: Filter[];
|
|
12247
|
-
/**
|
|
12248
|
-
* @public
|
|
12249
|
-
* <p>The maximum number of records to include in the response.
|
|
12250
|
-
* If more records exist than the specified <code>MaxRecords</code> value,
|
|
12251
|
-
* a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
|
|
12252
|
-
* <p>Default: 100</p>
|
|
12253
|
-
* <p>Constraints: Minimum 20, maximum 100.</p>
|
|
12254
|
-
*/
|
|
12255
|
-
MaxRecords?: number;
|
|
12256
|
-
/**
|
|
12257
|
-
* @public
|
|
12258
|
-
* <p>An optional pagination token provided by a previous
|
|
12259
|
-
* <code>DescribeDBClusterSnapshots</code> request.
|
|
12260
|
-
* If this parameter is specified, the response includes
|
|
12261
|
-
* only records beyond the marker,
|
|
12262
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
12263
|
-
*/
|
|
12264
|
-
Marker?: string;
|
|
12265
|
-
/**
|
|
12266
|
-
* @public
|
|
12267
|
-
* <p>Specifies whether to include shared manual DB cluster snapshots
|
|
12268
|
-
* from other Amazon Web Services accounts that this Amazon Web Services account has been given
|
|
12269
|
-
* permission to copy or restore. By default, these snapshots are not included.</p>
|
|
12270
|
-
* <p>You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from
|
|
12271
|
-
* another Amazon Web Services account by the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
|
|
12272
|
-
*/
|
|
12273
|
-
IncludeShared?: boolean;
|
|
12274
|
-
/**
|
|
12275
|
-
* @public
|
|
12276
|
-
* <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied
|
|
12277
|
-
* or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
|
|
12278
|
-
* <p>You can share a manual DB cluster snapshot as public by using the <a>ModifyDBClusterSnapshotAttribute</a> API action.</p>
|
|
12279
|
-
*/
|
|
12280
|
-
IncludePublic?: boolean;
|
|
12281
|
-
/**
|
|
12282
|
-
* @public
|
|
12283
|
-
* <p>A specific DB cluster resource ID to describe.</p>
|
|
12284
|
-
*/
|
|
12285
|
-
DbClusterResourceId?: string;
|
|
12286
|
-
}
|
|
12287
|
-
/**
|
|
12288
|
-
* @public
|
|
12289
|
-
* <p>Contains the result of a successful invocation of the <code>DescribeDBEngineVersions</code> action.</p>
|
|
12290
|
-
*/
|
|
12291
|
-
export interface DBEngineVersionMessage {
|
|
12292
|
-
/**
|
|
12293
|
-
* @public
|
|
12294
|
-
* <p>An optional pagination token provided by a previous request.
|
|
12295
|
-
* If this parameter is specified, the response includes
|
|
12296
|
-
* only records beyond the marker,
|
|
12297
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
12298
|
-
*/
|
|
12299
|
-
Marker?: string;
|
|
12300
|
-
/**
|
|
12301
|
-
* @public
|
|
12302
|
-
* <p>A list of <code>DBEngineVersion</code> elements.</p>
|
|
12303
|
-
*/
|
|
12304
|
-
DBEngineVersions?: DBEngineVersion[];
|
|
12305
|
-
}
|