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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDbInstanceResponse.Builder

Method Summary

Modifier and Type	Method	Description
Integer	allocatedStorage()	The amount of storage allocated for your DB storage type (in gibibytes).
String	arn()	The Amazon Resource Name (ARN) of the DB instance.
String	availabilityZone()	The Availability Zone in which the DB instance resides.
static CreateDbInstanceResponse.Builder	builder()
DbInstanceType	dbInstanceType()	The Timestream for InfluxDB instance type that InfluxDB runs on.
String	dbInstanceTypeAsString()	The Timestream for InfluxDB instance type that InfluxDB runs on.
String	dbParameterGroupIdentifier()	The id of the DB parameter group assigned to your DB instance.
DbStorageType	dbStorageType()	The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
String	dbStorageTypeAsString()	The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
DeploymentType	deploymentType()	Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
String	deploymentTypeAsString()	Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
String	endpoint()	The endpoint used to connect to InfluxDB.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVpcSecurityGroupIds()	For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
boolean	hasVpcSubnetIds()	For responses, this returns true if the service returned a value for the VpcSubnetIds property.
String	id()	A service-generated unique identifier.
String	influxAuthParametersSecretArn()	The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters.
LogDeliveryConfiguration	logDeliveryConfiguration()	Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
String	name()	The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
Boolean	publiclyAccessible()	Indicates if the DB instance has a public IP to facilitate access.
List<SdkField<?>>	sdkFields()
String	secondaryAvailabilityZone()	The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
static Class<? extends CreateDbInstanceResponse.Builder>	serializableBuilderClass()
Status	status()	The status of the DB instance.
String	statusAsString()	The status of the DB instance.
CreateDbInstanceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	vpcSecurityGroupIds()	A list of VPC security group IDs associated with the DB instance.
List<String>	vpcSubnetIds()	A list of VPC subnet IDs associated with the DB instance.

Methods inherited from class software.amazon.awssdk.services.timestreaminfluxdb.model.TimestreamInfluxDbResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

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.

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:

DbInstanceType

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:

DbInstanceType

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:

DbStorageType

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.

toBuilder

public CreateDbInstanceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDbInstanceResponse.Builder,CreateDbInstanceResponse>

Specified by:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo