@aws-sdk/client-rds 3.56.0 → 3.72.0

package/dist-types/models/models_0.d.ts

@@ -2350,148 +2350,6 @@ export declare class OptionGroupQuotaExceededFault extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<OptionGroupQuotaExceededFault, __BaseException>);
 }
-/**
- * <p></p>
- */
-export interface CreateCustomAvailabilityZoneMessage {
-    /**
-     * <p>The name of the custom Availability Zone (AZ).</p>
-     */
-    CustomAvailabilityZoneName: string | undefined;
-    /**
-     * <p>The ID of an existing virtual private network (VPN) between the Amazon RDS website and
-     *             the VMware vSphere cluster.</p>
-     */
-    ExistingVpnId?: string;
-    /**
-     * <p>The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.</p>
-     *         <p>Specify this parameter only if <code>ExistingVpnId</code> isn't specified.</p>
-     */
-    NewVpnTunnelName?: string;
-    /**
-     * <p>The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.</p>
-     *         <p>Specify this parameter only if <code>ExistingVpnId</code> isn't specified.</p>
-     */
-    VpnTunnelOriginatorIP?: string;
-}
-export declare namespace CreateCustomAvailabilityZoneMessage {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: CreateCustomAvailabilityZoneMessage) => any;
-}
-/**
- * <p>Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.</p>
- *         <p>For more information about RDS on VMware, see the
- *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html">
- *                 RDS on VMware User Guide.</a>
- *          </p>
- */
-export interface VpnDetails {
-    /**
-     * <p>The ID of the VPN.</p>
-     */
-    VpnId?: string;
-    /**
-     * <p>The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.</p>
-     */
-    VpnTunnelOriginatorIP?: string;
-    /**
-     * <p>The IP address of network traffic from Amazon Web Services to your on-premises data center.</p>
-     */
-    VpnGatewayIp?: string;
-    /**
-     * <p>The preshared key (PSK) for the VPN.</p>
-     */
-    VpnPSK?: string;
-    /**
-     * <p>The name of the VPN.</p>
-     */
-    VpnName?: string;
-    /**
-     * <p>The state of the VPN.</p>
-     */
-    VpnState?: string;
-}
-export declare namespace VpnDetails {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: VpnDetails) => any;
-}
-/**
- * <p>A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.</p>
- *         <p>For more information about RDS on VMware, see the
- *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html">
- *                 RDS on VMware User Guide.</a>
- *          </p>
- */
-export interface CustomAvailabilityZone {
-    /**
-     * <p>The identifier of the custom AZ.</p>
-     *         <p>Amazon RDS generates a unique identifier when a custom AZ is created.</p>
-     */
-    CustomAvailabilityZoneId?: string;
-    /**
-     * <p>The name of the custom AZ.</p>
-     */
-    CustomAvailabilityZoneName?: string;
-    /**
-     * <p>The status of the custom AZ.</p>
-     */
-    CustomAvailabilityZoneStatus?: string;
-    /**
-     * <p>Information about the virtual private network (VPN) between the VMware vSphere cluster
-     *             and the Amazon Web Services website.</p>
-     */
-    VpnDetails?: VpnDetails;
-}
-export declare namespace CustomAvailabilityZone {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: CustomAvailabilityZone) => any;
-}
-export interface CreateCustomAvailabilityZoneResult {
-    /**
-     * <p>A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.</p>
-     *         <p>For more information about RDS on VMware, see the
-     *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html">
-     *                 RDS on VMware User Guide.</a>
-     *          </p>
-     */
-    CustomAvailabilityZone?: CustomAvailabilityZone;
-}
-export declare namespace CreateCustomAvailabilityZoneResult {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: CreateCustomAvailabilityZoneResult) => any;
-}
-/**
- * <p>
- *             <code>CustomAvailabilityZoneName</code> is already used by an existing custom
- *             Availability Zone.</p>
- */
-export declare class CustomAvailabilityZoneAlreadyExistsFault extends __BaseException {
-    readonly name: "CustomAvailabilityZoneAlreadyExistsFault";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<CustomAvailabilityZoneAlreadyExistsFault, __BaseException>);
-}
-/**
- * <p>You have exceeded the maximum number of custom Availability Zones.</p>
- */
-export declare class CustomAvailabilityZoneQuotaExceededFault extends __BaseException {
-    readonly name: "CustomAvailabilityZoneQuotaExceededFault";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<CustomAvailabilityZoneQuotaExceededFault, __BaseException>);
-}
 export interface CreateCustomDBEngineVersionMessage {
     /**
      * <p>The database engine to use for your custom engine version (CEV). The only supported value is
@@ -5020,7 +4878,8 @@ export interface CreateDBInstanceMessage {
      *         <p>
      *             <b>Amazon Aurora</b>
      *          </p>
-     *         <p>Not applicable. Availability Zones are managed by the DB cluster.</p>
+     *         <p>Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these
+     *             Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.</p>
      *         <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p>
      *         <p>Example: <code>us-east-1d</code>
      *          </p>
@@ -8218,34 +8077,6 @@ export declare namespace CreateOptionGroupResult {
      */
     const filterSensitiveLog: (obj: CreateOptionGroupResult) => any;
 }
