Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.RDS

Classes

AuroraClusterEngineProps

(deprecated) Creation properties of the plain Aurora database cluster engine.

AuroraEngineVersion

(deprecated) The versions for the Aurora cluster engine (those returned by DatabaseClusterEngine.aurora).

AuroraMysqlClusterEngineProps

Creation properties of the Aurora MySQL database cluster engine.

AuroraMysqlEngineVersion

The versions for the Aurora MySQL cluster engine (those returned by DatabaseClusterEngine.auroraMysql).

AuroraPostgresClusterEngineProps

Creation properties of the Aurora PostgreSQL database cluster engine.

AuroraPostgresEngineFeatures

Features supported by this version of the Aurora Postgres cluster engine.

AuroraPostgresEngineVersion

The versions for the Aurora PostgreSQL cluster engine (those returned by DatabaseClusterEngine.auroraPostgres).

BackupProps

Backup configuration for RDS databases.

CaCertificate

The CA certificate used for a DB instance.

CfnCustomDBEngineVersion

Creates a custom DB engine version (CEV).

CfnCustomDBEngineVersionProps

Properties for defining a CfnCustomDBEngineVersion.

CfnDBCluster

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.

CfnDBCluster.DBClusterRoleProperty

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

CfnDBCluster.EndpointProperty

The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

CfnDBCluster.MasterUserSecretProperty

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBCluster.ReadEndpointProperty

The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

CfnDBCluster.ScalingConfigurationProperty

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

CfnDBCluster.ServerlessV2ScalingConfigurationProperty

The ServerlessV2ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.

CfnDBClusterParameterGroup

The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group.

CfnDBClusterParameterGroupProps

Properties for defining a CfnDBClusterParameterGroup.

CfnDBClusterProps

Properties for defining a CfnDBCluster.

CfnDBInstance

The AWS::RDS::DBInstance resource creates an Amazon DB instance.

CfnDBInstance.CertificateDetailsProperty

The details of the DB instance’s server certificate.

CfnDBInstance.DBInstanceRoleProperty

Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

CfnDBInstance.DBInstanceStatusInfoProperty

Provides a list of status information for a DB instance.

CfnDBInstance.EndpointProperty

This data type represents the information you need to connect to an Amazon RDS DB instance.

CfnDBInstance.MasterUserSecretProperty

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBInstance.ProcessorFeatureProperty

The ProcessorFeature property type specifies the processor features of a DB instance class.

CfnDBInstanceProps

Properties for defining a CfnDBInstance.

CfnDBParameterGroup

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

CfnDBParameterGroupProps

Properties for defining a CfnDBParameterGroup.

CfnDBProxy

The AWS::RDS::DBProxy resource creates or updates a DB proxy.

CfnDBProxy.AuthFormatProperty

Specifies the details of authentication used by a proxy to log in as a specific database user.

CfnDBProxy.TagFormatProperty

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

CfnDBProxyEndpoint

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

CfnDBProxyEndpoint.TagFormatProperty

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

CfnDBProxyEndpointProps

Properties for defining a CfnDBProxyEndpoint.

CfnDBProxyProps

Properties for defining a CfnDBProxy.

CfnDBProxyTargetGroup

The AWS::RDS::DBProxyTargetGroup resource represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to.

CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup .

CfnDBProxyTargetGroupProps

Properties for defining a CfnDBProxyTargetGroup.

CfnDBSecurityGroup

The AWS::RDS::DBSecurityGroup resource creates or updates an Amazon RDS DB security group.

CfnDBSecurityGroup.IngressProperty

The Ingress property type specifies an individual ingress rule within an AWS::RDS::DBSecurityGroup resource.

CfnDBSecurityGroupIngress

The AWS::RDS::DBSecurityGroupIngress resource enables ingress to a DB security group using one of two forms of authorization.

CfnDBSecurityGroupIngressProps

Properties for defining a CfnDBSecurityGroupIngress.

CfnDBSecurityGroupProps

Properties for defining a CfnDBSecurityGroup.

CfnDBShardGroup

Creates a new DB shard group for Aurora Limitless Database.

CfnDBShardGroupProps

Properties for defining a CfnDBShardGroup.

CfnDBSubnetGroup

The AWS::RDS::DBSubnetGroup resource creates a database subnet group.

CfnDBSubnetGroupProps

Properties for defining a CfnDBSubnetGroup.

CfnEventSubscription

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

CfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

CfnGlobalCluster

