pulumi-aws-native-kotlin/com.pulumi.awsnative.rds.kotlin.outputs

Package-level declarations

Types

DbClusterDbClusterRole

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.

DbClusterEndpoint

data class DbClusterEndpoint(val address: String? = null, val port: String? = null)

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

DbClusterMasterUserSecret

data class DbClusterMasterUserSecret(val kmsKeyId: String? = null, val secretArn: String? = null)

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.

DbClusterReadEndpoint

data class DbClusterReadEndpoint(val address: String? = null)

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.

DbClusterScalingConfiguration

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 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

DbClusterServerlessV2ScalingConfiguration

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

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

DbInstanceCertificateDetails

data class DbInstanceCertificateDetails(val caIdentifier: String? = null, val validTill: String? = null)

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.

DbInstanceDbInstanceRole

data class DbInstanceDbInstanceRole(val featureName: String, val roleArn: String)

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

DbInstanceEndpoint

data class DbInstanceEndpoint(val address: String? = null, val hostedZoneId: String? = null, val port: String? = null)

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:

DbInstanceMasterUserSecret

data class DbInstanceMasterUserSecret(val kmsKeyId: String? = null, val secretArn: String? = null)

DbInstanceProcessorFeature

data class DbInstanceProcessorFeature(val name: DbInstanceProcessorFeatureName? = null, val value: String? = null)

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

DbProxyAuthFormat

data class DbProxyAuthFormat(val authScheme: DbProxyAuthFormatAuthScheme? = null, val clientPasswordAuthType: DbProxyAuthFormatClientPasswordAuthType? = null, val description: String? = null, val iamAuth: DbProxyAuthFormatIamAuth? = null, val secretArn: String? = null)

DbProxyTargetGroupConnectionPoolConfigurationInfoFormat

data class DbProxyTargetGroupConnectionPoolConfigurationInfoFormat(val connectionBorrowTimeout: Int? = null, val initQuery: String? = null, val maxConnectionsPercent: Int? = null, val maxIdleConnectionsPercent: Int? = null, val sessionPinningFilters: List<String>? = null)

GetCustomDbEngineVersionResult

data class GetCustomDbEngineVersionResult(val dbEngineVersionArn: String? = null, val description: String? = null, val status: CustomDbEngineVersionStatus? = null, val tags: List<Tag>? = null)

GetDbClusterParameterGroupResult

data class GetDbClusterParameterGroupResult(val parameters: Any? = null, val tags: List<Tag>? = null)

GetDbClusterResult

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 databaseInsightsMode: String? = 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 enableGlobalWriteForwarding: Boolean? = null, val enableHttpEndpoint: Boolean? = null, val enableIamDatabaseAuthentication: Boolean? = null, val enableLocalWriteForwarding: Boolean? = null, val endpoint: DbClusterEndpoint? = null, val engine: String? = null, val engineLifecycleSupport: 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 storageThroughput: Int? = null, val storageType: String? = null, val tags: List<Tag>? = null, val vpcSecurityGroupIds: List<String>? = null)

GetDbInstanceResult

data class GetDbInstanceResult(val allocatedStorage: String? = null, val associatedRoles: List<DbInstanceDbInstanceRole>? = null, val autoMinorVersionUpgrade: Boolean? = null, val automaticBackupReplicationRegion: String? = null, val automaticBackupReplicationRetentionPeriod: Int? = null, val availabilityZone: String? = null, val backupRetentionPeriod: Int? = null, val caCertificateIdentifier: String? = null, val certificateDetails: DbInstanceCertificateDetails? = null, val copyTagsToSnapshot: Boolean? = null, val databaseInsightsMode: String? = null, val dbClusterSnapshotIdentifier: String? = null, val dbInstanceArn: String? = null, val dbInstanceClass: String? = null, val dbParameterGroupName: String? = null, val dbSecurityGroups: List<String>? = null, val dbiResourceId: String? = null, val dedicatedLogVolume: Boolean? = 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 engineLifecycleSupport: 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 port: String? = 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<Tag>? = null, val tdeCredentialArn: String? = null, val vpcSecurityGroups: List<String>? = null)

GetDbParameterGroupResult

data class GetDbParameterGroupResult(val parameters: Any? = null, val tags: List<Tag>? = null)

GetDbProxyEndpointResult

data class GetDbProxyEndpointResult(val dbProxyEndpointArn: String? = null, val endpoint: String? = null, val isDefault: Boolean? = null, val tags: List<Tag>? = null, val targetRole: DbProxyEndpointTargetRole? = null, val vpcId: String? = null, val vpcSecurityGroupIds: List<String>? = null)

GetDbProxyResult

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<Tag>? = null, val vpcId: String? = null, val vpcSecurityGroupIds: List<String>? = null)

GetDbProxyTargetGroupResult

data class GetDbProxyTargetGroupResult(val connectionPoolConfigurationInfo: DbProxyTargetGroupConnectionPoolConfigurationInfoFormat? = null, val dbClusterIdentifiers: List<String>? = null, val dbInstanceIdentifiers: List<String>? = null, val targetGroupArn: String? = null)

GetDbShardGroupResult

data class GetDbShardGroupResult(val computeRedundancy: Int? = null, val dbShardGroupResourceId: String? = null, val endpoint: String? = null, val maxAcu: Double? = null, val tags: List<Tag>? = null)

GetDbSubnetGroupResult

data class GetDbSubnetGroupResult(val dbSubnetGroupDescription: String? = null, val subnetIds: List<String>? = null, val tags: List<Tag>? = null)

GetEventSubscriptionResult

data class GetEventSubscriptionResult(val enabled: Boolean? = null, val eventCategories: List<String>? = null, val sourceIds: List<String>? = null, val sourceType: String? = null, val tags: List<Tag>? = null)

GetGlobalClusterResult

data class GetGlobalClusterResult(val deletionProtection: Boolean? = null, val engineLifecycleSupport: String? = null, val engineVersion: String? = null, val globalEndpoint: GlobalClusterGlobalEndpoint? = null, val tags: List<Tag>? = null)

GetIntegrationResult

data class GetIntegrationResult(val createTime: String? = null, val dataFilter: String? = null, val description: String? = null, val integrationArn: String? = null, val integrationName: String? = null, val tags: List<Tag>? = null)

GetOptionGroupResult

data class GetOptionGroupResult(val optionConfigurations: List<OptionGroupOptionConfiguration>? = null, val tags: List<Tag>? = null)

GlobalClusterGlobalEndpoint

data class GlobalClusterGlobalEndpoint(val address: String? = null)

OptionGroupOptionConfiguration

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.

OptionGroupOptionSetting

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.