Package-level declarations

Types

Link copied to clipboard
data class DbClusterDbClusterRoleArgs(val featureName: Output<String>? = null, val roleArn: Output<String>) : ConvertibleToJava<DbClusterDbClusterRoleArgs>

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

Link copied to clipboard
data class DbClusterMasterUserSecretArgs(val kmsKeyId: Output<String>? = null, val secretArn: Output<String>? = null) : ConvertibleToJava<DbClusterMasterUserSecretArgs>

The `MasterUserSecret` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide.

Link copied to clipboard
data class DbClusterReadEndpointArgs(val address: Output<String>? = null) : ConvertibleToJava<DbClusterReadEndpointArgs>

The `ReadEndpoint` return value specifies the reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide.

Link copied to clipboard
data class DbClusterScalingConfigurationArgs(val autoPause: Output<Boolean>? = null, val maxCapacity: Output<Int>? = null, val minCapacity: Output<Int>? = null, val secondsBeforeTimeout: Output<Int>? = null, val secondsUntilAutoPause: Output<Int>? = null, val timeoutAction: Output<String>? = null) : ConvertibleToJava<DbClusterScalingConfigurationArgs>

The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster. For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the `ServerlessV2ScalingConfiguration` property. Valid for: Aurora Serverless v1 DB clusters only

data class DbClusterServerlessV2ScalingConfigurationArgs(val maxCapacity: Output<Double>? = null, val minCapacity: Output<Double>? = null) : ConvertibleToJava<DbClusterServerlessV2ScalingConfigurationArgs>

The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide. If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the `db.serverless` DB instance class. For more information, see Clusters that use Aurora Serverless v2 must have a capacity range specified in the Amazon Aurora User Guide. This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the `ScalingConfiguration` property. Valid for: Aurora Serverless v2 DB clusters

Link copied to clipboard
data class DbInstanceCertificateDetailsArgs(val caIdentifier: Output<String>? = null, val validTill: Output<String>? = null) : ConvertibleToJava<DbInstanceCertificateDetailsArgs>

The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Link copied to clipboard
data class DbInstanceDbInstanceRoleArgs(val featureName: Output<String>, val roleArn: Output<String>) : ConvertibleToJava<DbInstanceDbInstanceRoleArgs>

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

Link copied to clipboard
data class DbInstanceEndpointArgs(val address: Output<String>? = null, val hostedZoneId: Output<String>? = null, val port: Output<String>? = null) : ConvertibleToJava<DbInstanceEndpointArgs>

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

Link copied to clipboard
data class DbInstanceMasterUserSecretArgs(val kmsKeyId: Output<String>? = null, val secretArn: Output<String>? = null) : ConvertibleToJava<DbInstanceMasterUserSecretArgs>

The `MasterUserSecret` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide.

Link copied to clipboard
data class DbInstanceProcessorFeatureArgs(val name: Output<DbInstanceProcessorFeatureName>? = null, val value: Output<String>? = null) : ConvertibleToJava<DbInstanceProcessorFeatureArgs>

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

Link copied to clipboard
data class DbProxyAuthFormatArgs(val authScheme: Output<DbProxyAuthFormatAuthScheme>? = null, val clientPasswordAuthType: Output<DbProxyAuthFormatClientPasswordAuthType>? = null, val description: Output<String>? = null, val iamAuth: Output<DbProxyAuthFormatIamAuth>? = null, val secretArn: Output<String>? = null) : ConvertibleToJava<DbProxyAuthFormatArgs>
data class DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs(val connectionBorrowTimeout: Output<Int>? = null, val initQuery: Output<String>? = null, val maxConnectionsPercent: Output<Int>? = null, val maxIdleConnectionsPercent: Output<Int>? = null, val sessionPinningFilters: Output<List<String>>? = null) : ConvertibleToJava<DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs>
Link copied to clipboard
data class GetCustomDbEngineVersionPlainArgs(val engine: String, val engineVersion: String) : ConvertibleToJava<GetCustomDbEngineVersionPlainArgs>
Link copied to clipboard
data class GetDbClusterParameterGroupPlainArgs(val dbClusterParameterGroupName: String) : ConvertibleToJava<GetDbClusterParameterGroupPlainArgs>
Link copied to clipboard
data class GetDbClusterPlainArgs(val dbClusterIdentifier: String) : ConvertibleToJava<GetDbClusterPlainArgs>
Link copied to clipboard
data class GetDbInstancePlainArgs(val dbInstanceIdentifier: String) : ConvertibleToJava<GetDbInstancePlainArgs>
Link copied to clipboard
data class GetDbParameterGroupPlainArgs(val dbParameterGroupName: String) : ConvertibleToJava<GetDbParameterGroupPlainArgs>
Link copied to clipboard
data class GetDbProxyEndpointPlainArgs(val dbProxyEndpointName: String) : ConvertibleToJava<GetDbProxyEndpointPlainArgs>
Link copied to clipboard
data class GetDbProxyPlainArgs(val dbProxyName: String) : ConvertibleToJava<GetDbProxyPlainArgs>
Link copied to clipboard
data class GetDbProxyTargetGroupPlainArgs(val targetGroupArn: String) : ConvertibleToJava<GetDbProxyTargetGroupPlainArgs>
Link copied to clipboard
data class GetDbSubnetGroupPlainArgs(val dbSubnetGroupName: String) : ConvertibleToJava<GetDbSubnetGroupPlainArgs>
Link copied to clipboard
data class GetEventSubscriptionPlainArgs(val subscriptionName: String) : ConvertibleToJava<GetEventSubscriptionPlainArgs>
Link copied to clipboard
data class GetGlobalClusterPlainArgs(val globalClusterIdentifier: String) : ConvertibleToJava<GetGlobalClusterPlainArgs>
Link copied to clipboard
data class GetIntegrationPlainArgs(val integrationArn: String) : ConvertibleToJava<GetIntegrationPlainArgs>
Link copied to clipboard
data class GetOptionGroupPlainArgs(val optionGroupName: String) : ConvertibleToJava<GetOptionGroupPlainArgs>
Link copied to clipboard
data class OptionGroupOptionConfigurationArgs(val dbSecurityGroupMemberships: Output<List<String>>? = null, val optionName: Output<String>, val optionSettings: Output<List<OptionGroupOptionSettingArgs>>? = null, val optionVersion: Output<String>? = null, val port: Output<Int>? = null, val vpcSecurityGroupMemberships: Output<List<String>>? = null) : ConvertibleToJava<OptionGroupOptionConfigurationArgs>

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

Link copied to clipboard
data class OptionGroupOptionSettingArgs(val name: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<OptionGroupOptionSettingArgs>

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