The AWS::RDS::GlobalCluster resource creates or updates an Amazon Aurora global database spread across multiple AWS Regions.

CfnGlobalCluster.GlobalEndpointProperty

The writer endpoint for the new global database cluster.

CfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

CfnIntegration

A zero-ETL integration with Amazon Redshift.

CfnIntegrationProps

Properties for defining a CfnIntegration.

CfnOptionGroup

The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

CfnOptionGroup.OptionConfigurationProperty

The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource.

CfnOptionGroup.OptionSettingProperty

The OptionSetting property type specifies the value for an option within an OptionSetting property.

CfnOptionGroupProps

Properties for defining a CfnOptionGroup.

ClusterEngineBindOptions

The extra options passed to the IClusterEngine.bindToCluster method.

ClusterEngineConfig

The type returned from the IClusterEngine.bindToCluster method.

ClusterEngineFeatures

Represents Database Engine features.

ClusterInstance

Create an RDS Aurora Cluster Instance.

ClusterInstanceBindOptions

Options for binding the instance to the cluster.

ClusterInstanceOptions

Common options for creating a cluster instance.

ClusterInstanceProps

Common options for creating cluster instances (both serverless and provisioned).

ClusterInstanceType

The type of Aurora Cluster Instance.

CommonRotationUserOptions

Properties common to single-user and multi-user rotation options.

Credentials

Username and password combination.

CredentialsBaseOptions

Base options for creating Credentials.

CredentialsFromUsernameOptions

Options for creating Credentials from a username.

CustomDBEngineVersionReference

A reference to a CustomDBEngineVersion resource.

DBClusterParameterGroupReference

A reference to a DBClusterParameterGroup resource.

DBClusterReference

A reference to a DBCluster resource.

DBInstanceReference

A reference to a DBInstance resource.

DBParameterGroupReference

A reference to a DBParameterGroup resource.

DBProxyEndpointReference

A reference to a DBProxyEndpoint resource.

DBProxyReference

A reference to a DBProxy resource.

DBProxyTargetGroupReference

A reference to a DBProxyTargetGroup resource.

DBSecurityGroupIngressReference

A reference to a DBSecurityGroupIngress resource.

DBSecurityGroupReference

A reference to a DBSecurityGroup resource.

DBShardGroupReference

A reference to a DBShardGroup resource.

DBSubnetGroupReference

A reference to a DBSubnetGroup resource.

DatabaseCluster

Create a clustered database with a given number of instances.

DatabaseClusterAttributes

Properties that describe an existing cluster instance.

DatabaseClusterBase

A new or imported clustered database.

DatabaseClusterEngine

A database cluster engine.

DatabaseClusterFromSnapshot

A database cluster restored from a snapshot.

DatabaseClusterFromSnapshotProps

Properties for DatabaseClusterFromSnapshot.

DatabaseClusterLookupOptions

Properties for looking up an existing DatabaseCluster.

DatabaseClusterProps

Properties for a new database cluster.

DatabaseInstance

A database instance.

DatabaseInstanceAttributes

Properties that describe an existing instance.

DatabaseInstanceBase

A new or imported database instance.

DatabaseInstanceEngine

A database instance engine.

DatabaseInstanceFromSnapshot

A database instance restored from a snapshot.

DatabaseInstanceFromSnapshotProps

Construction properties for a DatabaseInstanceFromSnapshot.

DatabaseInstanceLookupOptions

Properties for looking up an existing DatabaseInstance.

DatabaseInstanceNewProps

Construction properties for a DatabaseInstanceNew.

DatabaseInstanceProps

Construction properties for a DatabaseInstance.

DatabaseInstanceReadReplica

A read replica database instance.

DatabaseInstanceReadReplicaProps

Construction properties for a DatabaseInstanceReadReplica.

DatabaseInstanceSourceProps

Construction properties for a DatabaseInstanceSource.

DatabaseProxy

RDS Database Proxy.

DatabaseProxyAttributes

Properties that describe an existing DB Proxy.

DatabaseProxyEndpoint

RDS Database Proxy Endpoint.

DatabaseProxyEndpointAttributes

Properties that describe an existing DB Proxy Endpoint.

DatabaseProxyEndpointOptions

Options for a new DatabaseProxyEndpoint.

DatabaseProxyEndpointProps

Construction properties for a DatabaseProxyEndpoint.

DatabaseProxyOptions

Options for a new DatabaseProxy.

DatabaseProxyProps

Construction properties for a DatabaseProxy.

DatabaseSecret

A database secret.

DatabaseSecretProps

