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

Interface CreateDbInstanceRequest.Builder

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

  • Method Details

    • name

      CreateDbInstanceRequest.Builder name(String name)

      The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

      Parameters:
      name - The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance 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

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

    • password

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

    • organization

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

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

    • dbInstanceType

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

      CreateDbInstanceRequest.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:

    • vpcSubnetIds

      CreateDbInstanceRequest.Builder vpcSubnetIds(Collection<String> vpcSubnetIds)

      A list of VPC subnet IDs to associate with the DB instance. 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 instance. 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

      CreateDbInstanceRequest.Builder vpcSubnetIds(String... vpcSubnetIds)

      A list of VPC subnet IDs to associate with the DB instance. 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 instance. 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

      CreateDbInstanceRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of VPC security group IDs to associate with the DB instance.

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

    • vpcSecurityGroupIds

      CreateDbInstanceRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of VPC security group IDs to associate with the DB instance.

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

    • publiclyAccessible

      CreateDbInstanceRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Configures the DB instance with a public IP to facilitate access.

      Parameters:
      publiclyAccessible - Configures the DB instance with a public IP to facilitate access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbStorageType

      CreateDbInstanceRequest.Builder dbStorageType(String dbStorageType)

      The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

      You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

      • Influx IO Included 3000 IOPS

      • Influx IO Included 12000 IOPS

      • Influx IO Included 16000 IOPS

      Parameters:
      dbStorageType - The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

      You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

      • Influx IO Included 3000 IOPS

      • Influx IO Included 12000 IOPS

      • Influx IO Included 16000 IOPS

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

    • dbStorageType

      CreateDbInstanceRequest.Builder dbStorageType(DbStorageType dbStorageType)

      The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

      You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

      • Influx IO Included 3000 IOPS

      • Influx IO Included 12000 IOPS

      • Influx IO Included 16000 IOPS

      Parameters:
      dbStorageType - The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

      You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

      • Influx IO Included 3000 IOPS

      • Influx IO Included 12000 IOPS

      • Influx IO Included 16000 IOPS

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

    • allocatedStorage

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

    • dbParameterGroupIdentifier

      CreateDbInstanceRequest.Builder dbParameterGroupIdentifier(String dbParameterGroupIdentifier)

      The id of the DB parameter group to assign to your DB instance. 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 instance. 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.

    • deploymentType

      CreateDbInstanceRequest.Builder deploymentType(String deploymentType)

      Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

      Parameters:
      deploymentType - Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deploymentType

      CreateDbInstanceRequest.Builder deploymentType(DeploymentType deploymentType)

      Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

      Parameters:
      deploymentType - Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logDeliveryConfiguration

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

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

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

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