aws_sdk_timestreaminfluxdb/client/
delete_db_instance.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteDbInstance`](crate::operation::delete_db_instance::builders::DeleteDbInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::delete_db_instance::builders::DeleteDbInstanceFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::delete_db_instance::builders::DeleteDbInstanceFluentBuilder::set_identifier):<br>required: **true**<br><p>The id of the DB instance.</p><br>
7    /// - On success, responds with [`DeleteDbInstanceOutput`](crate::operation::delete_db_instance::DeleteDbInstanceOutput) with field(s):
8    ///   - [`id(String)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::id): <p>A service-generated unique identifier.</p>
9    ///   - [`name(String)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::name): <p>The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.</p>
10    ///   - [`arn(String)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::arn): <p>The Amazon Resource Name (ARN) of the DB instance.</p>
11    ///   - [`status(Option<Status>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::status): <p>The status of the DB instance.</p>
12    ///   - [`endpoint(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::endpoint): <p>The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.</p>
13    ///   - [`port(Option<i32>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::port): <p>The port number on which InfluxDB accepts connections.</p>
14    ///   - [`network_type(Option<NetworkType>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::network_type): <p>Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>
15    ///   - [`db_instance_type(Option<DbInstanceType>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::db_instance_type): <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
16    ///   - [`db_storage_type(Option<DbStorageType>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::db_storage_type): <p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>
17    ///   - [`allocated_storage(Option<i32>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::allocated_storage): <p>The amount of storage allocated for your DB storage type (in gibibytes).</p>
18    ///   - [`deployment_type(Option<DeploymentType>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::deployment_type): <p>Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.</p>
19    ///   - [`vpc_subnet_ids(Vec::<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::vpc_subnet_ids): <p>A list of VPC subnet IDs associated with the DB instance.</p>
20    ///   - [`publicly_accessible(Option<bool>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::publicly_accessible): <p>Indicates if the DB instance has a public IP to facilitate access.</p>
21    ///   - [`vpc_security_group_ids(Option<Vec::<String>>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::vpc_security_group_ids): <p>A list of VPC security group IDs associated with the DB instance.</p>
22    ///   - [`db_parameter_group_identifier(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::db_parameter_group_identifier): <p>The id of the DB parameter group assigned to your DB instance.</p>
23    ///   - [`availability_zone(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::availability_zone): <p>The Availability Zone in which the DB instance resides.</p>
24    ///   - [`secondary_availability_zone(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::secondary_availability_zone): <p>The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.</p>
25    ///   - [`log_delivery_configuration(Option<LogDeliveryConfiguration>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::log_delivery_configuration): <p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>
26    ///   - [`influx_auth_parameters_secret_arn(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::influx_auth_parameters_secret_arn): <p>The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>
27    ///   - [`db_cluster_id(Option<String>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::db_cluster_id): <p>Specifies the DbCluster to which this DbInstance belongs to.</p>
28    ///   - [`instance_mode(Option<InstanceMode>)`](crate::operation::delete_db_instance::DeleteDbInstanceOutput::instance_mode): <p>Specifies the DbInstance's role in the cluster.</p>
29    /// - On failure, responds with [`SdkError<DeleteDbInstanceError>`](crate::operation::delete_db_instance::DeleteDbInstanceError)
30    pub fn delete_db_instance(&self) -> crate::operation::delete_db_instance::builders::DeleteDbInstanceFluentBuilder {
31        crate::operation::delete_db_instance::builders::DeleteDbInstanceFluentBuilder::new(self.handle.clone())
32    }
33}
aws_sdk_timestreaminfluxdb/client/delete_db_instance.rs

aws_sdk_timestreaminfluxdb/client/
delete_db_instance.rs
