Class CfnInfluxDBInstanceMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.timestream.CfnInfluxDBInstanceMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnInfluxDBInstanceMixinProps>
- Enclosing interface:
CfnInfluxDBInstanceMixinProps
@Stability(Stable)
public static final class CfnInfluxDBInstanceMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInfluxDBInstanceMixinProps>
A builder for
CfnInfluxDBInstanceMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallocatedStorage(Number allocatedStorage) Sets the value ofCfnInfluxDBInstanceMixinProps.getAllocatedStorage()Sets the value ofCfnInfluxDBInstanceMixinProps.getBucket()build()Builds the configured instance.dbInstanceType(String dbInstanceType) Sets the value ofCfnInfluxDBInstanceMixinProps.getDbInstanceType()dbParameterGroupIdentifier(String dbParameterGroupIdentifier) Sets the value ofCfnInfluxDBInstanceMixinProps.getDbParameterGroupIdentifier()dbStorageType(String dbStorageType) Sets the value ofCfnInfluxDBInstanceMixinProps.getDbStorageType()deploymentType(String deploymentType) Sets the value ofCfnInfluxDBInstanceMixinProps.getDeploymentType()logDeliveryConfiguration(CfnInfluxDBInstancePropsMixin.LogDeliveryConfigurationProperty logDeliveryConfiguration) Sets the value ofCfnInfluxDBInstanceMixinProps.getLogDeliveryConfiguration()logDeliveryConfiguration(IResolvable logDeliveryConfiguration) Sets the value ofCfnInfluxDBInstanceMixinProps.getLogDeliveryConfiguration()Sets the value ofCfnInfluxDBInstanceMixinProps.getName()networkType(String networkType) Sets the value ofCfnInfluxDBInstanceMixinProps.getNetworkType()organization(String organization) Sets the value ofCfnInfluxDBInstanceMixinProps.getOrganization()Sets the value ofCfnInfluxDBInstanceMixinProps.getPassword()Sets the value ofCfnInfluxDBInstanceMixinProps.getPort()publiclyAccessible(Boolean publiclyAccessible) Sets the value ofCfnInfluxDBInstanceMixinProps.getPubliclyAccessible()publiclyAccessible(IResolvable publiclyAccessible) Sets the value ofCfnInfluxDBInstanceMixinProps.getPubliclyAccessible()Sets the value ofCfnInfluxDBInstanceMixinProps.getTags()Sets the value ofCfnInfluxDBInstanceMixinProps.getUsername()vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Sets the value ofCfnInfluxDBInstanceMixinProps.getVpcSecurityGroupIds()vpcSubnetIds(List<String> vpcSubnetIds) Sets the value ofCfnInfluxDBInstanceMixinProps.getVpcSubnetIds()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allocatedStorage
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder allocatedStorage(Number allocatedStorage) Sets the value ofCfnInfluxDBInstanceMixinProps.getAllocatedStorage()- Parameters:
allocatedStorage- The amount of storage to allocate for your DB storage type in GiB (gibibytes).- Returns:
this
-
bucket
Sets the value ofCfnInfluxDBInstanceMixinProps.getBucket()- 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:
this
-
dbInstanceType
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder dbInstanceType(String dbInstanceType) Sets the value ofCfnInfluxDBInstanceMixinProps.getDbInstanceType()- Parameters:
dbInstanceType- The Timestream for InfluxDB DB instance type to run on.- Returns:
this
-
dbParameterGroupIdentifier
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder dbParameterGroupIdentifier(String dbParameterGroupIdentifier) Sets the value ofCfnInfluxDBInstanceMixinProps.getDbParameterGroupIdentifier()- Parameters:
dbParameterGroupIdentifier- The name or 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:
this
-
dbStorageType
Sets the value ofCfnInfluxDBInstanceMixinProps.getDbStorageType()- 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:
this
-
deploymentType
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder deploymentType(String deploymentType) Sets the value ofCfnInfluxDBInstanceMixinProps.getDeploymentType()- Parameters:
deploymentType- Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.- Returns:
this
-
logDeliveryConfiguration
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder logDeliveryConfiguration(IResolvable logDeliveryConfiguration) Sets the value ofCfnInfluxDBInstanceMixinProps.getLogDeliveryConfiguration()- Parameters:
logDeliveryConfiguration- Configuration for sending InfluxDB engine logs to a specified S3 bucket.- Returns:
this
-
logDeliveryConfiguration
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder logDeliveryConfiguration(CfnInfluxDBInstancePropsMixin.LogDeliveryConfigurationProperty logDeliveryConfiguration) Sets the value ofCfnInfluxDBInstanceMixinProps.getLogDeliveryConfiguration()- Parameters:
logDeliveryConfiguration- Configuration for sending InfluxDB engine logs to a specified S3 bucket.- Returns:
this
-
name
Sets the value ofCfnInfluxDBInstanceMixinProps.getName()- 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:
this
-
networkType
Sets the value ofCfnInfluxDBInstanceMixinProps.getNetworkType()- Parameters:
networkType- Network type of the InfluxDB Instance.- Returns:
this
-
organization
Sets the value ofCfnInfluxDBInstanceMixinProps.getOrganization()- 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:
this
-
password
Sets the value ofCfnInfluxDBInstanceMixinProps.getPassword()- 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 Amazon SecretManager in your account.- Returns:
this
-
port
Sets the value ofCfnInfluxDBInstanceMixinProps.getPort()- Parameters:
port- The port number on which InfluxDB accepts connections.- Returns:
this
-
publiclyAccessible
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder publiclyAccessible(Boolean publiclyAccessible) Sets the value ofCfnInfluxDBInstanceMixinProps.getPubliclyAccessible()- Parameters:
publiclyAccessible- Configures the DB instance with a public IP to facilitate access.- Returns:
this
-
publiclyAccessible
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder publiclyAccessible(IResolvable publiclyAccessible) Sets the value ofCfnInfluxDBInstanceMixinProps.getPubliclyAccessible()- Parameters:
publiclyAccessible- Configures the DB instance with a public IP to facilitate access.- Returns:
this
-
tags
Sets the value ofCfnInfluxDBInstanceMixinProps.getTags()- Parameters:
tags- A list of key-value pairs to associate with the DB instance.- Returns:
this
-
username
Sets the value ofCfnInfluxDBInstanceMixinProps.getUsername()- 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:
this
-
vpcSecurityGroupIds
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Sets the value ofCfnInfluxDBInstanceMixinProps.getVpcSecurityGroupIds()- Parameters:
vpcSecurityGroupIds- A list of VPC security group IDs to associate with the DB instance.- Returns:
this
-
vpcSubnetIds
@Stability(Stable) public CfnInfluxDBInstanceMixinProps.Builder vpcSubnetIds(List<String> vpcSubnetIds) Sets the value ofCfnInfluxDBInstanceMixinProps.getVpcSubnetIds()- 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:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnInfluxDBInstanceMixinProps>- Returns:
- a new instance of
CfnInfluxDBInstanceMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-