Struct aws_sdk_timestreaminfluxdb::operation::create_db_instance::CreateDbInstanceInput

#[non_exhaustive]
pub struct CreateDbInstanceInput {

    pub name: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub organization: Option<String>,
    pub bucket: Option<String>,
    pub db_instance_type: Option<DbInstanceType>,
    pub vpc_subnet_ids: Option<Vec<String>>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub publicly_accessible: Option<bool>,
    pub db_storage_type: Option<DbStorageType>,
    pub allocated_storage: Option<i32>,
    pub db_parameter_group_identifier: Option<String>,
    pub deployment_type: Option<DeploymentType>,
    pub log_delivery_configuration: Option<LogDeliveryConfiguration>,
    pub tags: Option<HashMap<String, String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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.

username: Option<String>

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.

password: Option<String>

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.

organization: Option<String>

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

bucket: Option<String>

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.

db_instance_type: Option<DbInstanceType>

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

vpc_subnet_ids: Option<Vec<String>>

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.

vpc_security_group_ids: Option<Vec<String>>

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

publicly_accessible: Option<bool>

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

db_storage_type: Option<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

allocated_storage: Option<i32>

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

db_parameter_group_identifier: Option<String>

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.

deployment_type: Option<DeploymentType>

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

log_delivery_configuration: Option<LogDeliveryConfiguration>

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

tags: Option<HashMap<String, String>>

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

Implementations

impl CreateDbInstanceInput

pub fn name(&self) -> Option<&str>

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.

pub fn username(&self) -> Option<&str>

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.

pub fn password(&self) -> Option<&str>

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.

pub fn organization(&self) -> Option<&str>

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

pub fn bucket(&self) -> Option<&str>

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.

pub fn db_instance_type(&self) -> Option<&DbInstanceType>

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

pub fn vpc_subnet_ids(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_subnet_ids.is_none().

pub fn vpc_security_group_ids(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_group_ids.is_none().

pub fn publicly_accessible(&self) -> Option<bool>

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

pub fn db_storage_type(&self) -> Option<&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

pub fn allocated_storage(&self) -> Option<i32>

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

pub fn db_parameter_group_identifier(&self) -> Option<&str>

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.

pub fn deployment_type(&self) -> Option<&DeploymentType>

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

pub fn log_delivery_configuration(&self) -> Option<&LogDeliveryConfiguration>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl CreateDbInstanceInput

pub fn builder() -> CreateDbInstanceInputBuilder

Creates a new builder-style object to manufacture CreateDbInstanceInput.

Trait Implementations

impl Clone for CreateDbInstanceInput

fn clone(&self) -> CreateDbInstanceInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDbInstanceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateDbInstanceInput

fn eq(&self, other: &CreateDbInstanceInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDbInstanceInput