GetDbInstanceResult

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)

Constructors

Link copied to clipboard
fun GetDbInstanceResult(allocatedStorage: String? = null, associatedRoles: List<DbInstanceDbInstanceRole>? = null, autoMinorVersionUpgrade: Boolean? = null, automaticBackupReplicationRegion: String? = null, availabilityZone: String? = null, backupRetentionPeriod: Int? = null, caCertificateIdentifier: String? = null, certificateDetails: DbInstanceCertificateDetails? = null, copyTagsToSnapshot: Boolean? = null, dbClusterSnapshotIdentifier: String? = null, dbInstanceArn: String? = null, dbInstanceClass: String? = null, dbParameterGroupName: String? = null, dbSecurityGroups: List<String>? = null, dbSystemId: String? = null, dbiResourceId: String? = null, deletionProtection: Boolean? = null, domain: String? = null, domainAuthSecretArn: String? = null, domainDnsIps: List<String>? = null, domainFqdn: String? = null, domainIamRoleName: String? = null, domainOu: String? = null, enableCloudwatchLogsExports: List<String>? = null, enableIamDatabaseAuthentication: Boolean? = null, enablePerformanceInsights: Boolean? = null, endpoint: DbInstanceEndpoint? = null, engine: String? = null, engineVersion: String? = null, iops: Int? = null, licenseModel: String? = null, manageMasterUserPassword: Boolean? = null, masterUserSecret: DbInstanceMasterUserSecret? = null, maxAllocatedStorage: Int? = null, monitoringInterval: Int? = null, monitoringRoleArn: String? = null, multiAz: Boolean? = null, networkType: String? = null, optionGroupName: String? = null, performanceInsightsKmsKeyId: String? = null, performanceInsightsRetentionPeriod: Int? = null, preferredBackupWindow: String? = null, preferredMaintenanceWindow: String? = null, processorFeatures: List<DbInstanceProcessorFeature>? = null, promotionTier: Int? = null, publiclyAccessible: Boolean? = null, replicaMode: String? = null, sourceDbClusterIdentifier: String? = null, storageThroughput: Int? = null, storageType: String? = null, tags: List<DbInstanceTag>? = null, tdeCredentialArn: String? = null, vpcSecurityGroups: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Link copied to clipboard

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Link copied to clipboard

Enables replication of automated backups to a different Amazon Web Services Region.

Link copied to clipboard

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

Link copied to clipboard

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

Link copied to clipboard

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Link copied to clipboard

The identifier of the CA certificate for this DB instance.

Link copied to clipboard

Returns the details of the DB instance's server certificate.

Link copied to clipboard

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Link copied to clipboard

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide . Constraints:

Link copied to clipboard
val dbInstanceArn: String? = null

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

Link copied to clipboard
val dbInstanceClass: String? = null

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

Link copied to clipboard
val dbiResourceId: String? = null

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Link copied to clipboard

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

Link copied to clipboard

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.

Link copied to clipboard
val dbSystemId: String? = null

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

Link copied to clipboard

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

Link copied to clipboard
val domain: String? = null

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

Link copied to clipboard

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Link copied to clipboard
val domainDnsIps: List<String>? = null

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Link copied to clipboard
val domainFqdn: String? = null

The fully qualified domain name (FQDN) of an Active Directory domain.

Link copied to clipboard

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

Link copied to clipboard
val domainOu: String? = null

The Active Directory organizational unit for your DB instance to join.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

A value that indicates whether to enable Performance Insights for the DB instance.

Link copied to clipboard

Specifies the connection endpoint.

Link copied to clipboard
val engine: String? = null

The name of the database engine that you want to use for this DB instance.

Link copied to clipboard
val engineVersion: String? = null

The version number of the database engine to use.

Link copied to clipboard
val iops: Int? = null

The number of I/O operations per second (IOPS) that the database provisions.

Link copied to clipboard
val licenseModel: String? = null

License model information for this DB instance.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Link copied to clipboard
val monitoringInterval: Int? = null

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

Link copied to clipboard

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

Link copied to clipboard
val multiAz: Boolean? = null

Specifies whether the database instance is a multiple Availability Zone deployment.

Link copied to clipboard
val networkType: String? = null

The network type of the DB cluster.

Link copied to clipboard
val optionGroupName: String? = null

Indicates that the DB instance should be associated with the specified option group.

Link copied to clipboard

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Link copied to clipboard

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Link copied to clipboard

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Link copied to clipboard

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

Link copied to clipboard

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Link copied to clipboard
val promotionTier: Int? = null

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

Link copied to clipboard

Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.

Link copied to clipboard
val replicaMode: String? = null

The open mode of an Oracle read replica. The default is open-read-only.

Link copied to clipboard

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

Link copied to clipboard
val storageThroughput: Int? = null

Specifies the storage throughput for the DB instance.

Link copied to clipboard
val storageType: String? = null

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

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

Tags to assign to the DB instance.

Link copied to clipboard

The ARN from the key store with which to associate the instance for TDE encryption.

Link copied to clipboard

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.