Package-level declarations
Types
Link copied to clipboard
The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Link copied to clipboard
data class CustomDbEngineVersionArgs(val databaseInstallationFilesS3BucketName: Output<String>? = null, val databaseInstallationFilesS3Prefix: Output<String>? = null, val description: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val kmsKeyId: Output<String>? = null, val manifest: Output<String>? = null, val status: Output<CustomDbEngineVersionStatus>? = null, val tags: Output<List<CustomDbEngineVersionTagArgs>>? = null) : ConvertibleToJava<CustomDbEngineVersionArgs>
The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Link copied to clipboard
Builder for CustomDbEngineVersionArgs.
Link copied to clipboard
Link copied to clipboard
Builder for CustomDbEngineVersion.
Link copied to clipboard
data class DbClusterArgs(val allocatedStorage: Output<Int>? = null, val associatedRoles: Output<List<DbClusterDbClusterRoleArgs>>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val backtrackWindow: Output<Int>? = null, val backupRetentionPeriod: Output<Int>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val databaseName: Output<String>? = null, val dbClusterIdentifier: Output<String>? = null, val dbClusterInstanceClass: Output<String>? = null, val dbClusterParameterGroupName: Output<String>? = null, val dbInstanceParameterGroupName: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val dbSystemId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val domain: Output<String>? = null, val domainIamRoleName: Output<String>? = null, val enableCloudwatchLogsExports: Output<List<String>>? = null, val enableHttpEndpoint: Output<Boolean>? = null, val enableIamDatabaseAuthentication: Output<Boolean>? = null, val engine: Output<String>? = null, val engineMode: Output<String>? = null, val engineVersion: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val iops: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val manageMasterUserPassword: Output<Boolean>? = null, val masterUserPassword: Output<String>? = null, val masterUserSecret: Output<DbClusterMasterUserSecretArgs>? = null, val masterUsername: Output<String>? = null, val monitoringInterval: Output<Int>? = null, val monitoringRoleArn: Output<String>? = null, val networkType: Output<String>? = null, val performanceInsightsEnabled: Output<Boolean>? = null, val performanceInsightsKmsKeyId: Output<String>? = null, val performanceInsightsRetentionPeriod: Output<Int>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val publiclyAccessible: Output<Boolean>? = null, val readEndpoint: Output<DbClusterReadEndpointArgs>? = null, val replicationSourceIdentifier: Output<String>? = null, val restoreToTime: Output<String>? = null, val restoreType: Output<String>? = null, val scalingConfiguration: Output<DbClusterScalingConfigurationArgs>? = null, val serverlessV2ScalingConfiguration: Output<DbClusterServerlessV2ScalingConfigurationArgs>? = null, val snapshotIdentifier: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val sourceRegion: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val storageType: Output<String>? = null, val tags: Output<List<DbClusterTagArgs>>? = null, val useLatestRestorableTime: Output<Boolean>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<DbClusterArgs>
The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
Link copied to clipboard
class DbClusterArgsBuilder
Builder for DbClusterArgs.
Link copied to clipboard
Link copied to clipboard
The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Link copied to clipboard
data class DbClusterParameterGroupArgs(val dbClusterParameterGroupName: Output<String>? = null, val description: Output<String>? = null, val family: Output<String>? = null, val parameters: Output<Any>? = null, val tags: Output<List<DbClusterParameterGroupTagArgs>>? = null) : ConvertibleToJava<DbClusterParameterGroupArgs>
The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Link copied to clipboard
Builder for DbClusterParameterGroupArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbClusterParameterGroup.
Link copied to clipboard
class DbClusterResourceBuilder
Builder for DbCluster.
Link copied to clipboard
The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.
Link copied to clipboard
data class DbInstanceArgs(val allocatedStorage: Output<String>? = null, val allowMajorVersionUpgrade: Output<Boolean>? = null, val associatedRoles: Output<List<DbInstanceDbInstanceRoleArgs>>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val automaticBackupReplicationRegion: Output<String>? = null, val availabilityZone: Output<String>? = null, val backupRetentionPeriod: Output<Int>? = null, val caCertificateIdentifier: Output<String>? = null, val certificateDetails: Output<DbInstanceCertificateDetailsArgs>? = null, val certificateRotationRestart: Output<Boolean>? = null, val characterSetName: Output<String>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val customIamInstanceProfile: Output<String>? = null, val dbClusterIdentifier: Output<String>? = null, val dbClusterSnapshotIdentifier: Output<String>? = null, val dbInstanceClass: Output<String>? = null, val dbInstanceIdentifier: Output<String>? = null, val dbName: Output<String>? = null, val dbParameterGroupName: Output<String>? = null, val dbSecurityGroups: Output<List<String>>? = null, val dbSnapshotIdentifier: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val deleteAutomatedBackups: Output<Boolean>? = null, val deletionProtection: Output<Boolean>? = null, val domain: Output<String>? = null, val domainAuthSecretArn: Output<String>? = null, val domainDnsIps: Output<List<String>>? = null, val domainFqdn: Output<String>? = null, val domainIamRoleName: Output<String>? = null, val domainOu: Output<String>? = null, val enableCloudwatchLogsExports: Output<List<String>>? = null, val enableIamDatabaseAuthentication: Output<Boolean>? = null, val enablePerformanceInsights: Output<Boolean>? = null, val endpoint: Output<DbInstanceEndpointArgs>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val iops: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val licenseModel: Output<String>? = null, val manageMasterUserPassword: Output<Boolean>? = null, val masterUserPassword: Output<String>? = null, val masterUserSecret: Output<DbInstanceMasterUserSecretArgs>? = null, val masterUsername: Output<String>? = null, val maxAllocatedStorage: Output<Int>? = null, val monitoringInterval: Output<Int>? = null, val monitoringRoleArn: Output<String>? = null, val multiAz: Output<Boolean>? = null, val ncharCharacterSetName: Output<String>? = null, val networkType: Output<String>? = null, val optionGroupName: Output<String>? = null, val performanceInsightsKmsKeyId: Output<String>? = null, val performanceInsightsRetentionPeriod: Output<Int>? = null, val port: Output<String>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val processorFeatures: Output<List<DbInstanceProcessorFeatureArgs>>? = null, val promotionTier: Output<Int>? = null, val publiclyAccessible: Output<Boolean>? = null, val replicaMode: Output<String>? = null, val restoreTime: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val sourceDbInstanceAutomatedBackupsArn: Output<String>? = null, val sourceDbInstanceIdentifier: Output<String>? = null, val sourceDbiResourceId: Output<String>? = null, val sourceRegion: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val storageThroughput: Output<Int>? = null, val storageType: Output<String>? = null, val tags: Output<List<DbInstanceTagArgs>>? = null, val tdeCredentialArn: Output<String>? = null, val tdeCredentialPassword: Output<String>? = null, val timezone: Output<String>? = null, val useDefaultProcessorFeatures: Output<Boolean>? = null, val useLatestRestorableTime: Output<Boolean>? = null, val vpcSecurityGroups: Output<List<String>>? = null) : ConvertibleToJava<DbInstanceArgs>
The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.
Link copied to clipboard
class DbInstanceArgsBuilder
Builder for DbInstanceArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbInstance.
Link copied to clipboard
The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family
Link copied to clipboard
data class DbParameterGroupArgs(val dbParameterGroupName: Output<String>? = null, val description: Output<String>? = null, val family: Output<String>? = null, val parameters: Output<Any>? = null, val tags: Output<List<DbParameterGroupTagArgs>>? = null) : ConvertibleToJava<DbParameterGroupArgs>
The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family
Link copied to clipboard
Builder for DbParameterGroupArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbParameterGroup.
Link copied to clipboard
data class DbProxyArgs(val auth: Output<List<DbProxyAuthFormatArgs>>? = null, val dbProxyName: Output<String>? = null, val debugLogging: Output<Boolean>? = null, val engineFamily: Output<DbProxyEngineFamily>? = null, val idleClientTimeout: Output<Int>? = null, val requireTls: Output<Boolean>? = null, val roleArn: Output<String>? = null, val tags: Output<List<DbProxyTagFormatArgs>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null, val vpcSubnetIds: Output<List<String>>? = null) : ConvertibleToJava<DbProxyArgs>
Resource schema for AWS::RDS::DBProxy
Link copied to clipboard
class DbProxyArgsBuilder
Builder for DbProxyArgs.
Link copied to clipboard
Resource schema for AWS::RDS::DBProxyEndpoint.
Link copied to clipboard
data class DbProxyEndpointArgs(val dbProxyEndpointName: Output<String>? = null, val dbProxyName: Output<String>? = null, val tags: Output<List<DbProxyEndpointTagFormatArgs>>? = null, val targetRole: Output<DbProxyEndpointTargetRole>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null, val vpcSubnetIds: Output<List<String>>? = null) : ConvertibleToJava<DbProxyEndpointArgs>
Resource schema for AWS::RDS::DBProxyEndpoint.
Link copied to clipboard
Builder for DbProxyEndpointArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbProxyEndpoint.
Link copied to clipboard
Link copied to clipboard
class DbProxyResourceBuilder
Builder for DbProxy.
Link copied to clipboard
Resource schema for AWS::RDS::DBProxyTargetGroup
Link copied to clipboard
data class DbProxyTargetGroupArgs(val connectionPoolConfigurationInfo: Output<DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs>? = null, val dbClusterIdentifiers: Output<List<String>>? = null, val dbInstanceIdentifiers: Output<List<String>>? = null, val dbProxyName: Output<String>? = null, val targetGroupName: Output<DbProxyTargetGroupTargetGroupName>? = null) : ConvertibleToJava<DbProxyTargetGroupArgs>
Resource schema for AWS::RDS::DBProxyTargetGroup
Link copied to clipboard
Builder for DbProxyTargetGroupArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbProxyTargetGroup.
Link copied to clipboard
The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
Link copied to clipboard
data class DbSubnetGroupArgs(val dbSubnetGroupDescription: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<List<DbSubnetGroupTagArgs>>? = null) : ConvertibleToJava<DbSubnetGroupArgs>
The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
Link copied to clipboard
class DbSubnetGroupArgsBuilder
Builder for DbSubnetGroupArgs.
Link copied to clipboard
Link copied to clipboard
Builder for DbSubnetGroup.
Link copied to clipboard
The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Link copied to clipboard
data class EventSubscriptionArgs(val enabled: Output<Boolean>? = null, val eventCategories: Output<List<String>>? = null, val snsTopicArn: Output<String>? = null, val sourceIds: Output<List<String>>? = null, val sourceType: Output<String>? = null, val subscriptionName: Output<String>? = null, val tags: Output<List<EventSubscriptionTagArgs>>? = null) : ConvertibleToJava<EventSubscriptionArgs>
The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Link copied to clipboard
Builder for EventSubscriptionArgs.
Link copied to clipboard
Link copied to clipboard
Builder for EventSubscription.
Link copied to clipboard
Resource Type definition for AWS::RDS::GlobalCluster
Link copied to clipboard
data class GlobalClusterArgs(val deletionProtection: Output<Boolean>? = null, val engine: Output<GlobalClusterEngine>? = null, val engineVersion: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null) : ConvertibleToJava<GlobalClusterArgs>
Resource Type definition for AWS::RDS::GlobalCluster
Link copied to clipboard
class GlobalClusterArgsBuilder
Builder for GlobalClusterArgs.
Link copied to clipboard
Link copied to clipboard
Builder for GlobalCluster.
Link copied to clipboard
The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Link copied to clipboard
data class OptionGroupArgs(val engineName: Output<String>? = null, val majorEngineVersion: Output<String>? = null, val optionConfigurations: Output<List<OptionGroupOptionConfigurationArgs>>? = null, val optionGroupDescription: Output<String>? = null, val optionGroupName: Output<String>? = null, val tags: Output<List<OptionGroupTagArgs>>? = null) : ConvertibleToJava<OptionGroupArgs>
The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Link copied to clipboard
class OptionGroupArgsBuilder
Builder for OptionGroupArgs.
Link copied to clipboard
Link copied to clipboard
Builder for OptionGroup.
Link copied to clipboard
object RdsFunctions
Functions
Link copied to clipboard
suspend fun customDbEngineVersion(name: String, block: suspend CustomDbEngineVersionResourceBuilder.() -> Unit): CustomDbEngineVersion
Link copied to clipboard
suspend fun dbClusterParameterGroup(name: String, block: suspend DbClusterParameterGroupResourceBuilder.() -> Unit): DbClusterParameterGroup
Link copied to clipboard
suspend fun dbInstance(name: String, block: suspend DbInstanceResourceBuilder.() -> Unit): DbInstance
Link copied to clipboard
suspend fun dbParameterGroup(name: String, block: suspend DbParameterGroupResourceBuilder.() -> Unit): DbParameterGroup
Link copied to clipboard
suspend fun dbProxyEndpoint(name: String, block: suspend DbProxyEndpointResourceBuilder.() -> Unit): DbProxyEndpoint
Link copied to clipboard
suspend fun dbProxyTargetGroup(name: String, block: suspend DbProxyTargetGroupResourceBuilder.() -> Unit): DbProxyTargetGroup
Link copied to clipboard
suspend fun dbSubnetGroup(name: String, block: suspend DbSubnetGroupResourceBuilder.() -> Unit): DbSubnetGroup
Link copied to clipboard
suspend fun eventSubscription(name: String, block: suspend EventSubscriptionResourceBuilder.() -> Unit): EventSubscription
Link copied to clipboard
suspend fun globalCluster(name: String, block: suspend GlobalClusterResourceBuilder.() -> Unit): GlobalCluster
Link copied to clipboard
suspend fun optionGroup(name: String, block: suspend OptionGroupResourceBuilder.() -> Unit): OptionGroup