java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.timestreaminfluxdb.model.TimestreamInfluxDbRequest
    - - software.amazon.awssdk.services.timestreaminfluxdb.model.CreateDbClusterRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDbClusterRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`allocatedStorage()`	The amount of storage to allocate for your DB storage type in GiB (gibibytes).
`String`	`bucket()`	The name of the initial InfluxDB bucket.
`static CreateDbClusterRequest.Builder`	`builder()`
`DbInstanceType`	`dbInstanceType()`	The Timestream for InfluxDB DB instance type to run InfluxDB on.
`String`	`dbInstanceTypeAsString()`	The Timestream for InfluxDB DB instance type to run InfluxDB on.
`String`	`dbParameterGroupIdentifier()`	The ID of the DB parameter group to assign to your DB cluster.
`DbStorageType`	`dbStorageType()`	The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
`String`	`dbStorageTypeAsString()`	The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
`ClusterDeploymentType`	`deploymentType()`	Specifies the type of cluster to create.
`String`	`deploymentTypeAsString()`	Specifies the type of cluster to create.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FailoverMode`	`failoverMode()`	Specifies the behavior of failure recovery when the primary node of the cluster fails.
`String`	`failoverModeAsString()`	Specifies the behavior of failure recovery when the primary node of the cluster fails.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`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.
`LogDeliveryConfiguration`	`logDeliveryConfiguration()`	Configuration for sending InfluxDB engine logs to a specified S3 bucket.
`String`	`name()`	The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
`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.
`String`	`organization()`	The name of the initial organization for the initial admin user in InfluxDB.
`String`	`password()`	The password of the initial admin user created in InfluxDB.
`Integer`	`port()`	The port number on which InfluxDB accepts connections.
`Boolean`	`publiclyAccessible()`	Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDbClusterRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	A list of key-value pairs to associate with the DB instance.
`CreateDbClusterRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`username()`	The username of the initial admin user created in InfluxDB.
`List<String>`	`vpcSecurityGroupIds()`	A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
`List<String>`	`vpcSubnetIds()`	A list of VPC subnet IDs to associate with the DB cluster.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - name
```
public final String name()
```
    The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.
    
    Returns:
    
    The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.
  - username
```
public final String username()
```
    The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.
    
    Returns:
    
    The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.
  - password
```
public final String password()
```
    The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.
    
    Returns:
    
    The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.
  - organization
```
public final String organization()
```
    The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
    
    Returns:
    
    The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
  - bucket
```
public final String bucket()
```
    The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
    
    Returns:
    
    The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
  - port
```
public final Integer port()
```
    The port number on which InfluxDB accepts connections.
    
    Valid Values: 1024-65535
    
    Default: 8086
    
    Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
    
    Returns:
    
    The port number on which InfluxDB accepts connections.
    
    Valid Values: 1024-65535
    
    Default: 8086
    
    Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
  - dbParameterGroupIdentifier
```
public final String dbParameterGroupIdentifier()
```
    The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
    
    Returns:
    
    The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
  - dbInstanceType
```
public final DbInstanceType dbInstanceType()
```
    The Timestream for InfluxDB DB 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 DB instance type to run InfluxDB on.
    
    See Also:
    
    DbInstanceType
  - dbInstanceTypeAsString
```
public final String dbInstanceTypeAsString()
```
    The Timestream for InfluxDB DB 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 DB instance type to run InfluxDB on.
    
    See Also:
    
    DbInstanceType
  - dbStorageType
```
public final DbStorageType dbStorageType()
```
    The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
    
    You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
    
    Influx I/O Included 3000 IOPS
    
    Influx I/O Included 12000 IOPS
    
    Influx I/O Included 16000 IOPS
    
    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 to read and write InfluxDB data.
    
    You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
    
    Influx I/O Included 3000 IOPS
    
    Influx I/O Included 12000 IOPS
    
    Influx I/O Included 16000 IOPS
    
    See Also:
    
    DbStorageType
  - dbStorageTypeAsString
```
public final String dbStorageTypeAsString()
```
    The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
    
    You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
    
    Influx I/O Included 3000 IOPS
    
    Influx I/O Included 12000 IOPS
    
    Influx I/O Included 16000 IOPS
    
    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 to read and write InfluxDB data.
    
    You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
    
    Influx I/O Included 3000 IOPS
    
    Influx I/O Included 12000 IOPS
    
    Influx I/O Included 16000 IOPS
    
    See Also:
    
    DbStorageType
  - allocatedStorage
```
public final Integer allocatedStorage()
```
    The amount of storage to allocate for your DB storage type in GiB (gibibytes).
    
    Returns:
    
    The amount of storage to allocate for your DB storage type in GiB (gibibytes).
  - 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
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
    
    Returns:
    
    Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
  - 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 to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.
    
    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 to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.
  - 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 to associate with the Timestream for InfluxDB 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 to associate with the Timestream for InfluxDB cluster.
  - deploymentType
```
public final ClusterDeploymentType deploymentType()
```
    Specifies the type of cluster to create.
    
    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:
    
    Specifies the type of cluster to create.
    
    See Also:
    
    ClusterDeploymentType
  - deploymentTypeAsString
```
public final String deploymentTypeAsString()
```
    Specifies the type of cluster to create.
    
    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:
    
    Specifies the type of cluster to create.
    
    See Also:
    
    ClusterDeploymentType
  - failoverMode
```
public final FailoverMode failoverMode()
```
    Specifies the behavior of failure recovery when the primary node of the cluster fails.
    
    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:
    
    Specifies the behavior of failure recovery when the primary node of the cluster fails.
    
    See Also:
    
    FailoverMode
  - failoverModeAsString
```
public final String failoverModeAsString()
```
    Specifies the behavior of failure recovery when the primary node of the cluster fails.
    
    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:
    
    Specifies the behavior of failure recovery when the primary node of the cluster fails.
    
    See Also:
    
    FailoverMode
  - logDeliveryConfiguration
```
public final LogDeliveryConfiguration logDeliveryConfiguration()
```
    Configuration for sending InfluxDB engine logs to a specified S3 bucket.
    
    Returns:
    
    Configuration for sending InfluxDB engine logs to a specified S3 bucket.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    A list of key-value pairs to associate 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 hasTags() method.
    
    Returns:
    
    A list of key-value pairs to associate with the DB instance.
  - toBuilder
```
public CreateDbClusterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
    
    Specified by:
    
    toBuilder in class TimestreamInfluxDbRequest
  - builder
```
public static CreateDbClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDbClusterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - 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 CreateDbClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

name

username

password

organization

bucket

port

dbParameterGroupIdentifier

dbInstanceType

dbInstanceTypeAsString

dbStorageType

dbStorageTypeAsString

allocatedStorage

networkType

networkTypeAsString

publiclyAccessible

hasVpcSubnetIds

vpcSubnetIds

hasVpcSecurityGroupIds

vpcSecurityGroupIds

deploymentType

deploymentTypeAsString

failoverMode

failoverModeAsString

logDeliveryConfiguration

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField