GetInstanceResult

data class GetInstanceResult(val address: String, val allocatedStorage: Int, val autoMinorVersionUpgrade: Boolean, val availabilityZone: String, val backupRetentionPeriod: Int, val caCertIdentifier: String, val dbClusterIdentifier: String, val dbInstanceArn: String, val dbInstanceClass: String, val dbInstanceIdentifier: String, val dbInstancePort: Int, val dbName: String, val dbParameterGroups: List<String>, val dbSecurityGroups: List<String>, val dbSubnetGroup: String, val enabledCloudwatchLogsExports: List<String>, val endpoint: String, val engine: String, val engineVersion: String, val hostedZoneId: String, val id: String, val iops: Int, val kmsKeyId: String, val licenseModel: String, val masterUserSecrets: List<GetInstanceMasterUserSecret>, val masterUsername: String, val monitoringInterval: Int, val monitoringRoleArn: String, val multiAz: Boolean, val networkType: String, val optionGroupMemberships: List<String>, val port: Int, val preferredBackupWindow: String, val preferredMaintenanceWindow: String, val publiclyAccessible: Boolean, val replicateSourceDb: String, val resourceId: String, val storageEncrypted: Boolean, val storageThroughput: Int, val storageType: String, val tags: Map<String, String>, val timezone: String, val vpcSecurityGroups: List<String>)

A collection of values returned by getInstance.

Constructors

Link copied to clipboard
constructor(address: String, allocatedStorage: Int, autoMinorVersionUpgrade: Boolean, availabilityZone: String, backupRetentionPeriod: Int, caCertIdentifier: String, dbClusterIdentifier: String, dbInstanceArn: String, dbInstanceClass: String, dbInstanceIdentifier: String, dbInstancePort: Int, dbName: String, dbParameterGroups: List<String>, dbSecurityGroups: List<String>, dbSubnetGroup: String, enabledCloudwatchLogsExports: List<String>, endpoint: String, engine: String, engineVersion: String, hostedZoneId: String, id: String, iops: Int, kmsKeyId: String, licenseModel: String, masterUserSecrets: List<GetInstanceMasterUserSecret>, masterUsername: String, monitoringInterval: Int, monitoringRoleArn: String, multiAz: Boolean, networkType: String, optionGroupMemberships: List<String>, port: Int, preferredBackupWindow: String, preferredMaintenanceWindow: String, publiclyAccessible: Boolean, replicateSourceDb: String, resourceId: String, storageEncrypted: Boolean, storageThroughput: Int, storageType: String, tags: Map<String, String>, timezone: String, vpcSecurityGroups: List<String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Hostname of the RDS instance. See also endpoint and port.

Link copied to clipboard

Allocated storage size specified in gigabytes.

Link copied to clipboard

Indicates that minor version patches are applied automatically.

Link copied to clipboard

Name of the Availability Zone the DB instance is located in.

Link copied to clipboard

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

Link copied to clipboard

Identifier of the CA certificate for the DB instance.

Link copied to clipboard

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Link copied to clipboard

ARN for the DB instance.

Link copied to clipboard

Contains the name of the compute and memory capacity class of the DB instance.

Link copied to clipboard
Link copied to clipboard

Port that the DB instance listens on.

Link copied to clipboard

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Link copied to clipboard

Provides the list of DB parameter groups applied to this DB instance.

Link copied to clipboard

Provides List of DB security groups associated to this DB instance.

Link copied to clipboard

Name of the subnet group associated with the DB instance.

Link copied to clipboard

List of log types to export to cloudwatch.

Link copied to clipboard

Connection endpoint in address:port format.

Link copied to clipboard

Provides the name of the database engine to be used for this DB instance.

Link copied to clipboard

Database engine version.

Link copied to clipboard

Canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
val iops: Int

Provisioned IOPS (I/O operations per second) value.

Link copied to clipboard

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

Link copied to clipboard

License model information for this DB instance.

Link copied to clipboard

Contains the master username for the DB instance.

Link copied to clipboard

Provides the master user secret. Only available when manage_master_user_password is set to true. Documented below.

Link copied to clipboard

Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Link copied to clipboard

ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.

Link copied to clipboard

If the DB instance is a Multi-AZ deployment.

Link copied to clipboard

Network type of the DB instance.

Link copied to clipboard

Provides the list of option group memberships for this DB instance.

Link copied to clipboard
val port: Int

Database port.

Link copied to clipboard

Specifies the daily time range during which automated backups are created.

Link copied to clipboard

Specifies the weekly time range during which system maintenance can occur in UTC.

Link copied to clipboard

Accessibility options for the DB instance.

Link copied to clipboard

Identifier of the source DB that this is a replica of.

Link copied to clipboard

RDS Resource ID of this instance.

Link copied to clipboard

Whether the DB instance is encrypted.

Link copied to clipboard

Storage throughput value for the DB instance.

Link copied to clipboard

Storage type associated with DB instance.

Link copied to clipboard
Link copied to clipboard

Time zone of the DB instance.

Link copied to clipboard

Provides a list of VPC security group elements that the DB instance belongs to.