Class DbInstanceSummary

    • Method Detail

      • id

        public final String id()

        The service-generated unique identifier of the DB instance.

        Returns:
        The service-generated unique identifier of the DB instance.
      • name

        public final String name()

        This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.

        Returns:
        This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
      • arn

        public final String arn()

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

        Returns:
        The Amazon Resource Name (ARN) of the DB instance.
      • status

        public final Status status()

        The status of the DB instance.

        If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the DB instance.
        See Also:
        Status
      • statusAsString

        public final String statusAsString()

        The status of the DB instance.

        If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the DB instance.
        See Also:
        Status
      • endpoint

        public final String endpoint()

        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

        Returns:
        The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
      • port

        public final Integer port()

        The port number on which InfluxDB accepts connections.

        Returns:
        The port number on which InfluxDB accepts connections.
      • dbInstanceType

        public final DbInstanceType dbInstanceType()

        The Timestream for InfluxDB instance type to run InfluxDB on.

        If the service returns an enum value that is not available in the current SDK version, dbInstanceType will return DbInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dbInstanceTypeAsString().

        Returns:
        The Timestream for InfluxDB instance type to run InfluxDB on.
        See Also:
        DbInstanceType
      • dbInstanceTypeAsString

        public final String dbInstanceTypeAsString()

        The Timestream for InfluxDB instance type to run InfluxDB on.

        If the service returns an enum value that is not available in the current SDK version, dbInstanceType will return DbInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dbInstanceTypeAsString().

        Returns:
        The Timestream for InfluxDB instance type to run InfluxDB on.
        See Also:
        DbInstanceType
      • dbStorageTypeAsString

        public final String dbStorageTypeAsString()

        The storage type for your DB instance.

        If the service returns an enum value that is not available in the current SDK version, dbStorageType will return DbStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dbStorageTypeAsString().

        Returns:
        The storage type for your DB instance.
        See Also:
        DbStorageType
      • allocatedStorage

        public final Integer allocatedStorage()

        The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

        Returns:
        The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
      • deploymentType

        public final DeploymentType deploymentType()

        Single-Instance or with a MultiAZ Standby for High availability.

        If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

        Returns:
        Single-Instance or with a MultiAZ Standby for High availability.
        See Also:
        DeploymentType
      • deploymentTypeAsString

        public final String deploymentTypeAsString()

        Single-Instance or with a MultiAZ Standby for High availability.

        If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

        Returns:
        Single-Instance or with a MultiAZ Standby for High availability.
        See Also:
        DeploymentType
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)