Construction properties for a DatabaseSecret.

Endpoint

Connection endpoint of a database cluster or instance.

EngineVersion

A version of an engine - for either a cluster, or instance.

EventSubscriptionReference

A reference to a EventSubscription resource.

GlobalClusterReference

A reference to a GlobalCluster resource.

InstanceEngineBindOptions

The options passed to IInstanceEngine.bind.

InstanceEngineConfig

The type returned from the IInstanceEngine.bind method.

InstanceEngineFeatures

Represents Database Engine features.

InstanceProps

Instance properties for database instances.

IntegrationReference

A reference to a Integration resource.

MariaDbEngineVersion

The versions for the MariaDB instance engines (those returned by DatabaseInstanceEngine.mariaDb).

MariaDbInstanceEngineProps

Properties for MariaDB instance engines.

MySqlInstanceEngineProps

Properties for MySQL instance engines.

MysqlEngineVersion

The versions for the MySQL instance engines (those returned by DatabaseInstanceEngine.mysql).

OptionConfiguration

Configuration properties for an option.

OptionGroup

An option group.

OptionGroupProps

Construction properties for an OptionGroup.

OptionGroupReference

A reference to a OptionGroup resource.

OracleEeCdbInstanceEngineProps

Properties for Oracle Enterprise Edition (CDB) instance engines.

OracleEeInstanceEngineProps

Properties for Oracle Enterprise Edition instance engines.

OracleEngineVersion

The versions for the Oracle instance engines.

OracleSe2CdbInstanceEngineProps

Properties for Oracle Standard Edition 2 (CDB) instance engines.

OracleSe2InstanceEngineProps

Properties for Oracle Standard Edition 2 instance engines.

ParameterGroup

A parameter group.

ParameterGroupClusterBindOptions

Options for IParameterGroup.bindToCluster. Empty for now, but can be extended later.

ParameterGroupClusterConfig

The type returned from IParameterGroup.bindToCluster.

ParameterGroupInstanceBindOptions

Options for IParameterGroup.bindToInstance. Empty for now, but can be extended later.

ParameterGroupInstanceConfig

The type returned from IParameterGroup.bindToInstance.

ParameterGroupProps

Properties for a parameter group.

PostgresEngineFeatures

Features supported by the Postgres database engine.

PostgresEngineVersion

The versions for the PostgreSQL instance engines (those returned by DatabaseInstanceEngine.postgres).

PostgresInstanceEngineProps

Properties for PostgreSQL instance engines.

ProcessorFeatures

The processor features.

ProvisionedClusterInstanceProps

Options for creating a provisioned instance.

ProxyTarget

Proxy target: Instance or Cluster.

ProxyTargetConfig

The result of binding a ProxyTarget to a DatabaseProxy.

RotationMultiUserOptions

Options to add the multi user rotation.

RotationSingleUserOptions

Options to add the multi user rotation.

ServerlessCluster

Create an Aurora Serverless v1 Cluster.

ServerlessClusterAttributes

Properties that describe an existing cluster instance.

ServerlessClusterFromSnapshot

A Aurora Serverless v1 Cluster restored from a snapshot.

ServerlessClusterFromSnapshotProps

Properties for ServerlessClusterFromSnapshot.

ServerlessClusterProps

Properties for a new Aurora Serverless v1 Cluster.

ServerlessScalingOptions

Options for configuring scaling on an Aurora Serverless v1 Cluster.

ServerlessV2ClusterInstanceProps

Options for creating a serverless v2 instance.

SessionPinningFilter

SessionPinningFilter.

SnapshotCredentials

Credentials to update the password for a DatabaseInstanceFromSnapshot.

SnapshotCredentialsFromGeneratedPasswordOptions

Options used in the SnapshotCredentials.fromGeneratedPassword method.

SqlServerEeInstanceEngineProps

Properties for SQL Server Enterprise Edition instance engines.

SqlServerEngineVersion

The versions for the SQL Server instance engines (those returned by DatabaseInstanceEngine.sqlServerSe, DatabaseInstanceEngine.sqlServerEx, DatabaseInstanceEngine.sqlServerWeb and DatabaseInstanceEngine.sqlServerEe).

SqlServerExInstanceEngineProps

Properties for SQL Server Express Edition instance engines.

SqlServerSeInstanceEngineProps

Properties for SQL Server Standard Edition instance engines.

SqlServerWebInstanceEngineProps

Properties for SQL Server Web Edition instance engines.

SubnetGroup