-export interface DeleteCustomAvailabilityZoneMessage {
-    /**
-     * <p>The custom AZ identifier.</p>
-     */
-    CustomAvailabilityZoneId: string | undefined;
-}
-export declare namespace DeleteCustomAvailabilityZoneMessage {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: DeleteCustomAvailabilityZoneMessage) => any;
-}
-export interface DeleteCustomAvailabilityZoneResult {
-    /**
-     * <p>A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.</p>
-     *         <p>For more information about RDS on VMware, see the
-     *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html">
-     *                 RDS on VMware User Guide.</a>
-     *          </p>
-     */
-    CustomAvailabilityZone?: CustomAvailabilityZone;
-}
-export declare namespace DeleteCustomAvailabilityZoneResult {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: DeleteCustomAvailabilityZoneResult) => any;
-}
 /**
  * <p>The specified CEV was not found.</p>
  */
@@ -9041,91 +8872,6 @@ export declare namespace DeleteGlobalClusterResult {
      */
     const filterSensitiveLog: (obj: DeleteGlobalClusterResult) => any;
 }
-export interface DeleteInstallationMediaMessage {
-    /**
-     * <p>The installation medium ID.</p>
-     */
-    InstallationMediaId: string | undefined;
-}
-export declare namespace DeleteInstallationMediaMessage {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: DeleteInstallationMediaMessage) => any;
-}
-/**
- * <p>Contains the cause of an installation media failure. Installation media is used
- *           for a DB engine that requires an on-premises
- *           customer provided license, such as Microsoft SQL Server.</p>
- */
-export interface InstallationMediaFailureCause {
-    /**
-     * <p>The reason that an installation media import failed.</p>
-     */
-    Message?: string;
-}
-export declare namespace InstallationMediaFailureCause {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InstallationMediaFailureCause) => any;
-}
-/**
- * <p>Contains the installation media for a DB engine that requires an on-premises
- *           customer provided license, such as Microsoft SQL Server.</p>
- */
-export interface InstallationMedia {
-    /**
-     * <p>The installation medium ID.</p>
-     */
-    InstallationMediaId?: string;
-    /**
-     * <p>The custom Availability Zone (AZ) that contains the installation media.</p>
-     */
-    CustomAvailabilityZoneId?: string;
-    /**
-     * <p>The DB engine.</p>
-     */
-    Engine?: string;
-    /**
-     * <p>The engine version of the DB engine.</p>
-     */
-    EngineVersion?: string;
-    /**
-     * <p>The path to the installation medium for the DB engine.</p>
-     */
-    EngineInstallationMediaPath?: string;
-    /**
-     * <p>The path to the installation medium for the operating system associated with the DB engine.</p>
-     */
-    OSInstallationMediaPath?: string;
-    /**
-     * <p>The status of the installation medium.</p>
-     */
-    Status?: string;
-    /**
-     * <p>If an installation media failure occurred, the cause of the failure.</p>
-     */
-    FailureCause?: InstallationMediaFailureCause;
-}
-export declare namespace InstallationMedia {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InstallationMedia) => any;
-}
-/**
- * <p>
- *             <code>InstallationMediaID</code> doesn't refer to an existing installation medium.</p>
- */
-export declare class InstallationMediaNotFoundFault extends __BaseException {
-    readonly name: "InstallationMediaNotFoundFault";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InstallationMediaNotFoundFault, __BaseException>);
-}
 /**
  * <p></p>
  */
