Package software.amazon.awssdk.services.timestreaminfluxdb.model

Class UpdateDbInstanceResponse

    • Method Detail

      • id

        public final String id()

        A service-generated unique identifier.

        Returns:
        A service-generated unique identifier.

      • 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.

      • dbStorageTypeAsString

        public final String dbStorageTypeAsString()

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

        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 Timestream for InfluxDB DB storage type that InfluxDB stores data on.
        See Also:
        DbStorageType

      • allocatedStorage

        public final Integer allocatedStorage()

        The amount of storage allocated for your DB storage type (in gibibytes).

        Returns:
        The amount of storage allocated for your DB storage type (in gibibytes).

      • deploymentType

        public final DeploymentType deploymentType()

        Specifies whether the Timestream for InfluxDB is deployed as Single-AZ 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:
        Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
        See Also:
        DeploymentType

      • deploymentTypeAsString

        public final String deploymentTypeAsString()

        Specifies whether the Timestream for InfluxDB is deployed as Single-AZ 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:
        Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
        See Also:
        DeploymentType

      • hasVpcSubnetIds

        public final boolean hasVpcSubnetIds()
        For responses, this returns true if the service returned a value for the VpcSubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSubnetIds

        public final List<String> vpcSubnetIds()

        A list of VPC subnet IDs associated with the DB instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSubnetIds() method.

        Returns:
        A list of VPC subnet IDs associated with the DB instance.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Indicates if the DB instance has a public IP to facilitate access.

        Returns:
        Indicates if the DB instance has a public IP to facilitate access.

      • hasVpcSecurityGroupIds

        public final boolean hasVpcSecurityGroupIds()
        For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSecurityGroupIds

        public final List<String> vpcSecurityGroupIds()

        A list of VPC security group IDs associated with the DB instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

        Returns:
        A list of VPC security group IDs associated with the DB instance.

      • dbParameterGroupIdentifier

        public final String dbParameterGroupIdentifier()

        The id of the DB parameter group assigned to your DB instance.

        Returns:
        The id of the DB parameter group assigned to your DB instance.

      • availabilityZone

        public final String availabilityZone()

        The Availability Zone in which the DB instance resides.

        Returns:
        The Availability Zone in which the DB instance resides.

      • secondaryAvailabilityZone

        public final String secondaryAvailabilityZone()

        The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

        Returns:
        The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

      • logDeliveryConfiguration

        public final LogDeliveryConfiguration logDeliveryConfiguration()

        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

        Returns:
        Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

      • influxAuthParametersSecretArn

        public final String influxAuthParametersSecretArn()

        The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

        Returns:
        The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

      • 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