Class for creating a RDS DB subnet group.

SubnetGroupProps

Properties for creating a SubnetGroup.

Interfaces

CfnDBCluster.IDBClusterRoleProperty

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

CfnDBCluster.IEndpointProperty

The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

CfnDBCluster.IMasterUserSecretProperty

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBCluster.IReadEndpointProperty

The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

CfnDBCluster.IScalingConfigurationProperty

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

CfnDBCluster.IServerlessV2ScalingConfigurationProperty

The ServerlessV2ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.

CfnDBInstance.ICertificateDetailsProperty

The details of the DB instance’s server certificate.

CfnDBInstance.IDBInstanceRoleProperty

Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

CfnDBInstance.IDBInstanceStatusInfoProperty

Provides a list of status information for a DB instance.

CfnDBInstance.IEndpointProperty

This data type represents the information you need to connect to an Amazon RDS DB instance.

CfnDBInstance.IMasterUserSecretProperty

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBInstance.IProcessorFeatureProperty

The ProcessorFeature property type specifies the processor features of a DB instance class.

CfnDBProxy.IAuthFormatProperty

Specifies the details of authentication used by a proxy to log in as a specific database user.

CfnDBProxy.ITagFormatProperty

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

CfnDBProxyEndpoint.ITagFormatProperty

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

CfnDBProxyTargetGroup.IConnectionPoolConfigurationInfoFormatProperty

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup .

CfnDBSecurityGroup.IIngressProperty

The Ingress property type specifies an individual ingress rule within an AWS::RDS::DBSecurityGroup resource.

CfnGlobalCluster.IGlobalEndpointProperty

The writer endpoint for the new global database cluster.

CfnOptionGroup.IOptionConfigurationProperty

The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource.

CfnOptionGroup.IOptionSettingProperty

The OptionSetting property type specifies the value for an option within an OptionSetting property.

IAuroraClusterEngineProps

(deprecated) Creation properties of the plain Aurora database cluster engine.

IAuroraClusterInstance

An Aurora Cluster Instance.

IAuroraMysqlClusterEngineProps

Creation properties of the Aurora MySQL database cluster engine.

IAuroraPostgresClusterEngineProps

Creation properties of the Aurora PostgreSQL database cluster engine.

IAuroraPostgresEngineFeatures

Features supported by this version of the Aurora Postgres cluster engine.

IBackupProps

Backup configuration for RDS databases.

ICfnCustomDBEngineVersionProps

Properties for defining a CfnCustomDBEngineVersion.

ICfnDBClusterParameterGroupProps

Properties for defining a CfnDBClusterParameterGroup.

ICfnDBClusterProps

Properties for defining a CfnDBCluster.

ICfnDBInstanceProps

Properties for defining a CfnDBInstance.

ICfnDBParameterGroupProps

Properties for defining a CfnDBParameterGroup.

ICfnDBProxyEndpointProps

Properties for defining a CfnDBProxyEndpoint.

ICfnDBProxyProps

Properties for defining a CfnDBProxy.

ICfnDBProxyTargetGroupProps

Properties for defining a CfnDBProxyTargetGroup.

ICfnDBSecurityGroupIngressProps

Properties for defining a CfnDBSecurityGroupIngress.

ICfnDBSecurityGroupProps

Properties for defining a CfnDBSecurityGroup.

ICfnDBShardGroupProps

Properties for defining a CfnDBShardGroup.

ICfnDBSubnetGroupProps

Properties for defining a CfnDBSubnetGroup.

ICfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

ICfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

ICfnIntegrationProps

Properties for defining a CfnIntegration.

ICfnOptionGroupProps

Properties for defining a CfnOptionGroup.

IClusterEngine

The interface representing a database cluster (as opposed to instance) engine.

IClusterEngineBindOptions

The extra options passed to the IClusterEngine.bindToCluster method.

IClusterEngineConfig

The type returned from the IClusterEngine.bindToCluster method.

IClusterEngineFeatures

Represents Database Engine features.

IClusterInstance

Represents an Aurora cluster instance This can be either a provisioned instance or a serverless v2 instance.

IClusterInstanceBindOptions

Options for binding the instance to the cluster.

IClusterInstanceOptions

Common options for creating a cluster instance.

IClusterInstanceProps

Common options for creating cluster instances (both serverless and provisioned).

ICommonRotationUserOptions

Properties common to single-user and multi-user rotation options.

ICredentialsBaseOptions

Base options for creating Credentials.

ICredentialsFromUsernameOptions