@@ -9383,58 +9129,6 @@ export declare namespace DescribeCertificatesMessage {
      */
     const filterSensitiveLog: (obj: DescribeCertificatesMessage) => any;
 }
-export interface CustomAvailabilityZoneMessage {
-    /**
-     * <p>An optional pagination token provided by a previous
-     *             <code>DescribeCustomAvailabilityZones</code> request.
-     *             If this parameter is specified, the response includes
-     *             only records beyond the marker,
-     *             up to the value specified by <code>MaxRecords</code>.</p>
-     */
-    Marker?: string;
-    /**
-     * <p>The list of <a>CustomAvailabilityZone</a> objects for the Amazon Web Services account.</p>
-     */
-    CustomAvailabilityZones?: CustomAvailabilityZone[];
-}
-export declare namespace CustomAvailabilityZoneMessage {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: CustomAvailabilityZoneMessage) => any;
-}
-export interface DescribeCustomAvailabilityZonesMessage {
-    /**
-     * <p>The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.</p>
-     */
-    CustomAvailabilityZoneId?: string;
-    /**
-     * <p>A filter that specifies one or more custom AZs to describe.</p>
-     */
-    Filters?: Filter[];
-    /**
-     * <p>The maximum number of records to include in the response.
-     *             If more records exist than the specified <code>MaxRecords</code> value,
-     *             a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
-     *         <p>Default: 100</p>
-     *         <p>Constraints: Minimum 20, maximum 100.</p>
-     */
-    MaxRecords?: number;
-    /**
-     * <p>An optional pagination token provided by a previous
-     *             <code>DescribeCustomAvailabilityZones</code> request.
-     *             If this parameter is specified, the response includes
-     *             only records beyond the marker,
-     *             up to the value specified by <code>MaxRecords</code>.</p>
-     */
-    Marker?: string;
-}
-export declare namespace DescribeCustomAvailabilityZonesMessage {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: DescribeCustomAvailabilityZonesMessage) => any;
-}
 /**
  * <p>Contains the result of a successful invocation of the <code>DescribeDBClusterBacktracks</code> action.</p>
  */
@@ -11087,3 +10781,281 @@ export declare namespace DescribeDBProxyTargetsRequest {
      */
     const filterSensitiveLog: (obj: DescribeDBProxyTargetsRequest) => any;
 }
