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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetDbClusterResponse.Builder,GetDbClusterResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetDbClusterResponse
extends TimestreamInfluxDbResponse
implements ToCopyableBuilder<GetDbClusterResponse.Builder,GetDbClusterResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetDbClusterResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 cluster.
`static GetDbClusterResponse.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 cluster.
`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.
`ClusterDeploymentType`	`deploymentType()`	Deployment type of the DB cluster.
`String`	`deploymentTypeAsString()`	Deployment type of the DB cluster.
`String`	`endpoint()`	The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FailoverMode`	`failoverMode()`	The configured failover mode for the DB cluster.
`String`	`failoverModeAsString()`	The configured failover mode for the DB cluster.
`<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()`	Service-generated unique identifier of the DB cluster to retrieve.
`String`	`influxAuthParametersSecretArn()`	The Amazon Resource Name (ARN) of the Amazon Web Services 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()`	Customer-supplied name of the Timestream for InfluxDB cluster.
`NetworkType`	`networkType()`	Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
`String`	`networkTypeAsString()`	Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
`Integer`	`port()`	The port number on which InfluxDB accepts connections.
`Boolean`	`publiclyAccessible()`	Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
`String`	`readerEndpoint()`	The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDbClusterResponse.Builder>`	`serializableBuilderClass()`
`ClusterStatus`	`status()`	The status of the DB cluster.
`String`	`statusAsString()`	The status of the DB cluster.
`GetDbClusterResponse.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 cluster.
`List<String>`	`vpcSubnetIds()`	A list of VPC subnet IDs associated with the DB cluster.

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()
```
    Service-generated unique identifier of the DB cluster to retrieve.
    
    Returns:
    
    Service-generated unique identifier of the DB cluster to retrieve.
  - name
```
public final String name()
```
    Customer-supplied name of the Timestream for InfluxDB cluster.
    
    Returns:
    
    Customer-supplied name of the Timestream for InfluxDB cluster.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the DB cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the DB cluster.
  - status
```
public final ClusterStatus status()
```
    The status of the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the DB cluster.
    
    See Also:
    
    ClusterStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the DB cluster.
    
    See Also:
    
    ClusterStatus
  - endpoint
```
public final String endpoint()
```
    The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
    
    Returns:
    
    The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
  - readerEndpoint
```
public final String readerEndpoint()
```
    The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
    
    Returns:
    
    The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
  - port
```
public final Integer port()
```
    The port number on which InfluxDB accepts connections.
    
    Returns:
    
    The port number on which InfluxDB accepts connections.
  - deploymentType
```
public final ClusterDeploymentType deploymentType()
```
    Deployment type of the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentType will return ClusterDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().
    
    Returns:
    
    Deployment type of the DB cluster.
    
    See Also:
    
    ClusterDeploymentType
  - deploymentTypeAsString
```
public final String deploymentTypeAsString()
```
    Deployment type of the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentType will return ClusterDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().
    
    Returns:
    
    Deployment type of the DB cluster.
    
    See Also:
    
    ClusterDeploymentType
  - 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
  - networkType
```
public final NetworkType networkType()
```
    Specifies whether the network type of the Timestream for InfluxDB cluster 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 network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
    
    See Also:
    
    NetworkType
  - networkTypeAsString
```
public final String networkTypeAsString()
```
    Specifies whether the network type of the Timestream for InfluxDB cluster 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 network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
    
    See Also:
    
    NetworkType
  - 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).
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
    
    Returns:
    
    Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
  - dbParameterGroupIdentifier
```
public final String dbParameterGroupIdentifier()
```
    The ID of the DB parameter group assigned to your DB cluster.
    
    Returns:
    
    The ID of the DB parameter group assigned to your DB cluster.
  - 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 Amazon Web Services 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 Amazon Web Services 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.
  - 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 cluster.
    
    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 cluster.
  - 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 cluster.
    
    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 cluster.
  - failoverMode
```
public final FailoverMode failoverMode()
```
    The configured failover mode for the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, failoverMode will return FailoverMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failoverModeAsString().
    
    Returns:
    
    The configured failover mode for the DB cluster.
    
    See Also:
    
    FailoverMode
  - failoverModeAsString
```
public final String failoverModeAsString()
```
    The configured failover mode for the DB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, failoverMode will return FailoverMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failoverModeAsString().
    
    Returns:
    
    The configured failover mode for the DB cluster.
    
    See Also:
    
    FailoverMode
  - toBuilder
```
public GetDbClusterResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDbClusterResponse.Builder,GetDbClusterResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetDbClusterResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDbClusterResponse.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetDbClusterResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

id

name

arn

status

statusAsString

endpoint

readerEndpoint

port

deploymentType

deploymentTypeAsString

dbInstanceType

dbInstanceTypeAsString

networkType

networkTypeAsString

dbStorageType

dbStorageTypeAsString

allocatedStorage

publiclyAccessible

dbParameterGroupIdentifier

logDeliveryConfiguration

influxAuthParametersSecretArn

hasVpcSubnetIds

vpcSubnetIds

hasVpcSecurityGroupIds

vpcSecurityGroupIds

failoverMode

failoverModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField