GetDbClusterResult

data class GetDbClusterResult(val associatedRoles: List<DbClusterDbClusterRole>? = null, val backupRetentionPeriod: Int? = null, val clusterResourceId: String? = null, val copyTagsToSnapshot: Boolean? = null, val dbClusterParameterGroupName: String? = null, val dbPort: Int? = null, val deletionProtection: Boolean? = null, val enableCloudwatchLogsExports: List<String>? = null, val endpoint: String? = null, val engineVersion: String? = null, val iamAuthEnabled: Boolean? = null, val port: String? = null, val preferredBackupWindow: String? = null, val preferredMaintenanceWindow: String? = null, val readEndpoint: String? = null, val serverlessScalingConfiguration: DbClusterServerlessScalingConfiguration? = null, val tags: List<Tag>? = null, val vpcSecurityGroupIds: List<String>? = null)

Constructors

Link copied to clipboard
constructor(associatedRoles: List<DbClusterDbClusterRole>? = null, backupRetentionPeriod: Int? = null, clusterResourceId: String? = null, copyTagsToSnapshot: Boolean? = null, dbClusterParameterGroupName: String? = null, dbPort: Int? = null, deletionProtection: Boolean? = null, enableCloudwatchLogsExports: List<String>? = null, endpoint: String? = null, engineVersion: String? = null, iamAuthEnabled: Boolean? = null, port: String? = null, preferredBackupWindow: String? = null, preferredMaintenanceWindow: String? = null, readEndpoint: String? = null, serverlessScalingConfiguration: DbClusterServerlessScalingConfiguration? = null, tags: List<Tag>? = null, vpcSecurityGroupIds: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

Specifies the number of days for which automatic DB snapshots are retained.

Link copied to clipboard

The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

Link copied to clipboard

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

Link copied to clipboard

Provides the name of the DB cluster parameter group.

Link copied to clipboard
val dbPort: Int? = null

The port number on which the DB instances in the DB cluster accept connections. If not specified, the default port used is 8182. Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

Link copied to clipboard

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Link copied to clipboard

Specifies a list of log types that are enabled for export to CloudWatch Logs.

Link copied to clipboard
val endpoint: String? = null

The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Link copied to clipboard
val engineVersion: String? = null

Indicates the database engine version.

Link copied to clipboard
val iamAuthEnabled: Boolean? = null

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Link copied to clipboard
val port: String? = null

The port number on which the DB cluster accepts connections. For example: 8182.

Link copied to clipboard

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Link copied to clipboard

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Link copied to clipboard
val readEndpoint: String? = null

The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Link copied to clipboard

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

Link copied to clipboard
val tags: List<Tag>? = null

The tags assigned to this cluster.

Link copied to clipboard

Provides a list of VPC security groups that the DB cluster belongs to.