@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDbInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDbInstanceRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDbInstanceRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateDbInstanceRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateDbInstanceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
|
String |
getBucket()
The name of the initial InfluxDB bucket.
|
String |
getDbInstanceType()
The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
String |
getDbParameterGroupIdentifier()
The id of the DB parameter group to assign to your DB instance.
|
String |
getDbStorageType()
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
|
String |
getDeploymentType()
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high
availability.
|
LogDeliveryConfiguration |
getLogDeliveryConfiguration()
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
|
String |
getName()
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API
and CLI commands.
|
String |
getOrganization()
The name of the initial organization for the initial admin user in InfluxDB.
|
String |
getPassword()
The password of the initial admin user created in InfluxDB.
|
Boolean |
getPubliclyAccessible()
Configures the DB instance with a public IP to facilitate access.
|
Map<String,String> |
getTags()
A list of key-value pairs to associate with the DB instance.
|
String |
getUsername()
The username of the initial admin user created in InfluxDB.
|
List<String> |
getVpcSecurityGroupIds()
A list of VPC security group IDs to associate with the DB instance.
|
List<String> |
getVpcSubnetIds()
A list of VPC subnet IDs to associate with the DB instance.
|
int |
hashCode() |
Boolean |
isPubliclyAccessible()
Configures the DB instance with a public IP to facilitate access.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
|
void |
setBucket(String bucket)
The name of the initial InfluxDB bucket.
|
void |
setDbInstanceType(String dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
void |
setDbParameterGroupIdentifier(String dbParameterGroupIdentifier)
The id of the DB parameter group to assign to your DB instance.
|
void |
setDbStorageType(String dbStorageType)
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
|
void |
setDeploymentType(String deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high
availability.
|
void |
setLogDeliveryConfiguration(LogDeliveryConfiguration logDeliveryConfiguration)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
|
void |
setName(String name)
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API
and CLI commands.
|
void |
setOrganization(String organization)
The name of the initial organization for the initial admin user in InfluxDB.
|
void |
setPassword(String password)
The password of the initial admin user created in InfluxDB.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Configures the DB instance with a public IP to facilitate access.
|
void |
setTags(Map<String,String> tags)
A list of key-value pairs to associate with the DB instance.
|
void |
setUsername(String username)
The username of the initial admin user created in InfluxDB.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
|
void |
setVpcSubnetIds(Collection<String> vpcSubnetIds)
A list of VPC subnet IDs to associate with the DB instance.
|
String |
toString()
Returns a string representation of this object.
|
CreateDbInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
|
CreateDbInstanceRequest |
withBucket(String bucket)
The name of the initial InfluxDB bucket.
|
CreateDbInstanceRequest |
withDbInstanceType(DbInstanceType dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
CreateDbInstanceRequest |
withDbInstanceType(String dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
CreateDbInstanceRequest |
withDbParameterGroupIdentifier(String dbParameterGroupIdentifier)
The id of the DB parameter group to assign to your DB instance.
|
CreateDbInstanceRequest |
withDbStorageType(DbStorageType dbStorageType)
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
|
CreateDbInstanceRequest |
withDbStorageType(String dbStorageType)
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
|
CreateDbInstanceRequest |
withDeploymentType(DeploymentType deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high
availability.
|
CreateDbInstanceRequest |
withDeploymentType(String deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high
availability.
|
CreateDbInstanceRequest |
withLogDeliveryConfiguration(LogDeliveryConfiguration logDeliveryConfiguration)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
|
CreateDbInstanceRequest |
withName(String name)
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API
and CLI commands.
|
CreateDbInstanceRequest |
withOrganization(String organization)
The name of the initial organization for the initial admin user in InfluxDB.
|
CreateDbInstanceRequest |
withPassword(String password)
The password of the initial admin user created in InfluxDB.
|
CreateDbInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Configures the DB instance with a public IP to facilitate access.
|
CreateDbInstanceRequest |
withTags(Map<String,String> tags)
A list of key-value pairs to associate with the DB instance.
|
CreateDbInstanceRequest |
withUsername(String username)
The username of the initial admin user created in InfluxDB.
|
CreateDbInstanceRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
|
CreateDbInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
|
CreateDbInstanceRequest |
withVpcSubnetIds(Collection<String> vpcSubnetIds)
A list of VPC subnet IDs to associate with the DB instance.
|
CreateDbInstanceRequest |
withVpcSubnetIds(String... vpcSubnetIds)
A list of VPC subnet IDs to associate with the DB instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setName(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.
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.public String getName()
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.
public CreateDbInstanceRequest withName(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.
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.public void setUsername(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.
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.public String getUsername()
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.
public CreateDbInstanceRequest withUsername(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.
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.public void setPassword(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.
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.public String getPassword()
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.
public CreateDbInstanceRequest withPassword(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.
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.public void setOrganization(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.
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.public String getOrganization()
The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
public CreateDbInstanceRequest withOrganization(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.
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.public void setBucket(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.
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.public String getBucket()
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.
public CreateDbInstanceRequest withBucket(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.
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.public void setDbInstanceType(String dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
dbInstanceType
- The Timestream for InfluxDB DB instance type to run InfluxDB on.DbInstanceType
public String getDbInstanceType()
The Timestream for InfluxDB DB instance type to run InfluxDB on.
DbInstanceType
public CreateDbInstanceRequest withDbInstanceType(String dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
dbInstanceType
- The Timestream for InfluxDB DB instance type to run InfluxDB on.DbInstanceType
public CreateDbInstanceRequest withDbInstanceType(DbInstanceType dbInstanceType)
The Timestream for InfluxDB DB instance type to run InfluxDB on.
dbInstanceType
- The Timestream for InfluxDB DB instance type to run InfluxDB on.DbInstanceType
public List<String> getVpcSubnetIds()
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.
public void setVpcSubnetIds(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.
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.public CreateDbInstanceRequest withVpcSubnetIds(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.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSubnetIds(java.util.Collection)
or withVpcSubnetIds(java.util.Collection)
if you want to
override the existing values.
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.public CreateDbInstanceRequest withVpcSubnetIds(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.
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.public List<String> getVpcSecurityGroupIds()
A list of VPC security group IDs to associate with the DB instance.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
vpcSecurityGroupIds
- A list of VPC security group IDs to associate with the DB instance.public CreateDbInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of VPC security group IDs to associate with the DB instance.public CreateDbInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security group IDs to associate with the DB instance.
vpcSecurityGroupIds
- A list of VPC security group IDs to associate with the DB instance.public void setPubliclyAccessible(Boolean publiclyAccessible)
Configures the DB instance with a public IP to facilitate access.
publiclyAccessible
- Configures the DB instance with a public IP to facilitate access.public Boolean getPubliclyAccessible()
Configures the DB instance with a public IP to facilitate access.
public CreateDbInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
Configures the DB instance with a public IP to facilitate access.
publiclyAccessible
- Configures the DB instance with a public IP to facilitate access.public Boolean isPubliclyAccessible()
Configures the DB instance with a public IP to facilitate access.
public void setDbStorageType(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
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
DbStorageType
public String getDbStorageType()
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
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
DbStorageType
public CreateDbInstanceRequest withDbStorageType(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
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
DbStorageType
public CreateDbInstanceRequest withDbStorageType(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
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
DbStorageType
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
allocatedStorage
- The amount of storage to allocate for your DB storage type in GiB (gibibytes).public Integer getAllocatedStorage()
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
public CreateDbInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
allocatedStorage
- The amount of storage to allocate for your DB storage type in GiB (gibibytes).public void setDbParameterGroupIdentifier(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.
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.public String getDbParameterGroupIdentifier()
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.
public CreateDbInstanceRequest withDbParameterGroupIdentifier(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.
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.public void setDeploymentType(String deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
deploymentType
- Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for
high availability.DeploymentType
public String getDeploymentType()
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
DeploymentType
public CreateDbInstanceRequest withDeploymentType(String deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
deploymentType
- Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for
high availability.DeploymentType
public CreateDbInstanceRequest withDeploymentType(DeploymentType deploymentType)
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
deploymentType
- Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for
high availability.DeploymentType
public void setLogDeliveryConfiguration(LogDeliveryConfiguration logDeliveryConfiguration)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
logDeliveryConfiguration
- Configuration for sending InfluxDB engine logs to a specified S3 bucket.public LogDeliveryConfiguration getLogDeliveryConfiguration()
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
public CreateDbInstanceRequest withLogDeliveryConfiguration(LogDeliveryConfiguration logDeliveryConfiguration)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
logDeliveryConfiguration
- Configuration for sending InfluxDB engine logs to a specified S3 bucket.public Map<String,String> getTags()
A list of key-value pairs to associate with the DB instance.
public void setTags(Map<String,String> tags)
A list of key-value pairs to associate with the DB instance.
tags
- A list of key-value pairs to associate with the DB instance.public CreateDbInstanceRequest withTags(Map<String,String> tags)
A list of key-value pairs to associate with the DB instance.
tags
- A list of key-value pairs to associate with the DB instance.public CreateDbInstanceRequest addTagsEntry(String key, String value)
public CreateDbInstanceRequest clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public CreateDbInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Privacy | Site terms | Cookie preferences | © 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.