+export declare enum TargetRole {
+    READ_ONLY = "READ_ONLY",
+    READ_WRITE = "READ_WRITE",
+    UNKNOWN = "UNKNOWN"
+}
+export declare enum TargetHealthReason {
+    AUTH_FAILURE = "AUTH_FAILURE",
+    CONNECTION_FAILED = "CONNECTION_FAILED",
+    INVALID_REPLICATION_STATE = "INVALID_REPLICATION_STATE",
+    PENDING_PROXY_CAPACITY = "PENDING_PROXY_CAPACITY",
+    UNREACHABLE = "UNREACHABLE"
+}
+export declare enum TargetState {
+    available = "AVAILABLE",
+    registering = "REGISTERING",
+    unavailable = "UNAVAILABLE"
+}
+/**
+ * <p>Information about the connection health of an RDS Proxy target.</p>
+ */
+export interface TargetHealth {
+    /**
+     * <p>The current state of the connection health lifecycle for the RDS Proxy target.
+     *            The following is a typical lifecycle example for the states of an RDS Proxy target:</p>
+     *         <p>
+     *             <code>registering</code> > <code>unavailable</code> > <code>available</code> > <code>unavailable</code> > <code>available</code>
+     *          </p>
+     */
+    State?: TargetState | string;
+    /**
+     * <p>The reason for the current health <code>State</code> of the RDS Proxy target.</p>
+     */
+    Reason?: TargetHealthReason | string;
+    /**
+     * <p>A description of the health of the RDS Proxy target.
+     *             If the <code>State</code> is <code>AVAILABLE</code>, a description is not included.</p>
+     */
+    Description?: string;
+}
+export declare namespace TargetHealth {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: TargetHealth) => any;
+}
+export declare enum TargetType {
+    RDS_INSTANCE = "RDS_INSTANCE",
+    RDS_SERVERLESS_ENDPOINT = "RDS_SERVERLESS_ENDPOINT",
+    TRACKED_CLUSTER = "TRACKED_CLUSTER"
+}
+/**
+ * <p>Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster
+ *         that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.</p>
+ *         <p>This data type is used as a response element in the <code>DescribeDBProxyTargets</code> action.</p>
+ */
+export interface DBProxyTarget {
+    /**
+     * <p>The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.</p>
+     */
+    TargetArn?: string;
+    /**
+     * <p>The writer endpoint for the RDS DB instance or Aurora DB cluster.</p>
+     */
+    Endpoint?: string;
+    /**
+     * <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>
+     */
+    TrackedClusterId?: string;
+    /**
+     * <p>The identifier representing the target. It can be the instance identifier for an RDS DB instance,
+     *         or the cluster identifier for an Aurora DB cluster.</p>
+     */
+    RdsResourceId?: string;
+    /**
+     * <p>The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.</p>
+     */
+    Port?: number;
+    /**
+     * <p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>
+     */
+    Type?: TargetType | string;
+    /**
+     * <p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</p>
+     */
+    Role?: TargetRole | string;
+    /**
+     * <p>Information about the connection health of the RDS Proxy target.</p>
+     */
+    TargetHealth?: TargetHealth;
+}
+export declare namespace DBProxyTarget {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DBProxyTarget) => any;
+}
+export interface DescribeDBProxyTargetsResponse {
+    /**
+     * <p>An arbitrary number of <code>DBProxyTarget</code> objects, containing details of the corresponding targets.</p>
+     */
+    Targets?: DBProxyTarget[];
+    /**
+     * <p>An optional pagination token provided by a previous request.
+     *         If this parameter is specified, the response includes only records beyond the marker,
+     *         up to the value specified by <code>MaxRecords</code>.</p>
+     */
+    Marker?: string;
+}
+export declare namespace DescribeDBProxyTargetsResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeDBProxyTargetsResponse) => any;
+}
+/**
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.</p>
+ */
+export interface DBSecurityGroupMessage {
+    /**
+     * <p>An optional pagination token provided by a previous request.
+     *             If this parameter is specified, the response includes
+     *             only records beyond the marker,
+     *             up to the value specified by <code>MaxRecords</code>.</p>
+     */
+    Marker?: string;
+    /**
+     * <p>A list of <code>DBSecurityGroup</code> instances.</p>
+     */
+    DBSecurityGroups?: DBSecurityGroup[];
+}
+export declare namespace DBSecurityGroupMessage {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DBSecurityGroupMessage) => any;
+}
+/**
+ * <p></p>
+ */
+export interface DescribeDBSecurityGroupsMessage {
+    /**
+     * <p>The name of the DB security group to return details for.</p>
+     */
+    DBSecurityGroupName?: string;
+    /**
+     * <p>This parameter isn't currently supported.</p>
+     */
+    Filters?: Filter[];
+    /**
+     * <p>The maximum number of records to include in the response.
+     *         If more records exist than the specified <code>MaxRecords</code> value,
+     *         a pagination token called a marker is included in the response so that
+     *         you can retrieve the remaining results.</p>
+     *         <p>Default: 100</p>
+     *         <p>Constraints: Minimum 20, maximum 100.</p>
+     */
+    MaxRecords?: number;
+    /**
+     * <p>An optional pagination token provided by a previous
+     *         <code>DescribeDBSecurityGroups</code> request.
+     *         If this parameter is specified, the response includes
+     *         only records beyond the marker,
+     *         up to the value specified by <code>MaxRecords</code>.</p>
+     */
+    Marker?: string;
+}
+export declare namespace DescribeDBSecurityGroupsMessage {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeDBSecurityGroupsMessage) => any;
+}
+/**
+ * <p></p>
+ */
+export interface DescribeDBSnapshotAttributesMessage {
+    /**
+     * <p>The identifier for the DB snapshot to describe the attributes for.</p>
+     */
+    DBSnapshotIdentifier: string | undefined;
+}
+export declare namespace DescribeDBSnapshotAttributesMessage {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeDBSnapshotAttributesMessage) => any;
+}
+/**
+ * <p>Contains the name and values of a manual DB snapshot attribute</p>
+ *         <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
+ *     to restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
+ *     API.</p>
+ */
+export interface DBSnapshotAttribute {
+    /**
+     * <p>The name of the manual DB snapshot attribute.</p>
+     *         <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
+     *           have permission to copy or restore the manual DB cluster snapshot. For more information,
+     *           see the <code>ModifyDBSnapshotAttribute</code>
+     *           API action.</p>
+     */
+    AttributeName?: string;
+    /**
+     * <p>The value or values for the manual DB snapshot attribute.</p>
+     *         <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
+     *       returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
+     *       DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot
+     *       is public and available for any Amazon Web Services account to copy or restore.</p>
+     */
+    AttributeValues?: string[];
+}
+export declare namespace DBSnapshotAttribute {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DBSnapshotAttribute) => any;
+}
+/**
+ * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
+ *     API action.</p>
+ *         <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
+ *       to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
+ *       API action.</p>
+ */
+export interface DBSnapshotAttributesResult {
+    /**
+     * <p>The identifier of the manual DB snapshot that the attributes apply to.</p>
+     */
+    DBSnapshotIdentifier?: string;
+    /**
+     * <p>The list of attributes and values for the manual DB snapshot.</p>
+     */
+    DBSnapshotAttributes?: DBSnapshotAttribute[];
+}
+export declare namespace DBSnapshotAttributesResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DBSnapshotAttributesResult) => any;
+}
+export interface DescribeDBSnapshotAttributesResult {
+    /**
+     * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
+     *     API action.</p>
+     *         <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
+     *       to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
+     *       API action.</p>
+     */
+    DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
+}
+export declare namespace DescribeDBSnapshotAttributesResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeDBSnapshotAttributesResult) => any;
+}
+/**
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action.</p>
+ */
+export interface DBSnapshotMessage {
+    /**
+     * <p>An optional pagination token provided by a previous request.
+     *             If this parameter is specified, the response includes
+     *             only records beyond the marker,
+     *             up to the value specified by <code>MaxRecords</code>.</p>
+     */
+    Marker?: string;
+    /**
+     * <p>A list of <code>DBSnapshot</code> instances.</p>
+     */
+    DBSnapshots?: DBSnapshot[];
+}
+export declare namespace DBSnapshotMessage {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DBSnapshotMessage) => any;
+}