Package-level declarations

Types

Link copied to clipboard
data class CustomDbEngineVersionTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class DbClusterDbClusterRole(val featureName: String? = null, val roleArn: String)

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

Link copied to clipboard
data class DbClusterEndpoint(val address: String? = null, val port: String? = null)
Link copied to clipboard
data class DbClusterMasterUserSecret(val kmsKeyId: String? = null, val secretArn: String? = null)
Link copied to clipboard
data class DbClusterParameterGroupTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class DbClusterReadEndpoint(val address: String? = null)
Link copied to clipboard
data class DbClusterScalingConfiguration(val autoPause: Boolean? = null, val maxCapacity: Int? = null, val minCapacity: Int? = null, val secondsBeforeTimeout: Int? = null, val secondsUntilAutoPause: Int? = null, val timeoutAction: String? = null)

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

data class DbClusterServerlessV2ScalingConfiguration(val maxCapacity: Double? = null, val minCapacity: Double? = null)

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

Link copied to clipboard
data class DbClusterTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class DbInstanceCertificateDetails(val caIdentifier: String? = null, val validTill: String? = null)
Link copied to clipboard
data class DbInstanceDbInstanceRole(val featureName: String, val roleArn: String)
Link copied to clipboard
data class DbInstanceEndpoint(val address: String? = null, val hostedZoneId: String? = null, val port: String? = null)
Link copied to clipboard
data class DbInstanceMasterUserSecret(val kmsKeyId: String? = null, val secretArn: String? = null)
Link copied to clipboard
data class DbInstanceProcessorFeature(val name: DbInstanceProcessorFeatureName? = null, val value: String? = null)
Link copied to clipboard
data class DbInstanceTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class DbParameterGroupTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class DbProxyAuthFormat(val authScheme: DbProxyAuthFormatAuthScheme? = null, val clientPasswordAuthType: DbProxyAuthFormatClientPasswordAuthType? = null, val description: String? = null, val iamAuth: DbProxyAuthFormatIamAuth? = null, val secretArn: String? = null)
Link copied to clipboard
data class DbProxyEndpointTagFormat(val key: String? = null, val value: String? = null)
Link copied to clipboard
data class DbProxyTagFormat(val key: String? = null, val value: String? = null)
data class DbProxyTargetGroupConnectionPoolConfigurationInfoFormat(val connectionBorrowTimeout: Int? = null, val initQuery: String? = null, val maxConnectionsPercent: Int? = null, val maxIdleConnectionsPercent: Int? = null, val sessionPinningFilters: List<String>? = null)
Link copied to clipboard
data class DbSubnetGroupTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class EventSubscriptionTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.

