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

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

Constructors

GetDbClusterResult

fun GetDbClusterResult(allocatedStorage: Int? = null, associatedRoles: List<DbClusterDbClusterRole>? = null, autoMinorVersionUpgrade: Boolean? = null, backtrackWindow: Int? = null, backupRetentionPeriod: Int? = null, copyTagsToSnapshot: Boolean? = null, dbClusterArn: String? = null, dbClusterInstanceClass: String? = null, dbClusterParameterGroupName: String? = null, dbClusterResourceId: String? = null, deletionProtection: Boolean? = null, domain: String? = null, domainIamRoleName: String? = null, enableCloudwatchLogsExports: List<String>? = null, enableHttpEndpoint: Boolean? = null, enableIamDatabaseAuthentication: Boolean? = null, endpoint: DbClusterEndpoint? = null, engine: String? = null, engineVersion: String? = null, globalClusterIdentifier: String? = null, iops: Int? = null, manageMasterUserPassword: Boolean? = null, masterUserSecret: DbClusterMasterUserSecret? = null, masterUsername: String? = null, monitoringInterval: Int? = null, monitoringRoleArn: String? = null, networkType: String? = null, performanceInsightsEnabled: Boolean? = null, performanceInsightsKmsKeyId: String? = null, performanceInsightsRetentionPeriod: Int? = null, port: Int? = null, preferredBackupWindow: String? = null, preferredMaintenanceWindow: String? = null, readEndpoint: DbClusterReadEndpoint? = null, replicationSourceIdentifier: String? = null, scalingConfiguration: DbClusterScalingConfiguration? = null, serverlessV2ScalingConfiguration: DbClusterServerlessV2ScalingConfiguration? = null, storageType: String? = null, tags: List<DbClusterTag>? = null, vpcSecurityGroupIds: List<String>? = null)

Types

Companion

object Companion

Properties

allocatedStorage

val allocatedStorage: Int? = null

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associatedRoles

val associatedRoles: List<DbClusterDbClusterRole>? = null

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

autoMinorVersionUpgrade

val autoMinorVersionUpgrade: Boolean? = null

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

backtrackWindow

val backtrackWindow: Int? = null

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod

val backupRetentionPeriod: Int? = null

The number of days for which automated backups are retained.

copyTagsToSnapshot

val copyTagsToSnapshot: Boolean? = null

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dbClusterArn

val dbClusterArn: String? = null

The Amazon Resource Name (ARN) for the DB cluster.

dbClusterInstanceClass

val dbClusterInstanceClass: String? = null

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dbClusterParameterGroupName

val dbClusterParameterGroupName: String? = null

The name of the DB cluster parameter group to associate with this DB cluster.

dbClusterResourceId

val dbClusterResourceId: String? = null

The AWS Region-unique, immutable identifier for the DB cluster.

deletionProtection

val deletionProtection: Boolean? = null

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain

val domain: String? = null

The Active Directory directory ID to create the DB cluster in.

domainIamRoleName

val domainIamRoleName: String? = null

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports

val enableCloudwatchLogsExports: List<String>? = null

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

enableHttpEndpoint

val enableHttpEndpoint: Boolean? = null

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIamDatabaseAuthentication

val enableIamDatabaseAuthentication: Boolean? = null

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

endpoint

val endpoint: DbClusterEndpoint? = null

engine

val engine: String? = null

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineVersion

val engineVersion: String? = null

The version number of the database engine to use.

globalClusterIdentifier

val globalClusterIdentifier: String? = null

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. If you aren't configuring a global database cluster, don't specify this property.

iops

val iops: Int? = null

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

manageMasterUserPassword

val manageMasterUserPassword: Boolean? = null

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUsername

val masterUsername: String? = null

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

masterUserSecret

val masterUserSecret: DbClusterMasterUserSecret? = null

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

monitoringInterval

val monitoringInterval: Int? = null

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn

val monitoringRoleArn: String? = null

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

networkType

val networkType: String? = null

The network type of the DB cluster.

performanceInsightsEnabled

val performanceInsightsEnabled: Boolean? = null

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId

val performanceInsightsKmsKeyId: String? = null

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod

val performanceInsightsRetentionPeriod: Int? = null

The amount of time, in days, to retain Performance Insights data.

port

val port: Int? = null

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow

val preferredBackupWindow: String? = null

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

preferredMaintenanceWindow

val preferredMaintenanceWindow: String? = null

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

readEndpoint

val readEndpoint: DbClusterReadEndpoint? = null

replicationSourceIdentifier

val replicationSourceIdentifier: String? = null

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

scalingConfiguration

val scalingConfiguration: DbClusterScalingConfiguration? = null

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

serverlessV2ScalingConfiguration

val serverlessV2ScalingConfiguration: DbClusterServerlessV2ScalingConfiguration? = null

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

storageType

val storageType: String? = null

Specifies the storage type to be associated with the DB cluster.