Package com.pulumi.aws.rds.outputs

Class GetInstanceResult

  • public final class GetInstanceResult
extends java.lang.Object

    • Method Detail

      • address

        public java.lang.String address()
        Returns:
        Hostname of the RDS instance. See also `endpoint` and `port`.

      • allocatedStorage

        public java.lang.Integer allocatedStorage()
        Returns:
        Allocated storage size specified in gigabytes.

      • autoMinorVersionUpgrade

        public java.lang.Boolean autoMinorVersionUpgrade()
        Returns:
        Whether minor version patches are applied automatically.

      • availabilityZone

        public java.lang.String availabilityZone()
        Returns:
        Name of the Availability Zone the DB instance is located in.

      • backupRetentionPeriod

        public java.lang.Integer backupRetentionPeriod()
        Returns:
        Number of days for which automatic DB snapshots are retained.

      • caCertIdentifier

        public java.lang.String caCertIdentifier()
        Returns:
        Identifier of the CA certificate for the DB instance.

      • databaseInsightsMode

        public java.lang.String databaseInsightsMode()
        Returns:
        Mode of Database Insights that is enabled for the DB instance.

      • dbClusterIdentifier

        public java.lang.String dbClusterIdentifier()
        Returns:
        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.

      • dbInstanceArn

        public java.lang.String dbInstanceArn()
        Returns:
        ARN for the DB instance.

      • dbInstanceClass

        public java.lang.String dbInstanceClass()
        Returns:
        Name of the compute and memory capacity class of the DB instance.

      • dbInstanceIdentifier

        public java.lang.String dbInstanceIdentifier()

      • dbInstancePort

        public java.lang.Integer dbInstancePort()
        Returns:
        Port that the DB instance listens on.

      • dbName

        public java.lang.String dbName()
        Returns:
        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.

      • dbParameterGroups

        public java.util.List<java.lang.String> dbParameterGroups()
        Returns:
        Provides the list of DB parameter groups applied to this DB instance.

      • dbSubnetGroup

        public java.lang.String dbSubnetGroup()
        Returns:
        Name of the subnet group associated with the DB instance.

      • enabledCloudwatchLogsExports

        public java.util.List<java.lang.String> enabledCloudwatchLogsExports()
        Returns:
        List of log types to export to CloudWatch.

      • endpoint

        public java.lang.String endpoint()
        Returns:
        Connection endpoint in `address:port` format.

      • engine

        public java.lang.String engine()
        Returns:
        Provides the name of the database engine to be used for this DB instance.

      • engineVersion

        public java.lang.String engineVersion()
        Returns:
        Database engine version.

      • hostedZoneId

        public java.lang.String hostedZoneId()
        Returns:
        Canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).

      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.

      • iops

        public java.lang.Integer iops()
        Returns:
        Provisioned IOPS (I/O operations per second) value.

      • kmsKeyId

        public java.lang.String kmsKeyId()
        Returns:
        Amazon Web Services KMS key identifier that is used to encrypt the secret.

      • licenseModel

        public java.lang.String licenseModel()
        Returns:
        License model information for this DB instance.

      • masterUserSecrets

        public java.util.List<GetInstanceMasterUserSecret> masterUserSecrets()
        Returns:
        Provides the master user secret. Only available when `manageMasterUserPassword` is set to true. Documented below.

      • masterUsername

        public java.lang.String masterUsername()
        Returns:
        Master username for the DB instance.

      • maxAllocatedStorage

        public java.lang.Integer maxAllocatedStorage()
        Returns:
        Upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

      • monitoringInterval

        public java.lang.Integer monitoringInterval()
        Returns:
        Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

      • monitoringRoleArn

        public java.lang.String monitoringRoleArn()
        Returns:
        ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.

      • multiAz

        public java.lang.Boolean multiAz()
        Returns:
        If the DB instance is a Multi-AZ deployment.

      • networkType

        public java.lang.String networkType()
        Returns:
        Network type of the DB instance.

      • optionGroupMemberships

        public java.util.List<java.lang.String> optionGroupMemberships()
        Returns:
        Provides the list of option group memberships for this DB instance.

      • port

        public java.lang.Integer port()
        Returns:
        Database endpoint port, primarily used by an Aurora DB cluster. For a conventional RDS DB instance, the `dbInstancePort` is typically the preferred choice.

      • preferredBackupWindow

        public java.lang.String preferredBackupWindow()
        Returns:
        Daily time range during which automated backups are created.

      • preferredMaintenanceWindow

        public java.lang.String preferredMaintenanceWindow()
        Returns:
        Weekly time range during which system maintenance can occur in UTC.

      • publiclyAccessible

        public java.lang.Boolean publiclyAccessible()
        Returns:
        Accessibility options for the DB instance.

      • region

        public java.lang.String region()

      • replicateSourceDb

        public java.lang.String replicateSourceDb()
        Returns:
        Identifier of the source DB that this is a replica of.

      • resourceId

        public java.lang.String resourceId()
        Returns:
        RDS Resource ID of this instance.

      • storageEncrypted

        public java.lang.Boolean storageEncrypted()
        Returns:
        Whether the DB instance is encrypted.

      • storageThroughput

        public java.lang.Integer storageThroughput()
        Returns:
        Storage throughput value for the DB instance.

      • storageType

        public java.lang.String storageType()
        Returns:
        Storage type associated with DB instance.

      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()

      • timezone

        public java.lang.String timezone()
        Returns:
        Time zone of the DB instance.

      • upgradeRolloutOrder

        public java.lang.String upgradeRolloutOrder()
        Returns:
        Order in which the instances are upgraded (`first`, `second`, `last`). See [the AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Maintenance.AMVU.UpgradeRollout.html) for details.

      • vpcSecurityGroups

        public java.util.List<java.lang.String> vpcSecurityGroups()
        Returns:
        Provides a list of VPC security group elements that the DB instance belongs to.