Class CreateDbInstanceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.timestreaminfluxdb.model.TimestreamInfluxDbResponse
software.amazon.awssdk.services.timestreaminfluxdb.model.CreateDbInstanceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDbInstanceResponse.Builder,CreateDbInstanceResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateDbInstanceResponse extends TimestreamInfluxDbResponse implements ToCopyableBuilder<CreateDbInstanceResponse.Builder,CreateDbInstanceResponse>

  • Method Details

    • id

      public final String id()

      A service-generated unique identifier.

      Returns:
      A service-generated unique identifier.

    • name

      public final String name()

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

      Returns:
      The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and 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:

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

    • 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. The default value is 8086.

      Returns:
      The port number on which InfluxDB accepts connections. The default value is 8086.

    • networkType

      public final NetworkType networkType()

      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

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

      Returns:
      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

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

      Returns:
      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
      See Also:

    • dbInstanceType

      public final DbInstanceType dbInstanceType()

      The Timestream for InfluxDB instance type that InfluxDB runs 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 that InfluxDB runs on.
      See Also:

    • dbInstanceTypeAsString

      public final String dbInstanceTypeAsString()

      The Timestream for InfluxDB instance type that InfluxDB runs 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 that InfluxDB runs on.
      See Also:

    • dbStorageType

      public final DbStorageType dbStorageType()

      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:

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

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

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

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

    • dbClusterId

      public final String dbClusterId()

      Specifies the DbCluster to which this DbInstance belongs to.

      Returns:
      Specifies the DbCluster to which this DbInstance belongs to.

    • instanceMode

      public final InstanceMode instanceMode()

      Specifies the DbInstance's role in the cluster.

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

      Returns:
      Specifies the DbInstance's role in the cluster.
      See Also:

    • instanceModeAsString

      public final String instanceModeAsString()

      Specifies the DbInstance's role in the cluster.

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

      Returns:
      Specifies the DbInstance's role in the cluster.
      See Also:

    • toBuilder

      public CreateDbInstanceResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDbInstanceResponse.Builder,CreateDbInstanceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateDbInstanceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDbInstanceResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.