Link copied to clipboard
data class GetCustomDbEngineVersionResult(val dbEngineVersionArn: String? = null, val description: String? = null, val status: CustomDbEngineVersionStatus? = null, val tags: List<CustomDbEngineVersionTag>? = null)
Link copied to clipboard
data class GetDbClusterParameterGroupResult(val parameters: Any? = null, val tags: List<DbClusterParameterGroupTag>? = null)
Link copied to clipboard
data class GetDbClusterResult(val allocatedStorage: Int? = null, val associatedRoles: List<DbClusterDbClusterRole>? = null, val autoMinorVersionUpgrade: Boolean? = null, val backtrackWindow: Int? = null, val backupRetentionPeriod: Int? = null, val copyTagsToSnapshot: Boolean? = null, val dbClusterArn: String? = null, val dbClusterInstanceClass: String? = null, val dbClusterParameterGroupName: String? = null, val dbClusterResourceId: String? = null, val deletionProtection: Boolean? = null, val domain: String? = null, val domainIamRoleName: String? = null, val enableCloudwatchLogsExports: List<String>? = null, val enableHttpEndpoint: Boolean? = null, val enableIamDatabaseAuthentication: Boolean? = null, val endpoint: DbClusterEndpoint? = null, val engine: String? = null, val engineVersion: String? = null, val globalClusterIdentifier: String? = null, val iops: Int? = null, val manageMasterUserPassword: Boolean? = null, val masterUserSecret: DbClusterMasterUserSecret? = null, val masterUsername: String? = null, val monitoringInterval: Int? = null, val monitoringRoleArn: String? = null, val networkType: String? = null, val performanceInsightsEnabled: Boolean? = null, val performanceInsightsKmsKeyId: String? = null, val performanceInsightsRetentionPeriod: Int? = null, val port: Int? = null, val preferredBackupWindow: String? = null, val preferredMaintenanceWindow: String? = null, val readEndpoint: DbClusterReadEndpoint? = null, val replicationSourceIdentifier: String? = null, val scalingConfiguration: DbClusterScalingConfiguration? = null, val serverlessV2ScalingConfiguration: DbClusterServerlessV2ScalingConfiguration? = null, val storageType: String? = null, val tags: List<DbClusterTag>? = null, val vpcSecurityGroupIds: List<String>? = null)
Link copied to clipboard
data class GetDbInstanceResult(val allocatedStorage: String? = null, val associatedRoles: List<DbInstanceDbInstanceRole>? = null, val autoMinorVersionUpgrade: Boolean? = null, val automaticBackupReplicationRegion: String? = null, val availabilityZone: String? = null, val backupRetentionPeriod: Int? = null, val caCertificateIdentifier: String? = null, val certificateDetails: DbInstanceCertificateDetails? = null, val copyTagsToSnapshot: Boolean? = null, val dbClusterSnapshotIdentifier: String? = null, val dbInstanceArn: String? = null, val dbInstanceClass: String? = null, val dbParameterGroupName: String? = null, val dbSecurityGroups: List<String>? = null, val dbSystemId: String? = null, val dbiResourceId: String? = null, val deletionProtection: Boolean? = null, val domain: String? = null, val domainAuthSecretArn: String? = null, val domainDnsIps: List<String>? = null, val domainFqdn: String? = null, val domainIamRoleName: String? = null, val domainOu: String? = null, val enableCloudwatchLogsExports: List<String>? = null, val enableIamDatabaseAuthentication: Boolean? = null, val enablePerformanceInsights: Boolean? = null, val endpoint: DbInstanceEndpoint? = null, val engine: String? = null, val engineVersion: String? = null, val iops: Int? = null, val licenseModel: String? = null, val manageMasterUserPassword: Boolean? = null, val masterUserSecret: DbInstanceMasterUserSecret? = null, val maxAllocatedStorage: Int? = null, val monitoringInterval: Int? = null, val monitoringRoleArn: String? = null, val multiAz: Boolean? = null, val networkType: String? = null, val optionGroupName: String? = null, val performanceInsightsKmsKeyId: String? = null, val performanceInsightsRetentionPeriod: Int? = null, val preferredBackupWindow: String? = null, val preferredMaintenanceWindow: String? = null, val processorFeatures: List<DbInstanceProcessorFeature>? = null, val promotionTier: Int? = null, val publiclyAccessible: Boolean? = null, val replicaMode: String? = null, val sourceDbClusterIdentifier: String? = null, val storageThroughput: Int? = null, val storageType: String? = null, val tags: List<DbInstanceTag>? = null, val tdeCredentialArn: String? = null, val vpcSecurityGroups: List<String>? = null)
Link copied to clipboard
data class GetDbParameterGroupResult(val parameters: Any? = null, val tags: List<DbParameterGroupTag>? = null)
Link copied to clipboard
data class GetDbProxyEndpointResult(val dbProxyEndpointArn: String? = null, val endpoint: String? = null, val isDefault: Boolean? = null, val tags: List<DbProxyEndpointTagFormat>? = null, val targetRole: DbProxyEndpointTargetRole? = null, val vpcId: String? = null, val vpcSecurityGroupIds: List<String>? = null)
Link copied to clipboard
data class GetDbProxyResult(val auth: List<DbProxyAuthFormat>? = null, val dbProxyArn: String? = null, val debugLogging: Boolean? = null, val endpoint: String? = null, val idleClientTimeout: Int? = null, val requireTls: Boolean? = null, val roleArn: String? = null, val tags: List<DbProxyTagFormat>? = null, val vpcId: String? = null, val vpcSecurityGroupIds: List<String>? = null)
Link copied to clipboard
data class GetDbProxyTargetGroupResult(val connectionPoolConfigurationInfo: DbProxyTargetGroupConnectionPoolConfigurationInfoFormat? = null, val dbClusterIdentifiers: List<String>? = null, val dbInstanceIdentifiers: List<String>? = null, val targetGroupArn: String? = null)
Link copied to clipboard
data class GetDbSubnetGroupResult(val dbSubnetGroupDescription: String? = null, val tags: List<DbSubnetGroupTag>? = null)
Link copied to clipboard
data class GetEventSubscriptionResult(val enabled: Boolean? = null, val eventCategories: List<String>? = null, val sourceIds: List<String>? = null, val sourceType: String? = null, val tags: List<EventSubscriptionTag>? = null)
Link copied to clipboard
data class GetGlobalClusterResult(val deletionProtection: Boolean? = null, val engineVersion: String? = null)
Link copied to clipboard
data class GetOptionGroupResult(val optionConfigurations: List<OptionGroupOptionConfiguration>? = null, val tags: List<OptionGroupTag>? = null)
Link copied to clipboard
data class OptionGroupOptionConfiguration(val dbSecurityGroupMemberships: List<String>? = null, val optionName: String, val optionSettings: List<OptionGroupOptionSetting>? = null, val optionVersion: String? = null, val port: Int? = null, val vpcSecurityGroupMemberships: List<String>? = null)

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

Link copied to clipboard
data class OptionGroupOptionSetting(val name: String? = null, val value: String? = null)

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

Link copied to clipboard
data class OptionGroupTag(val key: String, val value: String? = null)

A key-value pair to associate with a resource.