Options for creating Credentials from a username.

ICustomDBEngineVersionRef

(experimental) Indicates that this resource can be referenced as a CustomDBEngineVersion.

ICustomDBEngineVersionReference

A reference to a CustomDBEngineVersion resource.

IDBClusterParameterGroupRef

(experimental) Indicates that this resource can be referenced as a DBClusterParameterGroup.

IDBClusterParameterGroupReference

A reference to a DBClusterParameterGroup resource.

IDBClusterRef

(experimental) Indicates that this resource can be referenced as a DBCluster.

IDBClusterReference

A reference to a DBCluster resource.

IDBInstanceRef

(experimental) Indicates that this resource can be referenced as a DBInstance.

IDBInstanceReference

A reference to a DBInstance resource.

IDBParameterGroupRef

(experimental) Indicates that this resource can be referenced as a DBParameterGroup.

IDBParameterGroupReference

A reference to a DBParameterGroup resource.

IDBProxyEndpointRef

(experimental) Indicates that this resource can be referenced as a DBProxyEndpoint.

IDBProxyEndpointReference

A reference to a DBProxyEndpoint resource.

IDBProxyRef

(experimental) Indicates that this resource can be referenced as a DBProxy.

IDBProxyReference

A reference to a DBProxy resource.

IDBProxyTargetGroupRef

(experimental) Indicates that this resource can be referenced as a DBProxyTargetGroup.

IDBProxyTargetGroupReference

A reference to a DBProxyTargetGroup resource.

IDBSecurityGroupIngressRef

(experimental) Indicates that this resource can be referenced as a DBSecurityGroupIngress.

IDBSecurityGroupIngressReference

A reference to a DBSecurityGroupIngress resource.

IDBSecurityGroupRef

(experimental) Indicates that this resource can be referenced as a DBSecurityGroup.

IDBSecurityGroupReference

A reference to a DBSecurityGroup resource.

IDBShardGroupRef

(experimental) Indicates that this resource can be referenced as a DBShardGroup.

IDBShardGroupReference

A reference to a DBShardGroup resource.

IDBSubnetGroupRef

(experimental) Indicates that this resource can be referenced as a DBSubnetGroup.

IDBSubnetGroupReference

A reference to a DBSubnetGroup resource.

IDatabaseCluster

Create a clustered database with a given number of instances.

IDatabaseClusterAttributes

Properties that describe an existing cluster instance.

IDatabaseClusterFromSnapshotProps

Properties for DatabaseClusterFromSnapshot.

IDatabaseClusterLookupOptions

Properties for looking up an existing DatabaseCluster.

IDatabaseClusterProps

Properties for a new database cluster.

IDatabaseInstance

A database instance.

IDatabaseInstanceAttributes

Properties that describe an existing instance.

IDatabaseInstanceFromSnapshotProps

Construction properties for a DatabaseInstanceFromSnapshot.

IDatabaseInstanceLookupOptions

Properties for looking up an existing DatabaseInstance.

IDatabaseInstanceNewProps

Construction properties for a DatabaseInstanceNew.

IDatabaseInstanceProps

Construction properties for a DatabaseInstance.

IDatabaseInstanceReadReplicaProps

Construction properties for a DatabaseInstanceReadReplica.

IDatabaseInstanceSourceProps

Construction properties for a DatabaseInstanceSource.

IDatabaseProxy

DB Proxy.

IDatabaseProxyAttributes

Properties that describe an existing DB Proxy.

IDatabaseProxyEndpoint

A DB proxy endpoint.

IDatabaseProxyEndpointAttributes

Properties that describe an existing DB Proxy Endpoint.

IDatabaseProxyEndpointOptions

Options for a new DatabaseProxyEndpoint.

IDatabaseProxyEndpointProps

Construction properties for a DatabaseProxyEndpoint.

IDatabaseProxyOptions

Options for a new DatabaseProxy.

IDatabaseProxyProps

Construction properties for a DatabaseProxy.

IDatabaseSecretProps

Construction properties for a DatabaseSecret.

IEngine

A common interface for database engines.

IEngineVersion

A version of an engine - for either a cluster, or instance.

IEventSubscriptionRef

(experimental) Indicates that this resource can be referenced as a EventSubscription.

IEventSubscriptionReference

A reference to a EventSubscription resource.

IGlobalClusterRef

(experimental) Indicates that this resource can be referenced as a GlobalCluster.

IGlobalClusterReference

A reference to a GlobalCluster resource.

IInstanceEngine

