Interface CreateDbClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, SdkBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, SdkPojo, SdkRequest.Builder, TimestreamInfluxDbRequest.Builder
Enclosing class:
CreateDbClusterRequest
@Mutable @NotThreadSafe public static interface CreateDbClusterRequest.Builder extends TimestreamInfluxDbRequest.Builder, SdkPojo, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

  • Method Details

    • name

      CreateDbClusterRequest.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • username

      CreateDbClusterRequest.Builder username(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 Secrets Manager in your account.

      Parameters:
      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 Secrets Manager in your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • password

      CreateDbClusterRequest.Builder password(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 Secrets Manager in your account.

      Parameters:
      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 Secrets Manager in your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organization

      CreateDbClusterRequest.Builder organization(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • bucket

      CreateDbClusterRequest.Builder bucket(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • port

      CreateDbClusterRequest.Builder port(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dbParameterGroupIdentifier

      CreateDbClusterRequest.Builder dbParameterGroupIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceType

      CreateDbClusterRequest.Builder dbInstanceType(String dbInstanceType)

      The Timestream for InfluxDB DB instance type to run InfluxDB on.

      Parameters:
      dbInstanceType - The Timestream for InfluxDB DB instance type to run InfluxDB on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dbInstanceType

      CreateDbClusterRequest.Builder dbInstanceType(DbInstanceType dbInstanceType)

      The Timestream for InfluxDB DB instance type to run InfluxDB on.

      Parameters:
      dbInstanceType - The Timestream for InfluxDB DB instance type to run InfluxDB on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dbStorageType

      CreateDbClusterRequest.Builder dbStorageType(String 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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dbStorageType

      CreateDbClusterRequest.Builder dbStorageType(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allocatedStorage

      CreateDbClusterRequest.Builder allocatedStorage(Integer allocatedStorage)

      The amount of storage to allocate for your DB storage type in GiB (gibibytes).

      Parameters:
      allocatedStorage - The amount of storage to allocate for your DB storage type in GiB (gibibytes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkType

      CreateDbClusterRequest.Builder networkType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkType

      CreateDbClusterRequest.Builder networkType(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • publiclyAccessible

      CreateDbClusterRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.

      Parameters:
      publiclyAccessible - Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSubnetIds

      CreateDbClusterRequest.Builder vpcSubnetIds(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSubnetIds

      CreateDbClusterRequest.Builder vpcSubnetIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      CreateDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.

      Parameters:
      vpcSecurityGroupIds - A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      CreateDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.

      Parameters:
      vpcSecurityGroupIds - A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentType

      CreateDbClusterRequest.Builder deploymentType(String deploymentType)

      Specifies the type of cluster to create.

      Parameters:
      deploymentType - Specifies the type of cluster to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deploymentType

      CreateDbClusterRequest.Builder deploymentType(ClusterDeploymentType deploymentType)

      Specifies the type of cluster to create.

      Parameters:
      deploymentType - Specifies the type of cluster to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failoverMode

      CreateDbClusterRequest.Builder failoverMode(String failoverMode)

      Specifies the behavior of failure recovery when the primary node of the cluster fails.

      Parameters:
      failoverMode - Specifies the behavior of failure recovery when the primary node of the cluster fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failoverMode

      CreateDbClusterRequest.Builder failoverMode(FailoverMode failoverMode)

      Specifies the behavior of failure recovery when the primary node of the cluster fails.

      Parameters:
      failoverMode - Specifies the behavior of failure recovery when the primary node of the cluster fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logDeliveryConfiguration

      CreateDbClusterRequest.Builder logDeliveryConfiguration(LogDeliveryConfiguration logDeliveryConfiguration)

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

      Parameters:
      logDeliveryConfiguration - Configuration for sending InfluxDB engine logs to a specified S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logDeliveryConfiguration

      default CreateDbClusterRequest.Builder logDeliveryConfiguration(Consumer<LogDeliveryConfiguration.Builder> logDeliveryConfiguration)

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

      This is a convenience method that creates an instance of the LogDeliveryConfiguration.Builder avoiding the need to create one manually via LogDeliveryConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logDeliveryConfiguration(LogDeliveryConfiguration).

      Parameters:
      logDeliveryConfiguration - a consumer that will call methods on LogDeliveryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateDbClusterRequest.Builder tags(Map<String,String> tags)

      A list of key-value pairs to associate with the DB instance.

      Parameters:
      tags - A list of key-value pairs to associate with the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.