@aws-sdk/client-rds 3.37.0 → 3.41.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/CHANGELOG.md +45 -0
- package/dist-cjs/RDS.js +45 -0
- package/dist-cjs/commands/CreateCustomDBEngineVersionCommand.js +36 -0
- package/dist-cjs/commands/DeleteCustomDBEngineVersionCommand.js +36 -0
- package/dist-cjs/commands/DescribeDBProxyTargetsCommand.js +2 -1
- package/dist-cjs/commands/ModifyCustomDBEngineVersionCommand.js +37 -0
- package/dist-cjs/commands/index.js +143 -0
- package/dist-cjs/endpoints.js +166 -27
- package/dist-cjs/index.js +5 -181
- package/dist-cjs/models/models_0.js +70 -73
- package/dist-cjs/models/models_1.js +60 -4
- package/dist-cjs/pagination/index.js +39 -0
- package/dist-cjs/protocols/Aws_query.js +426 -6
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-cjs/waiters/index.js +9 -0
- package/dist-es/RDS.js +45 -0
- package/dist-es/commands/CreateCustomDBEngineVersionCommand.js +39 -0
- package/dist-es/commands/DeleteCustomDBEngineVersionCommand.js +39 -0
- package/dist-es/commands/DescribeDBProxyTargetsCommand.js +2 -1
- package/dist-es/commands/ModifyCustomDBEngineVersionCommand.js +40 -0
- package/dist-es/commands/index.js +140 -0
- package/dist-es/endpoints.js +166 -27
- package/dist-es/index.js +5 -181
- package/dist-es/models/models_0.js +45 -54
- package/dist-es/models/models_1.js +48 -0
- package/dist-es/pagination/index.js +36 -0
- package/dist-es/protocols/Aws_query.js +431 -0
- package/dist-es/runtimeConfig.browser.js +3 -2
- package/dist-es/runtimeConfig.js +3 -3
- package/dist-es/waiters/index.js +6 -0
- package/dist-types/RDS.d.ts +103 -13
- package/dist-types/RDSClient.d.ts +13 -2
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +2 -1
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +1 -1
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +1 -1
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +1 -1
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/CancelExportTaskCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +2 -3
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +3 -1
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomAvailabilityZoneCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +62 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +5 -4
- package/dist-types/commands/CreateDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomAvailabilityZoneCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +55 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCustomAvailabilityZonesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
- 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 +1 -1
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +4 -5
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +2 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/ImportInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +46 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +3 -2
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +2 -2
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +1 -1
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +3 -1
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +1 -1
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +2 -1
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +1 -1
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +1 -1
- package/dist-types/commands/StartActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/StartDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +2 -1
- package/dist-types/commands/StartDBInstanceCommand.d.ts +2 -2
- package/dist-types/commands/StartExportTaskCommand.d.ts +2 -1
- package/dist-types/commands/StopActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/StopDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +2 -1
- package/dist-types/commands/StopDBInstanceCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +140 -0
- package/dist-types/index.d.ts +5 -181
- package/dist-types/models/models_0.d.ts +697 -410
- package/dist-types/models/models_1.d.ts +468 -137
- package/dist-types/pagination/index.d.ts +36 -0
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/RDS.d.ts +15 -0
- package/dist-types/ts3.4/RDSClient.d.ts +9 -2
- package/dist-types/ts3.4/commands/CreateCustomDBEngineVersionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteCustomDBEngineVersionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeDBProxyTargetsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ModifyCustomDBEngineVersionCommand.d.ts +18 -0
- package/dist-types/ts3.4/commands/index.d.ts +140 -0
- package/dist-types/ts3.4/index.d.ts +5 -181
- package/dist-types/ts3.4/models/models_0.d.ts +190 -154
- package/dist-types/ts3.4/models/models_1.d.ts +97 -2
- package/dist-types/ts3.4/pagination/index.d.ts +36 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/waiters/index.d.ts +6 -0
- package/dist-types/waiters/index.d.ts +6 -0
- package/package.json +28 -28
|
@@ -1,5 +1,122 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
import { ActivityStreamMode, ActivityStreamStatus, AvailabilityZone, Certificate, DBCluster, DBClusterSnapshotAttributesResult, DBInstance, DBInstanceAutomatedBackup, DBProxy, DBProxyEndpoint,
|
|
2
|
+
import { ActivityStreamMode, ActivityStreamStatus, AutomationMode, AvailabilityZone, Certificate, DBCluster, DBClusterSnapshotAttributesResult, DBInstance, DBInstanceAutomatedBackup, DBProxy, DBProxyEndpoint, DBProxyTargetGroup, DBSecurityGroup, DBSnapshot, DBSubnetGroup, EventSubscription, ExportTask, Filter, GlobalCluster, InstallationMedia, OptionGroup, OptionSetting, Parameter, ProcessorFeature, ReplicaMode, ResourcePendingMaintenanceActions, ScalingConfiguration, Tag, UserAuthConfig } from "./models_0";
|
|
3
|
+
export declare enum TargetRole {
|
|
4
|
+
READ_ONLY = "READ_ONLY",
|
|
5
|
+
READ_WRITE = "READ_WRITE",
|
|
6
|
+
UNKNOWN = "UNKNOWN"
|
|
7
|
+
}
|
|
8
|
+
export declare enum TargetHealthReason {
|
|
9
|
+
AUTH_FAILURE = "AUTH_FAILURE",
|
|
10
|
+
CONNECTION_FAILED = "CONNECTION_FAILED",
|
|
11
|
+
INVALID_REPLICATION_STATE = "INVALID_REPLICATION_STATE",
|
|
12
|
+
PENDING_PROXY_CAPACITY = "PENDING_PROXY_CAPACITY",
|
|
13
|
+
UNREACHABLE = "UNREACHABLE"
|
|
14
|
+
}
|
|
15
|
+
export declare enum TargetState {
|
|
16
|
+
available = "AVAILABLE",
|
|
17
|
+
registering = "REGISTERING",
|
|
18
|
+
unavailable = "UNAVAILABLE"
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* <p>Information about the connection health of an RDS Proxy target.</p>
|
|
22
|
+
*/
|
|
23
|
+
export interface TargetHealth {
|
|
24
|
+
/**
|
|
25
|
+
* <p>The current state of the connection health lifecycle for the RDS Proxy target.
|
|
26
|
+
* The following is a typical lifecycle example for the states of an RDS Proxy target:
|
|
27
|
+
* </p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <code>registering</code> > <code>unavailable</code> > <code>available</code> > <code>unavailable</code> > <code>available</code>
|
|
30
|
+
* </p>
|
|
31
|
+
*/
|
|
32
|
+
State?: TargetState | string;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The reason for the current health <code>State</code> of the RDS Proxy target.</p>
|
|
35
|
+
*/
|
|
36
|
+
Reason?: TargetHealthReason | string;
|
|
37
|
+
/**
|
|
38
|
+
* <p>A description of the health of the RDS Proxy target.
|
|
39
|
+
* If the <code>State</code> is <code>AVAILABLE</code>, a description is not included.</p>
|
|
40
|
+
*/
|
|
41
|
+
Description?: string;
|
|
42
|
+
}
|
|
43
|
+
export declare namespace TargetHealth {
|
|
44
|
+
/**
|
|
45
|
+
* @internal
|
|
46
|
+
*/
|
|
47
|
+
const filterSensitiveLog: (obj: TargetHealth) => any;
|
|
48
|
+
}
|
|
49
|
+
export declare enum TargetType {
|
|
50
|
+
RDS_INSTANCE = "RDS_INSTANCE",
|
|
51
|
+
RDS_SERVERLESS_ENDPOINT = "RDS_SERVERLESS_ENDPOINT",
|
|
52
|
+
TRACKED_CLUSTER = "TRACKED_CLUSTER"
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* <p>Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster
|
|
56
|
+
* that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.</p>
|
|
57
|
+
* <p>This data type is used as a response element in the <code>DescribeDBProxyTargets</code> action.</p>
|
|
58
|
+
*/
|
|
59
|
+
export interface DBProxyTarget {
|
|
60
|
+
/**
|
|
61
|
+
* <p>The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.</p>
|
|
62
|
+
*/
|
|
63
|
+
TargetArn?: string;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The writer endpoint for the RDS DB instance or Aurora DB cluster.</p>
|
|
66
|
+
*/
|
|
67
|
+
Endpoint?: string;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.</p>
|
|
70
|
+
*/
|
|
71
|
+
TrackedClusterId?: string;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The identifier representing the target. It can be the instance identifier for an RDS DB instance,
|
|
74
|
+
* or the cluster identifier for an Aurora DB cluster.</p>
|
|
75
|
+
*/
|
|
76
|
+
RdsResourceId?: string;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.</p>
|
|
79
|
+
*/
|
|
80
|
+
Port?: number;
|
|
81
|
+
/**
|
|
82
|
+
* <p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>
|
|
83
|
+
*/
|
|
84
|
+
Type?: TargetType | string;
|
|
85
|
+
/**
|
|
86
|
+
* <p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</p>
|
|
87
|
+
*/
|
|
88
|
+
Role?: TargetRole | string;
|
|
89
|
+
/**
|
|
90
|
+
* <p>Information about the connection health of the RDS Proxy target.</p>
|
|
91
|
+
*/
|
|
92
|
+
TargetHealth?: TargetHealth;
|
|
93
|
+
}
|
|
94
|
+
export declare namespace DBProxyTarget {
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
const filterSensitiveLog: (obj: DBProxyTarget) => any;
|
|
99
|
+
}
|
|
100
|
+
export interface DescribeDBProxyTargetsResponse {
|
|
101
|
+
/**
|
|
102
|
+
* <p>An arbitrary number of <code>DBProxyTarget</code> objects, containing details of the corresponding targets.</p>
|
|
103
|
+
*/
|
|
104
|
+
Targets?: DBProxyTarget[];
|
|
105
|
+
/**
|
|
106
|
+
* <p>
|
|
107
|
+
* An optional pagination token provided by a previous request.
|
|
108
|
+
* If this parameter is specified, the response includes only records beyond the marker,
|
|
109
|
+
* up to the value specified by <code>MaxRecords</code>.
|
|
110
|
+
* </p>
|
|
111
|
+
*/
|
|
112
|
+
Marker?: string;
|
|
113
|
+
}
|
|
114
|
+
export declare namespace DescribeDBProxyTargetsResponse {
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
const filterSensitiveLog: (obj: DescribeDBProxyTargetsResponse) => any;
|
|
119
|
+
}
|
|
3
120
|
/**
|
|
4
121
|
* <p>
|
|
5
122
|
* Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.
|
|
@@ -310,12 +427,14 @@ export interface DescribeDBSnapshotsMessage {
|
|
|
310
427
|
* permission to copy or restore. By default, these snapshots are not included.</p>
|
|
311
428
|
* <p>You can give an Amazon Web Services account permission to restore a manual DB snapshot from
|
|
312
429
|
* another Amazon Web Services account by using the <code>ModifyDBSnapshotAttribute</code> API action.</p>
|
|
430
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
313
431
|
*/
|
|
314
432
|
IncludeShared?: boolean;
|
|
315
433
|
/**
|
|
316
434
|
* <p>A value that indicates whether to include manual DB cluster snapshots that are public and can be copied
|
|
317
435
|
* or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
|
|
318
436
|
* <p>You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API.</p>
|
|
437
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
319
438
|
*/
|
|
320
439
|
IncludePublic?: boolean;
|
|
321
440
|
/**
|
|
@@ -588,7 +707,7 @@ export declare namespace EventCategoriesMessage {
|
|
|
588
707
|
*/
|
|
589
708
|
const filterSensitiveLog: (obj: EventCategoriesMessage) => any;
|
|
590
709
|
}
|
|
591
|
-
export declare type SourceType = "db-cluster" | "db-cluster-snapshot" | "db-instance" | "db-parameter-group" | "db-security-group" | "db-snapshot";
|
|
710
|
+
export declare type SourceType = "custom-engine-version" | "db-cluster" | "db-cluster-snapshot" | "db-instance" | "db-parameter-group" | "db-security-group" | "db-snapshot";
|
|
592
711
|
/**
|
|
593
712
|
* <p></p>
|
|
594
713
|
*/
|
|
@@ -846,7 +965,34 @@ export interface DescribeExportTasksMessage {
|
|
|
846
965
|
* </li>
|
|
847
966
|
* <li>
|
|
848
967
|
* <p>
|
|
849
|
-
* <code>status</code> - The status of the export task. Must be lowercase
|
|
968
|
+
* <code>status</code> - The status of the export task. Must be lowercase. Valid statuses are the following:</p>
|
|
969
|
+
* <ul>
|
|
970
|
+
* <li>
|
|
971
|
+
* <p>
|
|
972
|
+
* <code>canceled</code>
|
|
973
|
+
* </p>
|
|
974
|
+
* </li>
|
|
975
|
+
* <li>
|
|
976
|
+
* <p>
|
|
977
|
+
* <code>canceling</code>
|
|
978
|
+
* </p>
|
|
979
|
+
* </li>
|
|
980
|
+
* <li>
|
|
981
|
+
* <p>
|
|
982
|
+
* <code>complete</code>
|
|
983
|
+
* </p>
|
|
984
|
+
* </li>
|
|
985
|
+
* <li>
|
|
986
|
+
* <p>
|
|
987
|
+
* <code>failed</code>
|
|
988
|
+
* </p>
|
|
989
|
+
* </li>
|
|
990
|
+
* <li>
|
|
991
|
+
* <p>
|
|
992
|
+
* <code>starting</code>
|
|
993
|
+
* </p>
|
|
994
|
+
* </li>
|
|
995
|
+
* </ul>
|
|
850
996
|
* </li>
|
|
851
997
|
* </ul>
|
|
852
998
|
*/
|
|
@@ -1527,16 +1673,22 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
|
|
|
1527
1673
|
*/
|
|
1528
1674
|
DBInstanceClass?: string;
|
|
1529
1675
|
/**
|
|
1530
|
-
* <p>The license model filter value. Specify this parameter to show only the available offerings
|
|
1676
|
+
* <p>The license model filter value. Specify this parameter to show only the available offerings
|
|
1677
|
+
* matching the specified license model.</p>
|
|
1678
|
+
* <p>RDS Custom supports only the BYOL licensing model.</p>
|
|
1531
1679
|
*/
|
|
1532
1680
|
LicenseModel?: string;
|
|
1533
1681
|
/**
|
|
1534
1682
|
* <p>The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.</p>
|
|
1535
1683
|
* <p>Omit this parameter to show the available offerings in the specified Amazon Web Services Region.</p>
|
|
1684
|
+
* <p> This setting doesn't apply to RDS Custom.</p>
|
|
1536
1685
|
*/
|
|
1537
1686
|
AvailabilityZoneGroup?: string;
|
|
1538
1687
|
/**
|
|
1539
|
-
* <p>A value that indicates whether to show only VPC or non-VPC offerings
|
|
1688
|
+
* <p>A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports
|
|
1689
|
+
* only VPC offerings.</p>
|
|
1690
|
+
* <p>RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output
|
|
1691
|
+
* shows VPC offerings.</p>
|
|
1540
1692
|
*/
|
|
1541
1693
|
Vpc?: boolean;
|
|
1542
1694
|
/**
|
|
@@ -2886,6 +3038,54 @@ export declare namespace ModifyCurrentDBClusterCapacityMessage {
|
|
|
2886
3038
|
*/
|
|
2887
3039
|
const filterSensitiveLog: (obj: ModifyCurrentDBClusterCapacityMessage) => any;
|
|
2888
3040
|
}
|
|
3041
|
+
export declare enum CustomEngineVersionStatus {
|
|
3042
|
+
available = "available",
|
|
3043
|
+
inactive = "inactive",
|
|
3044
|
+
inactive_except_restore = "inactive-except-restore"
|
|
3045
|
+
}
|
|
3046
|
+
export interface ModifyCustomDBEngineVersionMessage {
|
|
3047
|
+
/**
|
|
3048
|
+
* <p>The DB engine. The only supported value is <code>custom-oracle-ee</code>.</p>
|
|
3049
|
+
*/
|
|
3050
|
+
Engine: string | undefined;
|
|
3051
|
+
/**
|
|
3052
|
+
* <p>The custom engine version (CEV) that you want to modify. This option is required for
|
|
3053
|
+
* RDS Custom, but optional for Amazon RDS. The combination of <code>Engine</code> and
|
|
3054
|
+
* <code>EngineVersion</code> is unique per customer per Amazon Web Services Region.</p>
|
|
3055
|
+
*/
|
|
3056
|
+
EngineVersion: string | undefined;
|
|
3057
|
+
/**
|
|
3058
|
+
* <p>An optional description of your CEV.</p>
|
|
3059
|
+
*/
|
|
3060
|
+
Description?: string;
|
|
3061
|
+
/**
|
|
3062
|
+
* <p>The availability status to be assigned to the CEV. Valid values are as follows:</p>
|
|
3063
|
+
* <dl>
|
|
3064
|
+
* <dt>available</dt>
|
|
3065
|
+
* <dd>
|
|
3066
|
+
* <p>You can use this CEV to create a new RDS Custom DB instance.</p>
|
|
3067
|
+
* </dd>
|
|
3068
|
+
* <dt>inactive</dt>
|
|
3069
|
+
* <dd>
|
|
3070
|
+
* <p>You can create a new RDS Custom instance by restoring a DB snapshot with this CEV.
|
|
3071
|
+
* You can't patch or create new instances with this CEV.</p>
|
|
3072
|
+
* </dd>
|
|
3073
|
+
* </dl>
|
|
3074
|
+
* <p>You can change any status to any status. A typical reason to change status is to prevent the accidental
|
|
3075
|
+
* use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status
|
|
3076
|
+
* of your CEV from <code>available</code> to <code>inactive</code>, and from <code>inactive</code> back to
|
|
3077
|
+
* <code>available</code>. To change the availability status of the CEV, it must not currently be in use by an
|
|
3078
|
+
* RDS Custom instance, snapshot, or automated backup.
|
|
3079
|
+
* </p>
|
|
3080
|
+
*/
|
|
3081
|
+
Status?: CustomEngineVersionStatus | string;
|
|
3082
|
+
}
|
|
3083
|
+
export declare namespace ModifyCustomDBEngineVersionMessage {
|
|
3084
|
+
/**
|
|
3085
|
+
* @internal
|
|
3086
|
+
*/
|
|
3087
|
+
const filterSensitiveLog: (obj: ModifyCustomDBEngineVersionMessage) => any;
|
|
3088
|
+
}
|
|
2889
3089
|
/**
|
|
2890
3090
|
* <p>The configuration setting for the log types to be enabled for export to CloudWatch
|
|
2891
3091
|
* Logs for a specific DB instance or DB cluster.</p>
|
|
@@ -3394,12 +3594,13 @@ export interface ModifyDBInstanceMessage {
|
|
|
3394
3594
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
3395
3595
|
* For the full list of DB instance classes,
|
|
3396
3596
|
* and availability for your engine, see
|
|
3397
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance Class</a> in the <i>Amazon RDS User Guide
|
|
3398
|
-
*
|
|
3597
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.
|
|
3598
|
+
* </p>
|
|
3399
3599
|
* <p>If you modify the DB instance class, an outage occurs during the change.
|
|
3400
3600
|
* The change is applied during the next maintenance window,
|
|
3401
3601
|
* unless <code>ApplyImmediately</code> is enabled for this request.
|
|
3402
3602
|
* </p>
|
|
3603
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3403
3604
|
* <p>Default: Uses existing setting</p>
|
|
3404
3605
|
*/
|
|
3405
3606
|
DBInstanceClass?: string;
|
|
@@ -3410,19 +3611,21 @@ export interface ModifyDBInstanceMessage {
|
|
|
3410
3611
|
* If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.
|
|
3411
3612
|
* For more information, see
|
|
3412
3613
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC">Working with a DB instance in a VPC</a>
|
|
3413
|
-
* in the <i>Amazon RDS User Guide
|
|
3414
|
-
*
|
|
3614
|
+
* in the <i>Amazon RDS User Guide</i>.
|
|
3615
|
+
* </p>
|
|
3415
3616
|
* <p>Changing the subnet group causes an outage during the change.
|
|
3416
3617
|
* The change is applied during the next maintenance window,
|
|
3417
|
-
* unless you enable <code>ApplyImmediately</code
|
|
3418
|
-
*
|
|
3618
|
+
* unless you enable <code>ApplyImmediately</code>.</p>
|
|
3619
|
+
* <p> This parameter doesn't apply to RDS Custom.</p>
|
|
3419
3620
|
* <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p>
|
|
3420
3621
|
* <p>Example: <code>mySubnetGroup</code>
|
|
3421
3622
|
* </p>
|
|
3422
3623
|
*/
|
|
3423
3624
|
DBSubnetGroupName?: string;
|
|
3424
3625
|
/**
|
|
3425
|
-
* <p>A list of DB security groups to authorize on this DB instance. Changing this setting doesn't
|
|
3626
|
+
* <p>A list of DB security groups to authorize on this DB instance. Changing this setting doesn't
|
|
3627
|
+
* result in an outage and the change is asynchronously applied as soon as possible.</p>
|
|
3628
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3426
3629
|
* <p>Constraints:</p>
|
|
3427
3630
|
* <ul>
|
|
3428
3631
|
* <li>
|
|
@@ -3432,7 +3635,9 @@ export interface ModifyDBInstanceMessage {
|
|
|
3432
3635
|
*/
|
|
3433
3636
|
DBSecurityGroups?: string[];
|
|
3434
3637
|
/**
|
|
3435
|
-
* <p>A list of EC2 VPC security groups to authorize on this DB instance. This change is
|
|
3638
|
+
* <p>A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is
|
|
3639
|
+
* asynchronously applied as soon as possible.</p>
|
|
3640
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3436
3641
|
* <p>
|
|
3437
3642
|
* <b>Amazon Aurora</b>
|
|
3438
3643
|
* </p>
|
|
@@ -3464,14 +3669,15 @@ export interface ModifyDBInstanceMessage {
|
|
|
3464
3669
|
*/
|
|
3465
3670
|
ApplyImmediately?: boolean;
|
|
3466
3671
|
/**
|
|
3467
|
-
* <p>The new password for the master user. The password can include any printable ASCII
|
|
3672
|
+
* <p>The new password for the master user. The password can include any printable ASCII
|
|
3673
|
+
* character except "/", """, or "@".</p>
|
|
3468
3674
|
* <p>
|
|
3469
3675
|
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
|
|
3470
3676
|
* Between the time of the request and the completion of the request,
|
|
3471
3677
|
* the <code>MasterUserPassword</code> element exists in the
|
|
3472
|
-
*
|
|
3473
|
-
*
|
|
3474
|
-
*
|
|
3678
|
+
* <code>PendingModifiedValues</code> element of the operation response.
|
|
3679
|
+
* </p>
|
|
3680
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3475
3681
|
* <p>
|
|
3476
3682
|
* <b>Amazon Aurora</b>
|
|
3477
3683
|
* </p>
|
|
@@ -3515,13 +3721,16 @@ export interface ModifyDBInstanceMessage {
|
|
|
3515
3721
|
*/
|
|
3516
3722
|
MasterUserPassword?: string;
|
|
3517
3723
|
/**
|
|
3518
|
-
* <p>The name of the DB parameter group to apply to the DB instance
|
|
3519
|
-
*
|
|
3520
|
-
*
|
|
3521
|
-
*
|
|
3522
|
-
*
|
|
3724
|
+
* <p>The name of the DB parameter group to apply to the DB instance.</p>
|
|
3725
|
+
* <p>Changing this setting doesn't result in an outage. The parameter group name itself is changed
|
|
3726
|
+
* immediately, but the actual parameter changes are not applied until you reboot the
|
|
3727
|
+
* instance without failover. In this case, the DB instance isn't rebooted automatically, and the
|
|
3728
|
+
* parameter changes aren't applied during the next maintenance window. However, if you modify
|
|
3729
|
+
* dynamic parameters in the newly associated DB parameter group, these changes are applied
|
|
3730
|
+
* immediately without a reboot.</p>
|
|
3731
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3523
3732
|
* <p>Default: Uses existing setting</p>
|
|
3524
|
-
* <p>Constraints: The DB parameter group must be in the same DB parameter group family as
|
|
3733
|
+
* <p>Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.</p>
|
|
3525
3734
|
*/
|
|
3526
3735
|
DBParameterGroupName?: string;
|
|
3527
3736
|
/**
|
|
@@ -3541,18 +3750,16 @@ export interface ModifyDBInstanceMessage {
|
|
|
3541
3750
|
* <p>Constraints:</p>
|
|
3542
3751
|
* <ul>
|
|
3543
3752
|
* <li>
|
|
3544
|
-
* <p>
|
|
3545
|
-
*
|
|
3546
|
-
* <li>
|
|
3547
|
-
* <p>Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or
|
|
3548
|
-
* later</p>
|
|
3753
|
+
* <p>It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to
|
|
3754
|
+
* read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.</p>
|
|
3549
3755
|
* </li>
|
|
3550
3756
|
* <li>
|
|
3551
|
-
* <p>
|
|
3552
|
-
*
|
|
3757
|
+
* <p>It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or
|
|
3758
|
+
* later.</p>
|
|
3553
3759
|
* </li>
|
|
3554
3760
|
* <li>
|
|
3555
|
-
* <p>
|
|
3761
|
+
* <p>It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL
|
|
3762
|
+
* 9.3.5.</p>
|
|
3556
3763
|
* </li>
|
|
3557
3764
|
* </ul>
|
|
3558
3765
|
*/
|
|
@@ -3608,12 +3815,11 @@ export interface ModifyDBInstanceMessage {
|
|
|
3608
3815
|
*/
|
|
3609
3816
|
PreferredMaintenanceWindow?: string;
|
|
3610
3817
|
/**
|
|
3611
|
-
* <p>A value that indicates whether the DB instance is a Multi-AZ deployment.
|
|
3612
|
-
*
|
|
3613
|
-
*
|
|
3614
|
-
*
|
|
3615
|
-
*
|
|
3616
|
-
* </p>
|
|
3818
|
+
* <p>A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
|
|
3819
|
+
* in an outage. The change is applied during the next maintenance window unless the <code>ApplyImmediately</code>
|
|
3820
|
+
* parameter is enabled for this request.
|
|
3821
|
+
* </p>
|
|
3822
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3617
3823
|
*/
|
|
3618
3824
|
MultiAZ?: boolean;
|
|
3619
3825
|
/**
|
|
@@ -3631,26 +3837,42 @@ export interface ModifyDBInstanceMessage {
|
|
|
3631
3837
|
* default minor version if the current minor version is lower.
|
|
3632
3838
|
* For information about valid engine versions, see <code>CreateDBInstance</code>,
|
|
3633
3839
|
* or call <code>DescribeDBEngineVersions</code>.</p>
|
|
3840
|
+
* <p>In RDS Custom, this parameter is supported for read replicas only if they are in the
|
|
3841
|
+
* <code>PATCH_DB_FAILURE</code> lifecycle.
|
|
3842
|
+
* </p>
|
|
3634
3843
|
*/
|
|
3635
3844
|
EngineVersion?: string;
|
|
3636
3845
|
/**
|
|
3637
|
-
* <p>A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't
|
|
3638
|
-
*
|
|
3846
|
+
* <p>A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't
|
|
3847
|
+
* result in an outage and the change is asynchronously applied as soon as possible.</p>
|
|
3848
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3849
|
+
* <p>Constraints: Major version upgrades must be allowed when specifying a value
|
|
3850
|
+
* for the EngineVersion parameter that is a different major version than the DB instance's current version.</p>
|
|
3639
3851
|
*/
|
|
3640
3852
|
AllowMajorVersionUpgrade?: boolean;
|
|
3641
3853
|
/**
|
|
3642
|
-
* <p>
|
|
3643
|
-
*
|
|
3644
|
-
*
|
|
3645
|
-
*
|
|
3646
|
-
*
|
|
3647
|
-
*
|
|
3648
|
-
*
|
|
3649
|
-
*
|
|
3854
|
+
* <p>A value that indicates whether minor version upgrades are applied automatically to the DB instance
|
|
3855
|
+
* during the maintenance window. An outage occurs when all the following conditions are met:</p>
|
|
3856
|
+
* <ul>
|
|
3857
|
+
* <li>
|
|
3858
|
+
* <p>The automatic upgrade is enabled for the maintenance window.</p>
|
|
3859
|
+
* </li>
|
|
3860
|
+
* <li>
|
|
3861
|
+
* <p>A newer minor version is available.</p>
|
|
3862
|
+
* </li>
|
|
3863
|
+
* <li>
|
|
3864
|
+
* <p>RDS has enabled automatic patching for the engine version.</p>
|
|
3865
|
+
* </li>
|
|
3866
|
+
* </ul>
|
|
3867
|
+
* <p>If any of the preceding conditions isn't met, RDS applies the change as soon as possible and
|
|
3868
|
+
* doesn't cause an outage.</p>
|
|
3869
|
+
* <p>For an RDS Custom DB instance, set <code>AutoMinorVersionUpgrade</code>
|
|
3870
|
+
* to <code>false</code>. Otherwise, the operation returns an error.</p>
|
|
3650
3871
|
*/
|
|
3651
3872
|
AutoMinorVersionUpgrade?: boolean;
|
|
3652
3873
|
/**
|
|
3653
3874
|
* <p>The license model for the DB instance.</p>
|
|
3875
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3654
3876
|
* <p>Valid values: <code>license-included</code> | <code>bring-your-own-license</code> |
|
|
3655
3877
|
* <code>general-public-license</code>
|
|
3656
3878
|
* </p>
|
|
@@ -3684,27 +3906,24 @@ export interface ModifyDBInstanceMessage {
|
|
|
3684
3906
|
*/
|
|
3685
3907
|
Iops?: number;
|
|
3686
3908
|
/**
|
|
3687
|
-
* <p>
|
|
3688
|
-
*
|
|
3689
|
-
*
|
|
3690
|
-
*
|
|
3691
|
-
*
|
|
3692
|
-
*
|
|
3693
|
-
*
|
|
3694
|
-
*
|
|
3695
|
-
*
|
|
3696
|
-
* <p>
|
|
3909
|
+
* <p>A value that indicates the DB instance should be associated with the specified option group.</p>
|
|
3910
|
+
* <p>Changing this parameter doesn't result in an outage, with one exception. If the parameter change results
|
|
3911
|
+
* in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which
|
|
3912
|
+
* new connections are rejected but existing connections aren't interrupted.</p>
|
|
3913
|
+
* <p>The change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter
|
|
3914
|
+
* is enabled for this request.</p>
|
|
3915
|
+
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed
|
|
3916
|
+
* from an option group, and that option group can't be removed from a DB instance after
|
|
3917
|
+
* it is associated with a DB instance.</p>
|
|
3918
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3697
3919
|
*/
|
|
3698
3920
|
OptionGroupName?: string;
|
|
3699
3921
|
/**
|
|
3700
|
-
* <p>
|
|
3701
|
-
*
|
|
3702
|
-
*
|
|
3703
|
-
*
|
|
3704
|
-
*
|
|
3705
|
-
* as a lowercase string.
|
|
3706
|
-
* </p>
|
|
3707
|
-
*
|
|
3922
|
+
* <p>The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance
|
|
3923
|
+
* identifier, an instance reboot occurs immediately if you enable <code>ApplyImmediately</code>, or will occur
|
|
3924
|
+
* during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
|
|
3925
|
+
* </p>
|
|
3926
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3708
3927
|
* <p>Constraints:</p>
|
|
3709
3928
|
* <ul>
|
|
3710
3929
|
* <li>
|
|
@@ -3748,23 +3967,27 @@ export interface ModifyDBInstanceMessage {
|
|
|
3748
3967
|
StorageType?: string;
|
|
3749
3968
|
/**
|
|
3750
3969
|
* <p>The ARN from the key store with which to associate the instance for TDE encryption.</p>
|
|
3970
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3751
3971
|
*/
|
|
3752
3972
|
TdeCredentialArn?: string;
|
|
3753
3973
|
/**
|
|
3754
3974
|
* <p>The password for the given ARN from the key store in order to access the device.</p>
|
|
3975
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3755
3976
|
*/
|
|
3756
3977
|
TdeCredentialPassword?: string;
|
|
3757
3978
|
/**
|
|
3758
|
-
* <p>
|
|
3979
|
+
* <p>Specifies the certificate to associate with the DB instance.</p>
|
|
3980
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3759
3981
|
*/
|
|
3760
3982
|
CACertificateIdentifier?: string;
|
|
3761
3983
|
/**
|
|
3762
3984
|
* <p>The Active Directory directory ID to move the DB instance to.
|
|
3763
3985
|
* Specify <code>none</code> to remove the instance from its current domain.
|
|
3764
|
-
*
|
|
3765
|
-
* Server, Oracle, and PostgreSQL DB instances
|
|
3986
|
+
* You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL
|
|
3987
|
+
* Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.</p>
|
|
3766
3988
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
3767
3989
|
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3990
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3768
3991
|
*/
|
|
3769
3992
|
Domain?: string;
|
|
3770
3993
|
/**
|
|
@@ -3778,19 +4001,21 @@ export interface ModifyDBInstanceMessage {
|
|
|
3778
4001
|
*/
|
|
3779
4002
|
CopyTagsToSnapshot?: boolean;
|
|
3780
4003
|
/**
|
|
3781
|
-
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
4004
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected
|
|
4005
|
+
* for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.</p>
|
|
4006
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, set <code>MonitoringInterval</code> to a value other than 0.</p>
|
|
4007
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3784
4008
|
* <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code>
|
|
3785
4009
|
* </p>
|
|
3786
4010
|
*/
|
|
3787
4011
|
MonitoringInterval?: number;
|
|
3788
4012
|
/**
|
|
3789
4013
|
* <p>The port number on which the database accepts connections.</p>
|
|
3790
|
-
* <p>The value of the <code>DBPortNumber</code> parameter must not match any of the port values
|
|
3791
|
-
*
|
|
3792
|
-
* <p>
|
|
3793
|
-
*
|
|
4014
|
+
* <p>The value of the <code>DBPortNumber</code> parameter must not match any of the port values
|
|
4015
|
+
* specified for options in the option group for the DB instance.</p>
|
|
4016
|
+
* <p>If you change the <code>DBPortNumber</code> value, your database restarts regardless of
|
|
4017
|
+
* the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
4018
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3794
4019
|
* <p>
|
|
3795
4020
|
* <b>MySQL</b>
|
|
3796
4021
|
* </p>
|
|
@@ -3830,7 +4055,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3830
4055
|
* <p>
|
|
3831
4056
|
* Default: <code>1433</code>
|
|
3832
4057
|
* </p>
|
|
3833
|
-
*
|
|
4058
|
+
* <p> Valid values: <code>1150-65535</code> except <code>1234</code>, <code>1434</code>,
|
|
3834
4059
|
* <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, and
|
|
3835
4060
|
* <code>49152-49156</code>.</p>
|
|
3836
4061
|
* <p>
|
|
@@ -3840,7 +4065,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3840
4065
|
* Default: <code>3306</code>
|
|
3841
4066
|
* </p>
|
|
3842
4067
|
* <p> Valid values: <code>1150-65535</code>
|
|
3843
|
-
*
|
|
4068
|
+
* </p>
|
|
3844
4069
|
*/
|
|
3845
4070
|
DBPortNumber?: number;
|
|
3846
4071
|
/**
|
|
@@ -3851,33 +4076,37 @@ export interface ModifyDBInstanceMessage {
|
|
|
3851
4076
|
* and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
3852
4077
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
3853
4078
|
* <p>
|
|
3854
|
-
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC.
|
|
3855
|
-
*
|
|
3856
|
-
* <code>PubliclyAccessible</code> must be enabled for it to be publicly accessible.
|
|
4079
|
+
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a
|
|
4080
|
+
* public subnet and <code>PubliclyAccessible</code> must be enabled for it to be publicly accessible.
|
|
3857
4081
|
* </p>
|
|
3858
4082
|
* <p>Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless
|
|
3859
4083
|
* of the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
4084
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3860
4085
|
*/
|
|
3861
4086
|
PubliclyAccessible?: boolean;
|
|
3862
4087
|
/**
|
|
3863
4088
|
* <p>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
|
|
3864
4089
|
* example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3865
|
-
*
|
|
4090
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
3866
4091
|
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
3867
4092
|
* </p>
|
|
3868
|
-
* <p>If <code>MonitoringInterval</code> is set to a value other than 0,
|
|
4093
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than 0, supply a <code>MonitoringRoleArn</code>
|
|
4094
|
+
* value.</p>
|
|
4095
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3869
4096
|
*/
|
|
3870
4097
|
MonitoringRoleArn?: string;
|
|
3871
4098
|
/**
|
|
3872
4099
|
* <p>The name of the IAM role to use when making API calls to the Directory Service.</p>
|
|
4100
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3873
4101
|
*/
|
|
3874
4102
|
DomainIAMRoleName?: string;
|
|
3875
4103
|
/**
|
|
3876
4104
|
* <p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance
|
|
3877
4105
|
* after a failure of the existing primary instance. For more information,
|
|
3878
4106
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance">
|
|
3879
|
-
* Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i
|
|
3880
|
-
*
|
|
4107
|
+
* Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
4108
|
+
* <p>This setting doesn't apply to RDS Custom.
|
|
4109
|
+
* </p>
|
|
3881
4110
|
* <p>Default: 1</p>
|
|
3882
4111
|
* <p>Valid Values: 0 - 15</p>
|
|
3883
4112
|
*/
|
|
@@ -3885,14 +4114,13 @@ export interface ModifyDBInstanceMessage {
|
|
|
3885
4114
|
/**
|
|
3886
4115
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
3887
4116
|
* Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>
|
|
3888
|
-
*
|
|
3889
4117
|
* <p>This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
|
|
3890
4118
|
* cluster.</p>
|
|
3891
|
-
*
|
|
3892
4119
|
* <p>For more information about IAM database authentication, see
|
|
3893
4120
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3894
4121
|
* IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i>
|
|
3895
4122
|
* </p>
|
|
4123
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3896
4124
|
*/
|
|
3897
4125
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3898
4126
|
/**
|
|
@@ -3901,33 +4129,40 @@ export interface ModifyDBInstanceMessage {
|
|
|
3901
4129
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">Using Amazon Performance Insights</a> in the <i>Amazon Relational Database Service
|
|
3902
4130
|
* User Guide</i>.
|
|
3903
4131
|
* </p>
|
|
4132
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3904
4133
|
*/
|
|
3905
4134
|
EnablePerformanceInsights?: boolean;
|
|
3906
4135
|
/**
|
|
3907
4136
|
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
3908
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
4137
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
3909
4138
|
* <p>If you do not specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3910
|
-
* uses your default
|
|
3911
|
-
* Your Amazon Web Services account has a different default
|
|
4139
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
4140
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
4141
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3912
4142
|
*/
|
|
3913
4143
|
PerformanceInsightsKMSKeyId?: string;
|
|
3914
4144
|
/**
|
|
3915
|
-
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years)
|
|
4145
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
4146
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3916
4147
|
*/
|
|
3917
4148
|
PerformanceInsightsRetentionPeriod?: number;
|
|
3918
4149
|
/**
|
|
3919
|
-
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a
|
|
4150
|
+
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a
|
|
4151
|
+
* specific DB instance.</p>
|
|
3920
4152
|
* <p>A change to the <code>CloudwatchLogsExportConfiguration</code> parameter is always applied to the DB instance
|
|
3921
4153
|
* immediately. Therefore, the <code>ApplyImmediately</code> parameter has no effect.</p>
|
|
4154
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3922
4155
|
*/
|
|
3923
4156
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
3924
4157
|
/**
|
|
3925
4158
|
* <p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>
|
|
4159
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3926
4160
|
*/
|
|
3927
4161
|
ProcessorFeatures?: ProcessorFeature[];
|
|
3928
4162
|
/**
|
|
3929
4163
|
* <p>A value that indicates whether the DB instance class of the DB instance uses its default
|
|
3930
4164
|
* processor features.</p>
|
|
4165
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3931
4166
|
*/
|
|
3932
4167
|
UseDefaultProcessorFeatures?: boolean;
|
|
3933
4168
|
/**
|
|
@@ -3945,6 +4180,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3945
4180
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling">
|
|
3946
4181
|
* Managing capacity automatically with Amazon RDS storage autoscaling</a>
|
|
3947
4182
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
4183
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3948
4184
|
*/
|
|
3949
4185
|
MaxAllocatedStorage?: number;
|
|
3950
4186
|
/**
|
|
@@ -3971,6 +4207,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3971
4207
|
* </p>
|
|
3972
4208
|
* </li>
|
|
3973
4209
|
* </ul>
|
|
4210
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3974
4211
|
*/
|
|
3975
4212
|
CertificateRotationRestart?: boolean;
|
|
3976
4213
|
/**
|
|
@@ -3984,6 +4221,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3984
4221
|
* accept user connections, a mounted replica can't serve a read-only workload.
|
|
3985
4222
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
|
|
3986
4223
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
4224
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3987
4225
|
*/
|
|
3988
4226
|
ReplicaMode?: ReplicaMode | string;
|
|
3989
4227
|
/**
|
|
@@ -4000,8 +4238,22 @@ export interface ModifyDBInstanceMessage {
|
|
|
4000
4238
|
EnableCustomerOwnedIp?: boolean;
|
|
4001
4239
|
/**
|
|
4002
4240
|
* <p>The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.</p>
|
|
4241
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4003
4242
|
*/
|
|
4004
4243
|
AwsBackupRecoveryPointArn?: string;
|
|
4244
|
+
/**
|
|
4245
|
+
* <p>The automation mode of the RDS Custom DB instance: <code>full</code> or <code>all paused</code>.
|
|
4246
|
+
* If <code>full</code>, the DB instance automates monitoring and instance recovery. If
|
|
4247
|
+
* <code>all paused</code>, the instance pauses automation for the duration set by
|
|
4248
|
+
* <code>ResumeFullAutomationModeMinutes</code>.</p>
|
|
4249
|
+
*/
|
|
4250
|
+
AutomationMode?: AutomationMode | string;
|
|
4251
|
+
/**
|
|
4252
|
+
* <p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes
|
|
4253
|
+
* full automation. The minimum value is <code>60</code> (default). The maximum value is <code>1,440</code>.
|
|
4254
|
+
* </p>
|
|
4255
|
+
*/
|
|
4256
|
+
ResumeFullAutomationModeMinutes?: number;
|
|
4005
4257
|
}
|
|
4006
4258
|
export declare namespace ModifyDBInstanceMessage {
|
|
4007
4259
|
/**
|
|
@@ -5051,7 +5303,7 @@ export interface RemoveRoleFromDBClusterMessage {
|
|
|
5051
5303
|
RoleArn: string | undefined;
|
|
5052
5304
|
/**
|
|
5053
5305
|
* <p>The name of the feature for the DB cluster that the IAM role is to be disassociated from.
|
|
5054
|
-
* For
|
|
5306
|
+
* For information about supported feature names, see <a>DBEngineVersion</a>.</p>
|
|
5055
5307
|
*/
|
|
5056
5308
|
FeatureName?: string;
|
|
5057
5309
|
}
|
|
@@ -5088,7 +5340,7 @@ export interface RemoveRoleFromDBInstanceMessage {
|
|
|
5088
5340
|
RoleArn: string | undefined;
|
|
5089
5341
|
/**
|
|
5090
5342
|
* <p>The name of the feature for the DB instance that the IAM role is to be disassociated from.
|
|
5091
|
-
* For
|
|
5343
|
+
* For information about supported feature names, see <code>DBEngineVersion</code>.
|
|
5092
5344
|
* </p>
|
|
5093
5345
|
*/
|
|
5094
5346
|
FeatureName: string | undefined;
|
|
@@ -5440,13 +5692,13 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5440
5692
|
StorageEncrypted?: boolean;
|
|
5441
5693
|
/**
|
|
5442
5694
|
* <p>The Amazon Web Services KMS key identifier for an encrypted DB cluster.</p>
|
|
5443
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
5444
|
-
* To use a
|
|
5695
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
5696
|
+
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
5445
5697
|
* <p>If the StorageEncrypted parameter is enabled, and you do
|
|
5446
5698
|
* not specify a value for the <code>KmsKeyId</code> parameter, then
|
|
5447
|
-
* Amazon RDS will use your default
|
|
5448
|
-
* default
|
|
5449
|
-
* default
|
|
5699
|
+
* Amazon RDS will use your default KMS key. There is a
|
|
5700
|
+
* default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different
|
|
5701
|
+
* default KMS key for each Amazon Web Services Region.</p>
|
|
5450
5702
|
*/
|
|
5451
5703
|
KmsKeyId?: string;
|
|
5452
5704
|
/**
|
|
@@ -5696,15 +5948,15 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5696
5948
|
/**
|
|
5697
5949
|
* <p>The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB
|
|
5698
5950
|
* snapshot or DB cluster snapshot.</p>
|
|
5699
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
5700
|
-
* To use a
|
|
5951
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
5952
|
+
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
5701
5953
|
* <p>When you don't specify a value for the <code>KmsKeyId</code> parameter, then the
|
|
5702
5954
|
* following occurs:</p>
|
|
5703
5955
|
* <ul>
|
|
5704
5956
|
* <li>
|
|
5705
5957
|
* <p>If the DB snapshot or DB cluster snapshot in
|
|
5706
|
-
*
|
|
5707
|
-
* is encrypted using the
|
|
5958
|
+
* <code>SnapshotIdentifier</code> is encrypted, then the restored DB cluster
|
|
5959
|
+
* is encrypted using the KMS key that was used to encrypt the DB snapshot or DB
|
|
5708
5960
|
* cluster snapshot.</p>
|
|
5709
5961
|
* </li>
|
|
5710
5962
|
* <li>
|
|
@@ -5936,15 +6188,15 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
5936
6188
|
Tags?: Tag[];
|
|
5937
6189
|
/**
|
|
5938
6190
|
* <p>The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.</p>
|
|
5939
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
5940
|
-
* To use a
|
|
5941
|
-
* <p>You can restore to a new DB cluster and encrypt the new DB cluster with a
|
|
5942
|
-
*
|
|
5943
|
-
*
|
|
6191
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
6192
|
+
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
6193
|
+
* <p>You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the
|
|
6194
|
+
* KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key
|
|
6195
|
+
* identified by the <code>KmsKeyId</code> parameter.</p>
|
|
5944
6196
|
* <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p>
|
|
5945
6197
|
* <ul>
|
|
5946
6198
|
* <li>
|
|
5947
|
-
* <p>If the DB cluster is encrypted, then the restored DB cluster is encrypted using the
|
|
6199
|
+
* <p>If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.</p>
|
|
5948
6200
|
* </li>
|
|
5949
6201
|
* <li>
|
|
5950
6202
|
* <p>If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.</p>
|
|
@@ -6137,6 +6389,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6137
6389
|
DBSubnetGroupName?: string;
|
|
6138
6390
|
/**
|
|
6139
6391
|
* <p>A value that indicates whether the DB instance is a Multi-AZ deployment.</p>
|
|
6392
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6140
6393
|
* <p>Constraint: You can't specify the <code>AvailabilityZone</code> parameter if the DB instance is a Multi-AZ deployment.</p>
|
|
6141
6394
|
*/
|
|
6142
6395
|
MultiAZ?: boolean;
|
|
@@ -6150,11 +6403,14 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6150
6403
|
*/
|
|
6151
6404
|
PubliclyAccessible?: boolean;
|
|
6152
6405
|
/**
|
|
6153
|
-
* <p>A value that indicates whether minor version upgrades are applied automatically to the DB instance
|
|
6406
|
+
* <p>A value that indicates whether minor version upgrades are applied automatically to the DB instance
|
|
6407
|
+
* during the maintenance window.</p>
|
|
6408
|
+
* <p>If you restore an RDS Custom DB instance, you must disable this parameter.</p>
|
|
6154
6409
|
*/
|
|
6155
6410
|
AutoMinorVersionUpgrade?: boolean;
|
|
6156
6411
|
/**
|
|
6157
6412
|
* <p>License model information for the restored DB instance.</p>
|
|
6413
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6158
6414
|
* <p>Default: Same as source.</p>
|
|
6159
6415
|
* <p>
|
|
6160
6416
|
* Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code>
|
|
@@ -6163,13 +6419,13 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6163
6419
|
LicenseModel?: string;
|
|
6164
6420
|
/**
|
|
6165
6421
|
* <p>The database name for the restored DB instance.</p>
|
|
6166
|
-
* <
|
|
6167
|
-
*
|
|
6168
|
-
* </note>
|
|
6422
|
+
* <p>This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS
|
|
6423
|
+
* Custom DB instances.</p>
|
|
6169
6424
|
*/
|
|
6170
6425
|
DBName?: string;
|
|
6171
6426
|
/**
|
|
6172
6427
|
* <p>The database engine to use for the new instance.</p>
|
|
6428
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6173
6429
|
* <p>Default: The same as source</p>
|
|
6174
6430
|
* <p>Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.</p>
|
|
6175
6431
|
*
|
|
@@ -6251,7 +6507,9 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6251
6507
|
/**
|
|
6252
6508
|
* <p>The name of the option group to be used for the restored DB instance.</p>
|
|
6253
6509
|
*
|
|
6254
|
-
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option
|
|
6510
|
+
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option
|
|
6511
|
+
* group, and that option group can't be removed from a DB instance after it is associated with a DB instance.</p>
|
|
6512
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6255
6513
|
*/
|
|
6256
6514
|
OptionGroupName?: string;
|
|
6257
6515
|
/**
|
|
@@ -6277,10 +6535,12 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6277
6535
|
StorageType?: string;
|
|
6278
6536
|
/**
|
|
6279
6537
|
* <p>The ARN from the key store with which to associate the instance for TDE encryption.</p>
|
|
6538
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6280
6539
|
*/
|
|
6281
6540
|
TdeCredentialArn?: string;
|
|
6282
6541
|
/**
|
|
6283
6542
|
* <p>The password for the given ARN from the key store in order to access the device.</p>
|
|
6543
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6284
6544
|
*/
|
|
6285
6545
|
TdeCredentialPassword?: string;
|
|
6286
6546
|
/**
|
|
@@ -6294,10 +6554,11 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6294
6554
|
VpcSecurityGroupIds?: string[];
|
|
6295
6555
|
/**
|
|
6296
6556
|
* <p>Specify the Active Directory directory ID to restore the DB instance in.
|
|
6297
|
-
* The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL
|
|
6298
|
-
* Server, Oracle, and PostgreSQL DB instances
|
|
6557
|
+
* The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL
|
|
6558
|
+
* Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.</p>
|
|
6299
6559
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
6300
6560
|
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6561
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6301
6562
|
*/
|
|
6302
6563
|
Domain?: string;
|
|
6303
6564
|
/**
|
|
@@ -6306,6 +6567,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6306
6567
|
CopyTagsToSnapshot?: boolean;
|
|
6307
6568
|
/**
|
|
6308
6569
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6570
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6309
6571
|
*/
|
|
6310
6572
|
DomainIAMRoleName?: string;
|
|
6311
6573
|
/**
|
|
@@ -6316,27 +6578,32 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6316
6578
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
6317
6579
|
* IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i>
|
|
6318
6580
|
* </p>
|
|
6581
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6319
6582
|
*/
|
|
6320
6583
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
6321
6584
|
/**
|
|
6322
6585
|
* <p>The list of logs that the restored DB instance is to export to CloudWatch Logs. The values
|
|
6323
6586
|
* in the list depend on the DB engine being used. For more information, see
|
|
6324
6587
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6588
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6325
6589
|
*/
|
|
6326
6590
|
EnableCloudwatchLogsExports?: string[];
|
|
6327
6591
|
/**
|
|
6328
6592
|
* <p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>
|
|
6593
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6329
6594
|
*/
|
|
6330
6595
|
ProcessorFeatures?: ProcessorFeature[];
|
|
6331
6596
|
/**
|
|
6332
6597
|
* <p>A value that indicates whether the DB instance class of the DB instance uses its default
|
|
6333
6598
|
* processor features.</p>
|
|
6599
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6334
6600
|
*/
|
|
6335
6601
|
UseDefaultProcessorFeatures?: boolean;
|
|
6336
6602
|
/**
|
|
6337
6603
|
* <p>The name of the DB parameter group to associate with this DB instance.</p>
|
|
6338
|
-
* <p>If you
|
|
6339
|
-
* for the specified DB engine
|
|
6604
|
+
* <p>If you don't specify a value for <code>DBParameterGroupName</code>, then RDS uses the default <code>DBParameterGroup</code>
|
|
6605
|
+
* for the specified DB engine.</p>
|
|
6606
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6340
6607
|
* <p>Constraints:</p>
|
|
6341
6608
|
* <ul>
|
|
6342
6609
|
* <li>
|
|
@@ -6369,12 +6636,34 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6369
6636
|
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
|
|
6370
6637
|
* provide lower latency for connections to the DB instance from outside of its virtual
|
|
6371
6638
|
* private cloud (VPC) on your local network.</p>
|
|
6639
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6372
6640
|
* <p>For more information about RDS on Outposts, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working with Amazon RDS on Amazon Web Services Outposts</a>
|
|
6373
6641
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
6374
6642
|
* <p>For more information about CoIPs, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing">Customer-owned IP addresses</a>
|
|
6375
6643
|
* in the <i>Amazon Web Services Outposts User Guide</i>.</p>
|
|
6376
6644
|
*/
|
|
6377
6645
|
EnableCustomerOwnedIp?: boolean;
|
|
6646
|
+
/**
|
|
6647
|
+
* <p>The instance profile associated with the underlying Amazon EC2 instance of an
|
|
6648
|
+
* RDS Custom DB instance. The instance profile must meet the following requirements:</p>
|
|
6649
|
+
* <ul>
|
|
6650
|
+
* <li>
|
|
6651
|
+
* <p>The profile must exist in your account.</p>
|
|
6652
|
+
* </li>
|
|
6653
|
+
* <li>
|
|
6654
|
+
* <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p>
|
|
6655
|
+
* </li>
|
|
6656
|
+
* <li>
|
|
6657
|
+
* <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p>
|
|
6658
|
+
* </li>
|
|
6659
|
+
* </ul>
|
|
6660
|
+
* <p>For the list of permissions required for the IAM role, see
|
|
6661
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc">
|
|
6662
|
+
* Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service
|
|
6663
|
+
* User Guide</i>.</p>
|
|
6664
|
+
* <p>This setting is required for RDS Custom.</p>
|
|
6665
|
+
*/
|
|
6666
|
+
CustomIamInstanceProfile?: string;
|
|
6378
6667
|
}
|
|
6379
6668
|
export declare namespace RestoreDBInstanceFromDBSnapshotMessage {
|
|
6380
6669
|
/**
|
|
@@ -6665,13 +6954,13 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6665
6954
|
/**
|
|
6666
6955
|
* <p>The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
|
6667
6956
|
* </p>
|
|
6668
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
6669
|
-
* To use a
|
|
6957
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
6958
|
+
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
6670
6959
|
* <p>If the <code>StorageEncrypted</code> parameter is enabled,
|
|
6671
6960
|
* and you do not specify a value for the <code>KmsKeyId</code> parameter,
|
|
6672
|
-
* then Amazon RDS will use your default
|
|
6673
|
-
* There is a default
|
|
6674
|
-
* Your Amazon Web Services account has a different default
|
|
6961
|
+
* then Amazon RDS will use your default KMS key.
|
|
6962
|
+
* There is a default KMS key for your Amazon Web Services account.
|
|
6963
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
6675
6964
|
* </p>
|
|
6676
6965
|
*/
|
|
6677
6966
|
KmsKeyId?: string;
|
|
@@ -6761,10 +7050,10 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6761
7050
|
EnablePerformanceInsights?: boolean;
|
|
6762
7051
|
/**
|
|
6763
7052
|
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
6764
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7053
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
6765
7054
|
* <p>If you do not specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
6766
|
-
* uses your default
|
|
6767
|
-
* Your Amazon Web Services account has a different default
|
|
7055
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
7056
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
6768
7057
|
*/
|
|
6769
7058
|
PerformanceInsightsKMSKeyId?: string;
|
|
6770
7059
|
/**
|
|
@@ -6931,7 +7220,9 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
6931
7220
|
DBSubnetGroupName?: string;
|
|
6932
7221
|
/**
|
|
6933
7222
|
* <p>A value that indicates whether the DB instance is a Multi-AZ deployment.</p>
|
|
6934
|
-
* <p>
|
|
7223
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7224
|
+
* <p>Constraint: You can't specify the <code>AvailabilityZone</code> parameter if the DB instance is a
|
|
7225
|
+
* Multi-AZ deployment.</p>
|
|
6935
7226
|
*/
|
|
6936
7227
|
MultiAZ?: boolean;
|
|
6937
7228
|
/**
|
|
@@ -6944,11 +7235,14 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
6944
7235
|
*/
|
|
6945
7236
|
PubliclyAccessible?: boolean;
|
|
6946
7237
|
/**
|
|
6947
|
-
* <p>A value that indicates whether minor version upgrades are applied automatically to the
|
|
7238
|
+
* <p>A value that indicates whether minor version upgrades are applied automatically to the
|
|
7239
|
+
* DB instance during the maintenance window.</p>
|
|
7240
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6948
7241
|
*/
|
|
6949
7242
|
AutoMinorVersionUpgrade?: boolean;
|
|
6950
7243
|
/**
|
|
6951
7244
|
* <p>License model information for the restored DB instance.</p>
|
|
7245
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6952
7246
|
* <p>Default: Same as source.</p>
|
|
6953
7247
|
* <p>
|
|
6954
7248
|
* Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code>
|
|
@@ -6958,12 +7252,13 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
6958
7252
|
/**
|
|
6959
7253
|
* <p>The database name for the restored DB instance.</p>
|
|
6960
7254
|
* <note>
|
|
6961
|
-
* <p>This parameter isn't
|
|
7255
|
+
* <p>This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.</p>
|
|
6962
7256
|
* </note>
|
|
6963
7257
|
*/
|
|
6964
7258
|
DBName?: string;
|
|
6965
7259
|
/**
|
|
6966
7260
|
* <p>The database engine to use for the new instance.</p>
|
|
7261
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6967
7262
|
* <p>Default: The same as source</p>
|
|
6968
7263
|
* <p>Constraint: Must be compatible with the engine of the source</p>
|
|
6969
7264
|
*
|
|
@@ -7040,7 +7335,9 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7040
7335
|
/**
|
|
7041
7336
|
* <p>The name of the option group to be used for the restored DB instance.</p>
|
|
7042
7337
|
*
|
|
7043
|
-
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an
|
|
7338
|
+
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an
|
|
7339
|
+
* option group, and that option group can't be removed from a DB instance after it is associated with a DB instance</p>
|
|
7340
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7044
7341
|
*/
|
|
7045
7342
|
OptionGroupName?: string;
|
|
7046
7343
|
/**
|
|
@@ -7070,10 +7367,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7070
7367
|
StorageType?: string;
|
|
7071
7368
|
/**
|
|
7072
7369
|
* <p>The ARN from the key store with which to associate the instance for TDE encryption.</p>
|
|
7370
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7073
7371
|
*/
|
|
7074
7372
|
TdeCredentialArn?: string;
|
|
7075
7373
|
/**
|
|
7076
7374
|
* <p>The password for the given ARN from the key store in order to access the device.</p>
|
|
7375
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7077
7376
|
*/
|
|
7078
7377
|
TdeCredentialPassword?: string;
|
|
7079
7378
|
/**
|
|
@@ -7087,20 +7386,24 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7087
7386
|
VpcSecurityGroupIds?: string[];
|
|
7088
7387
|
/**
|
|
7089
7388
|
* <p>Specify the Active Directory directory ID to restore the DB instance in.
|
|
7090
|
-
*
|
|
7091
|
-
* Server, Oracle, and PostgreSQL DB instances
|
|
7389
|
+
* Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL
|
|
7390
|
+
* Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.</p>
|
|
7391
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7092
7392
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
7093
7393
|
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7094
7394
|
*/
|
|
7095
7395
|
Domain?: string;
|
|
7096
7396
|
/**
|
|
7097
7397
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
7398
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7098
7399
|
*/
|
|
7099
7400
|
DomainIAMRoleName?: string;
|
|
7100
7401
|
/**
|
|
7101
7402
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7102
7403
|
* Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>
|
|
7103
7404
|
*
|
|
7405
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7406
|
+
*
|
|
7104
7407
|
* <p>For more information about IAM database authentication, see
|
|
7105
7408
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
7106
7409
|
* IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i>
|
|
@@ -7111,20 +7414,24 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7111
7414
|
* <p>The list of logs that the restored DB instance is to export to CloudWatch Logs. The values
|
|
7112
7415
|
* in the list depend on the DB engine being used. For more information, see
|
|
7113
7416
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7417
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7114
7418
|
*/
|
|
7115
7419
|
EnableCloudwatchLogsExports?: string[];
|
|
7116
7420
|
/**
|
|
7117
7421
|
* <p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>
|
|
7422
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7118
7423
|
*/
|
|
7119
7424
|
ProcessorFeatures?: ProcessorFeature[];
|
|
7120
7425
|
/**
|
|
7121
7426
|
* <p>A value that indicates whether the DB instance class of the DB instance uses its default processor features.</p>
|
|
7427
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7122
7428
|
*/
|
|
7123
7429
|
UseDefaultProcessorFeatures?: boolean;
|
|
7124
7430
|
/**
|
|
7125
7431
|
* <p>The name of the DB parameter group to associate with this DB instance.</p>
|
|
7126
7432
|
* <p>If you do not specify a value for <code>DBParameterGroupName</code>, then the default <code>DBParameterGroup</code>
|
|
7127
7433
|
* for the specified DB engine is used.</p>
|
|
7434
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7128
7435
|
* <p>Constraints:</p>
|
|
7129
7436
|
* <ul>
|
|
7130
7437
|
* <li>
|
|
@@ -7161,11 +7468,13 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7161
7468
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling">
|
|
7162
7469
|
* Managing capacity automatically with Amazon RDS storage autoscaling</a>
|
|
7163
7470
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
7471
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7164
7472
|
*/
|
|
7165
7473
|
MaxAllocatedStorage?: number;
|
|
7166
7474
|
/**
|
|
7167
7475
|
* <p>The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
|
|
7168
7476
|
* <code>arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE</code>.</p>
|
|
7477
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7169
7478
|
*/
|
|
7170
7479
|
SourceDBInstanceAutomatedBackupsArn?: string;
|
|
7171
7480
|
/**
|
|
@@ -7174,12 +7483,34 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7174
7483
|
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
|
|
7175
7484
|
* provide lower latency for connections to the DB instance from outside of its virtual
|
|
7176
7485
|
* private cloud (VPC) on your local network.</p>
|
|
7486
|
+
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7177
7487
|
* <p>For more information about RDS on Outposts, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working with Amazon RDS on Amazon Web Services Outposts</a>
|
|
7178
7488
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
7179
7489
|
* <p>For more information about CoIPs, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing">Customer-owned IP addresses</a>
|
|
7180
7490
|
* in the <i>Amazon Web Services Outposts User Guide</i>.</p>
|
|
7181
7491
|
*/
|
|
7182
7492
|
EnableCustomerOwnedIp?: boolean;
|
|
7493
|
+
/**
|
|
7494
|
+
* <p>The instance profile associated with the underlying Amazon EC2 instance of an
|
|
7495
|
+
* RDS Custom DB instance. The instance profile must meet the following requirements:</p>
|
|
7496
|
+
* <ul>
|
|
7497
|
+
* <li>
|
|
7498
|
+
* <p>The profile must exist in your account.</p>
|
|
7499
|
+
* </li>
|
|
7500
|
+
* <li>
|
|
7501
|
+
* <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p>
|
|
7502
|
+
* </li>
|
|
7503
|
+
* <li>
|
|
7504
|
+
* <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p>
|
|
7505
|
+
* </li>
|
|
7506
|
+
* </ul>
|
|
7507
|
+
* <p>For the list of permissions required for the IAM role, see
|
|
7508
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc">
|
|
7509
|
+
* Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service
|
|
7510
|
+
* User Guide</i>.</p>
|
|
7511
|
+
* <p>This setting is required for RDS Custom.</p>
|
|
7512
|
+
*/
|
|
7513
|
+
CustomIamInstanceProfile?: string;
|
|
7183
7514
|
}
|
|
7184
7515
|
export declare namespace RestoreDBInstanceToPointInTimeMessage {
|
|
7185
7516
|
/**
|
|
@@ -7283,7 +7614,7 @@ export interface StartActivityStreamRequest {
|
|
|
7283
7614
|
Mode: ActivityStreamMode | string | undefined;
|
|
7284
7615
|
/**
|
|
7285
7616
|
* <p>The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.
|
|
7286
|
-
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7617
|
+
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
7287
7618
|
*/
|
|
7288
7619
|
KmsKeyId: string | undefined;
|
|
7289
7620
|
/**
|
|
@@ -7527,10 +7858,10 @@ export interface StartExportTaskMessage {
|
|
|
7527
7858
|
*/
|
|
7528
7859
|
IamRoleArn: string | undefined;
|
|
7529
7860
|
/**
|
|
7530
|
-
* <p>The ID of the Amazon Web Services KMS
|
|
7531
|
-
* key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7532
|
-
* The caller of this operation must be authorized to
|
|
7533
|
-
*
|
|
7861
|
+
* <p>The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS
|
|
7862
|
+
* key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
7863
|
+
* The caller of this operation must be authorized to execute the following operations.
|
|
7864
|
+
* These can be set in the Amazon Web Services KMS key policy: </p>
|
|
7534
7865
|
* <ul>
|
|
7535
7866
|
* <li>
|
|
7536
7867
|
* <p>GrantOperation.Encrypt</p>
|
|
@@ -7625,7 +7956,7 @@ export declare namespace StopActivityStreamRequest {
|
|
|
7625
7956
|
export interface StopActivityStreamResponse {
|
|
7626
7957
|
/**
|
|
7627
7958
|
* <p>The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.</p>
|
|
7628
|
-
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7959
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
7629
7960
|
*/
|
|
7630
7961
|
KmsKeyId?: string;
|
|
7631
7962
|
/**
|