Interface representing a database instance (as opposed to cluster) engine.

IInstanceEngineBindOptions

The options passed to IInstanceEngine.bind.

IInstanceEngineConfig

The type returned from the IInstanceEngine.bind method.

IInstanceEngineFeatures

Represents Database Engine features.

IInstanceProps

Instance properties for database instances.

IIntegrationRef

(experimental) Indicates that this resource can be referenced as a Integration.

IIntegrationReference

A reference to a Integration resource.

IMariaDbInstanceEngineProps

Properties for MariaDB instance engines.

IMySqlInstanceEngineProps

Properties for MySQL instance engines.

IOptionConfiguration

Configuration properties for an option.

IOptionGroup

An option group.

IOptionGroupProps

Construction properties for an OptionGroup.

IOptionGroupRef

(experimental) Indicates that this resource can be referenced as a OptionGroup.

IOptionGroupReference

A reference to a OptionGroup resource.

IOracleEeCdbInstanceEngineProps

Properties for Oracle Enterprise Edition (CDB) instance engines.

IOracleEeInstanceEngineProps

Properties for Oracle Enterprise Edition instance engines.

IOracleSe2CdbInstanceEngineProps

Properties for Oracle Standard Edition 2 (CDB) instance engines.

IOracleSe2InstanceEngineProps

Properties for Oracle Standard Edition 2 instance engines.

IParameterGroup

A parameter group.

IParameterGroupClusterBindOptions

Options for IParameterGroup.bindToCluster. Empty for now, but can be extended later.

IParameterGroupClusterConfig

The type returned from IParameterGroup.bindToCluster.

IParameterGroupInstanceBindOptions

Options for IParameterGroup.bindToInstance. Empty for now, but can be extended later.

IParameterGroupInstanceConfig

The type returned from IParameterGroup.bindToInstance.

IParameterGroupProps

Properties for a parameter group.

IPostgresEngineFeatures

Features supported by the Postgres database engine.

IPostgresInstanceEngineProps

Properties for PostgreSQL instance engines.

IProcessorFeatures

The processor features.

IProvisionedClusterInstanceProps

Options for creating a provisioned instance.

IProxyTargetConfig

The result of binding a ProxyTarget to a DatabaseProxy.

IRotationMultiUserOptions

Options to add the multi user rotation.

IRotationSingleUserOptions

Options to add the multi user rotation.

IServerlessCluster

Interface representing a serverless database cluster.

IServerlessClusterAttributes

Properties that describe an existing cluster instance.

IServerlessClusterFromSnapshotProps

Properties for ServerlessClusterFromSnapshot.

IServerlessClusterProps

Properties for a new Aurora Serverless v1 Cluster.

IServerlessScalingOptions

Options for configuring scaling on an Aurora Serverless v1 Cluster.

IServerlessV2ClusterInstanceProps

Options for creating a serverless v2 instance.

ISnapshotCredentialsFromGeneratedPasswordOptions

Options used in the SnapshotCredentials.fromGeneratedPassword method.

ISqlServerEeInstanceEngineProps

Properties for SQL Server Enterprise Edition instance engines.

ISqlServerExInstanceEngineProps

Properties for SQL Server Express Edition instance engines.

ISqlServerSeInstanceEngineProps

Properties for SQL Server Standard Edition instance engines.

ISqlServerWebInstanceEngineProps

Properties for SQL Server Web Edition instance engines.

ISubnetGroup

Interface for a subnet group.

ISubnetGroupProps

Properties for creating a SubnetGroup.

Enums

AuroraCapacityUnit

Aurora capacity units (ACUs).

ClientPasswordAuthType

Client password authentication type used by a proxy to log in as a specific database user.

ClusterScailabilityType

(deprecated) The scalability mode of the Aurora DB cluster.

ClusterScalabilityType

The scalability mode of the Aurora DB cluster.

DBClusterStorageType

The storage type to be associated with the DB cluster.

DatabaseInsightsMode

The database insights mode.

EngineLifecycleSupport

Engine lifecycle support for Amazon RDS and Amazon Aurora.

InstanceType
InstanceUpdateBehaviour

The orchestration of updates of multiple instances.

LicenseModel

The license model.

NetworkType

The network type of the DB instance.

PerformanceInsightRetention

The retention period for Performance Insight data, in days.

ProxyEndpointTargetRole

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

StorageType

The type of storage.

TimeoutAction

TimeoutAction defines the action to take when a timeout occurs if a scaling point is not found.

Back to top Generated by DocFX