Class GetClusterResult


  • public final class GetClusterResult
    extends java.lang.Object
    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        ARN of the cluster.
      • availabilityZones

        public java.util.List<java.lang.String> availabilityZones()
        Returns:
        Availability Zones of the RDS cluster.
      • backtrackWindow

        public java.lang.Integer backtrackWindow()
        Returns:
        Target backtrack window, in seconds.
      • backupRetentionPeriod

        public java.lang.Integer backupRetentionPeriod()
        Returns:
        Days to retain backups for.
      • clusterIdentifier

        public java.lang.String clusterIdentifier()
      • clusterMembers

        public java.util.List<java.lang.String> clusterMembers()
        Returns:
        List of RDS Instances that are a part of this cluster.
      • clusterResourceId

        public java.lang.String clusterResourceId()
        Returns:
        RDS Cluster Resource ID.
      • clusterScalabilityType

        public java.lang.String clusterScalabilityType()
        Returns:
        Scalability mode of the cluster.
      • databaseInsightsMode

        public java.lang.String databaseInsightsMode()
        Returns:
        Mode of Database Insights that is enabled for the cluster.
      • databaseName

        public java.lang.String databaseName()
        Returns:
        Name for an automatically created database on cluster creation.
      • dbClusterParameterGroupName

        public java.lang.String dbClusterParameterGroupName()
        Returns:
        Cluster parameter group associated with the cluster.
      • dbSubnetGroupName

        public java.lang.String dbSubnetGroupName()
        Returns:
        DB subnet group associated with the cluster.
      • dbSystemId

        public java.lang.String dbSystemId()
        Returns:
        System ID of the cluster.
      • deletionProtection

        public java.lang.Boolean deletionProtection()
        Returns:
        Whether the cluster has deletion protection enabled.
      • enabledCloudwatchLogsExports

        public java.util.List<java.lang.String> enabledCloudwatchLogsExports()
        Returns:
        List of log types exported to CloudWatch Logs.
      • endpoint

        public java.lang.String endpoint()
        Returns:
        DNS address of the RDS instance.
      • engine

        public java.lang.String engine()
        Returns:
        Database engine.
      • engineMode

        public java.lang.String engineMode()
        Returns:
        Database engine mode.
      • engineVersion

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

        public java.lang.String finalSnapshotIdentifier()
        Returns:
        Name of the final snapshot taken when the cluster is deleted.
      • hostedZoneId

        public java.lang.String hostedZoneId()
        Returns:
        Route53 Hosted Zone ID of the endpoint.
      • iamDatabaseAuthenticationEnabled

        public java.lang.Boolean iamDatabaseAuthenticationEnabled()
        Returns:
        Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
      • iamRoles

        public java.util.List<java.lang.String> iamRoles()
        Returns:
        IAM roles associated with the cluster.
      • id

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

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

        public java.util.List<GetClusterMasterUserSecret> masterUserSecrets()
        Returns:
        Block that specifies 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 database.
      • monitoringInterval

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

        public java.lang.String monitoringRoleArn()
        Returns:
        ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
      • networkType

        public java.lang.String networkType()
        Returns:
        Network type of the cluster.
      • port

        public java.lang.Integer port()
        Returns:
        Port on which the DB accepts connections.
      • 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.
      • readerEndpoint

        public java.lang.String readerEndpoint()
        Returns:
        Read-only endpoint for the cluster, automatically load-balanced across replicas.
      • region

        public java.lang.String region()
      • replicationSourceIdentifier

        public java.lang.String replicationSourceIdentifier()
        Returns:
        ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
      • storageEncrypted

        public java.lang.Boolean storageEncrypted()
        Returns:
        Whether the DB cluster is encrypted.
      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Map of tags assigned to the resource.
      • upgradeRolloutOrder

        public java.lang.String upgradeRolloutOrder()
        Returns:
        Order in which minor and major version upgrades are applied to the cluster.
      • vpcSecurityGroupIds

        public java.util.List<java.lang.String> vpcSecurityGroupIds()
        Returns:
        VPC security groups the cluster belongs to.