Package com.pulumi.aws.timestreaminfluxdb

Class DbClusterArgs.Builder

  • Enclosing class:
    DbClusterArgs
    public static final class DbClusterArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • allocatedStorage

        public DbClusterArgs.Builder allocatedStorage​(@Nullable
                                              com.pulumi.core.Output<java.lang.Integer> allocatedStorage)
        Parameters:
        allocatedStorage - Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `dbStorageType` places restrictions on this argument's minimum value. The following is a list of `dbStorageType` values and the corresponding minimum value for `allocatedStorage`: ` "InfluxIOIncludedT1": `20` , `"InfluxIOIncludedT2" and ` "InfluxIOIncludedT3": `400`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • allocatedStorage

        public DbClusterArgs.Builder allocatedStorage​(java.lang.Integer allocatedStorage)
        Parameters:
        allocatedStorage - Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `dbStorageType` places restrictions on this argument's minimum value. The following is a list of `dbStorageType` values and the corresponding minimum value for `allocatedStorage`: ` "InfluxIOIncludedT1": `20` , `"InfluxIOIncludedT2" and ` "InfluxIOIncludedT3": `400`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • bucket

        public DbClusterArgs.Builder bucket​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> bucket)
        Parameters:
        bucket - 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. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • bucket

        public DbClusterArgs.Builder bucket​(java.lang.String bucket)
        Parameters:
        bucket - 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. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • dbInstanceType

        public DbClusterArgs.Builder dbInstanceType​(com.pulumi.core.Output<java.lang.String> dbInstanceType)
        Parameters:
        dbInstanceType - Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable.
        Returns:
        builder

      • dbInstanceType

        public DbClusterArgs.Builder dbInstanceType​(java.lang.String dbInstanceType)
        Parameters:
        dbInstanceType - Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable.
        Returns:
        builder

      • dbParameterGroupIdentifier

        public DbClusterArgs.Builder dbParameterGroupIdentifier​(@Nullable
                                                        com.pulumi.core.Output<java.lang.String> dbParameterGroupIdentifier)
        Parameters:
        dbParameterGroupIdentifier - ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `dbParameterGroupIdentifier`, removing `dbParameterGroupIdentifier` will cause the cluster to be destroyed and recreated.
        Returns:
        builder

      • dbParameterGroupIdentifier

        public DbClusterArgs.Builder dbParameterGroupIdentifier​(java.lang.String dbParameterGroupIdentifier)
        Parameters:
        dbParameterGroupIdentifier - ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `dbParameterGroupIdentifier`, removing `dbParameterGroupIdentifier` will cause the cluster to be destroyed and recreated.
        Returns:
        builder

      • dbStorageType

        public DbClusterArgs.Builder dbStorageType​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> dbStorageType)
        Parameters:
        dbStorageType - 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. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use ` "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocatedStorage` is 400.
        Returns:
        builder

      • dbStorageType

        public DbClusterArgs.Builder dbStorageType​(java.lang.String dbStorageType)
        Parameters:
        dbStorageType - 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. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use ` "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocatedStorage` is 400.
        Returns:
        builder

      • deploymentType

        public DbClusterArgs.Builder deploymentType​(@Nullable
                                            com.pulumi.core.Output<java.lang.String> deploymentType)
        Parameters:
        deploymentType - Type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • deploymentType

        public DbClusterArgs.Builder deploymentType​(java.lang.String deploymentType)
        Parameters:
        deploymentType - Type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • failoverMode

        public DbClusterArgs.Builder failoverMode​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> failoverMode)
        Parameters:
        failoverMode - Behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`.
        Returns:
        builder

      • failoverMode

        public DbClusterArgs.Builder failoverMode​(java.lang.String failoverMode)
        Parameters:
        failoverMode - Behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`.
        Returns:
        builder

      • logDeliveryConfiguration

        public DbClusterArgs.Builder logDeliveryConfiguration​(@Nullable
                                                      com.pulumi.core.Output<DbClusterLogDeliveryConfigurationArgs> logDeliveryConfiguration)
        Parameters:
        logDeliveryConfiguration - Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.
        Returns:
        builder

      • logDeliveryConfiguration

        public DbClusterArgs.Builder logDeliveryConfiguration​(DbClusterLogDeliveryConfigurationArgs logDeliveryConfiguration)
        Parameters:
        logDeliveryConfiguration - Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.
        Returns:
        builder

      • maintenanceSchedule

        public DbClusterArgs.Builder maintenanceSchedule​(@Nullable
                                                 com.pulumi.core.Output<DbClusterMaintenanceScheduleArgs> maintenanceSchedule)
        Parameters:
        maintenanceSchedule - Maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. This argument is updatable. This field is only supported for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • maintenanceSchedule

        public DbClusterArgs.Builder maintenanceSchedule​(DbClusterMaintenanceScheduleArgs maintenanceSchedule)
        Parameters:
        maintenanceSchedule - Maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. This argument is updatable. This field is only supported for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • name

        public DbClusterArgs.Builder name​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - 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. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen.
        Returns:
        builder

      • name

        public DbClusterArgs.Builder name​(java.lang.String name)
        Parameters:
        name - 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. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen.
        Returns:
        builder

      • networkType

        public DbClusterArgs.Builder networkType​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> networkType)
        Parameters:
        networkType - Network type of the Timestream for InfluxDB cluster. `IPV4` can communicate over IPv4 protocol only, and `DUAL` can communicate over both IPv4 and IPv6 protocols.
        Returns:
        builder

      • networkType

        public DbClusterArgs.Builder networkType​(java.lang.String networkType)
        Parameters:
        networkType - Network type of the Timestream for InfluxDB cluster. `IPV4` can communicate over IPv4 protocol only, and `DUAL` can communicate over both IPv4 and IPv6 protocols.
        Returns:
        builder

      • organization

        public DbClusterArgs.Builder organization​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> organization)
        Parameters:
        organization - Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • organization

        public DbClusterArgs.Builder organization​(java.lang.String organization)
        Parameters:
        organization - Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • password

        public DbClusterArgs.Builder password​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> password)
        Parameters:
        password - 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. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group) as the AWS API rejects it.
        Returns:
        builder

      • password

        public DbClusterArgs.Builder password​(java.lang.String password)
        Parameters:
        password - 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. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group) as the AWS API rejects it.
        Returns:
        builder

      • port

        public DbClusterArgs.Builder port​(@Nullable
                                  com.pulumi.core.Output<java.lang.Integer> port)
        Parameters:
        port - Port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable.
        Returns:
        builder

      • port

        public DbClusterArgs.Builder port​(java.lang.Integer port)
        Parameters:
        port - Port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable.
        Returns:
        builder

      • publiclyAccessible

        public DbClusterArgs.Builder publiclyAccessible​(@Nullable
                                                com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible)
        Parameters:
        publiclyAccessible - Whether to configure the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enable public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access.
        Returns:
        builder

      • publiclyAccessible

        public DbClusterArgs.Builder publiclyAccessible​(java.lang.Boolean publiclyAccessible)
        Parameters:
        publiclyAccessible - Whether to configure the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enable public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access.
        Returns:
        builder

      • region

        public DbClusterArgs.Builder region​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public DbClusterArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • tags

        public DbClusterArgs.Builder tags​(@Nullable
                                  com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public DbClusterArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • username

        public DbClusterArgs.Builder username​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> username)
        Parameters:
        username - 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. 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. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • username

        public DbClusterArgs.Builder username​(java.lang.String username)
        Parameters:
        username - 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. 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. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).
        Returns:
        builder

      • vpcSecurityGroupIds

        public DbClusterArgs.Builder vpcSecurityGroupIds​(com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security group IDs to associate with the cluster.
        Returns:
        builder

      • vpcSecurityGroupIds

        public DbClusterArgs.Builder vpcSecurityGroupIds​(java.util.List<java.lang.String> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security group IDs to associate with the cluster.
        Returns:
        builder

      • vpcSecurityGroupIds

        public DbClusterArgs.Builder vpcSecurityGroupIds​(java.lang.String... vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security group IDs to associate with the cluster.
        Returns:
        builder

      • vpcSubnetIds

        public DbClusterArgs.Builder vpcSubnetIds​(com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSubnetIds)
        Parameters:
        vpcSubnetIds - List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. The following arguments are optional:
        Returns:
        builder

      • vpcSubnetIds

        public DbClusterArgs.Builder vpcSubnetIds​(java.util.List<java.lang.String> vpcSubnetIds)
        Parameters:
        vpcSubnetIds - List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. The following arguments are optional:
        Returns:
        builder

      • vpcSubnetIds

        public DbClusterArgs.Builder vpcSubnetIds​(java.lang.String... vpcSubnetIds)
        Parameters:
        vpcSubnetIds - List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. The following arguments are optional:
        Returns:
        builder