Struct aws_sdk_docdb::types::builders::DbInstanceBuilder

#[non_exhaustive]
pub struct DbInstanceBuilder { /* private fields */ }

A builder for DbInstance.

Implementations

impl DbInstanceBuilder

pub fn db_instance_identifier(self, input: impl Into<String>) -> Self

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

pub fn set_db_instance_identifier(self, input: Option<String>) -> Self

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

pub fn get_db_instance_identifier(&self) -> &Option<String>

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

pub fn db_instance_class(self, input: impl Into<String>) -> Self

Contains the name of the compute and memory capacity class of the instance.

pub fn set_db_instance_class(self, input: Option<String>) -> Self

Contains the name of the compute and memory capacity class of the instance.

pub fn get_db_instance_class(&self) -> &Option<String>

Contains the name of the compute and memory capacity class of the instance.

pub fn engine(self, input: impl Into<String>) -> Self

Provides the name of the database engine to be used for this instance.

pub fn set_engine(self, input: Option<String>) -> Self

Provides the name of the database engine to be used for this instance.

pub fn get_engine(&self) -> &Option<String>

Provides the name of the database engine to be used for this instance.

pub fn db_instance_status(self, input: impl Into<String>) -> Self

Specifies the current state of this database.

pub fn set_db_instance_status(self, input: Option<String>) -> Self

Specifies the current state of this database.

pub fn get_db_instance_status(&self) -> &Option<String>

Specifies the current state of this database.

pub fn endpoint(self, input: Endpoint) -> Self

Specifies the connection endpoint.

pub fn set_endpoint(self, input: Option<Endpoint>) -> Self

Specifies the connection endpoint.

pub fn get_endpoint(&self) -> &Option<Endpoint>

Specifies the connection endpoint.

pub fn instance_create_time(self, input: DateTime) -> Self

Provides the date and time that the instance was created.

pub fn set_instance_create_time(self, input: Option<DateTime>) -> Self

Provides the date and time that the instance was created.

pub fn get_instance_create_time(&self) -> &Option<DateTime>

Provides the date and time that the instance was created.

pub fn preferred_backup_window(self, input: impl Into<String>) -> Self

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

pub fn set_preferred_backup_window(self, input: Option<String>) -> Self

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

pub fn get_preferred_backup_window(&self) -> &Option<String>

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

pub fn backup_retention_period(self, input: i32) -> Self

Specifies the number of days for which automatic snapshots are retained.

pub fn set_backup_retention_period(self, input: Option<i32>) -> Self

Specifies the number of days for which automatic snapshots are retained.

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

Specifies the number of days for which automatic snapshots are retained.

pub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self

Appends an item to vpc_security_groups.

To override the contents of this collection use set_vpc_security_groups.

Provides a list of VPC security group elements that the instance belongs to.

pub fn set_vpc_security_groups( self, input: Option<Vec<VpcSecurityGroupMembership>> ) -> Self

Provides a list of VPC security group elements that the instance belongs to.

pub fn get_vpc_security_groups( &self ) -> &Option<Vec<VpcSecurityGroupMembership>>

Provides a list of VPC security group elements that the instance belongs to.

pub fn availability_zone(self, input: impl Into<String>) -> Self

Specifies the name of the Availability Zone that the instance is located in.

pub fn set_availability_zone(self, input: Option<String>) -> Self

Specifies the name of the Availability Zone that the instance is located in.

pub fn get_availability_zone(&self) -> &Option<String>

Specifies the name of the Availability Zone that the instance is located in.

pub fn db_subnet_group(self, input: DbSubnetGroup) -> Self

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

pub fn set_db_subnet_group(self, input: Option<DbSubnetGroup>) -> Self

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

pub fn get_db_subnet_group(&self) -> &Option<DbSubnetGroup>

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

pub fn get_preferred_maintenance_window(&self) -> &Option<String>

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

pub fn pending_modified_values(self, input: PendingModifiedValues) -> Self

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

pub fn set_pending_modified_values( self, input: Option<PendingModifiedValues> ) -> Self

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

pub fn get_pending_modified_values(&self) -> &Option<PendingModifiedValues>

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

pub fn latest_restorable_time(self, input: DateTime) -> Self

Specifies the latest time to which a database can be restored with point-in-time restore.

pub fn set_latest_restorable_time(self, input: Option<DateTime>) -> Self

Specifies the latest time to which a database can be restored with point-in-time restore.

pub fn get_latest_restorable_time(&self) -> &Option<DateTime>

Specifies the latest time to which a database can be restored with point-in-time restore.

pub fn engine_version(self, input: impl Into<String>) -> Self

Indicates the database engine version.

pub fn set_engine_version(self, input: Option<String>) -> Self

Indicates the database engine version.

pub fn get_engine_version(&self) -> &Option<String>

Indicates the database engine version.

pub fn auto_minor_version_upgrade(self, input: bool) -> Self

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

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

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

pub fn publicly_accessible(self, input: bool) -> Self

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

pub fn set_publicly_accessible(self, input: Option<bool>) -> Self

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

pub fn status_infos(self, input: DbInstanceStatusInfo) -> Self

Appends an item to status_infos.

To override the contents of this collection use set_status_infos.

The status of a read replica. If the instance is not a read replica, this is blank.

pub fn set_status_infos(self, input: Option<Vec<DbInstanceStatusInfo>>) -> Self

The status of a read replica. If the instance is not a read replica, this is blank.

pub fn get_status_infos(&self) -> &Option<Vec<DbInstanceStatusInfo>>

The status of a read replica. If the instance is not a read replica, this is blank.

pub fn db_cluster_identifier(self, input: impl Into<String>) -> Self

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

pub fn set_db_cluster_identifier(self, input: Option<String>) -> Self

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

pub fn get_db_cluster_identifier(&self) -> &Option<String>

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

pub fn storage_encrypted(self, input: bool) -> Self

Specifies whether or not the instance is encrypted.

pub fn set_storage_encrypted(self, input: Option<bool>) -> Self

Specifies whether or not the instance is encrypted.

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

Specifies whether or not the instance is encrypted.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

pub fn set_kms_key_id(self, input: Option<String>) -> Self

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

pub fn get_kms_key_id(&self) -> &Option<String>

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

pub fn dbi_resource_id(self, input: impl Into<String>) -> Self

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

pub fn set_dbi_resource_id(self, input: Option<String>) -> Self

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

pub fn get_dbi_resource_id(&self) -> &Option<String>

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

pub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self

The identifier of the CA certificate for this DB instance.

pub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self

The identifier of the CA certificate for this DB instance.

pub fn get_ca_certificate_identifier(&self) -> &Option<String>

The identifier of the CA certificate for this DB instance.

pub fn copy_tags_to_snapshot(self, input: bool) -> Self

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

pub fn set_copy_tags_to_snapshot(self, input: Option<bool>) -> Self

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

pub fn promotion_tier(self, input: i32) -> Self

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

pub fn set_promotion_tier(self, input: Option<i32>) -> Self

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

pub fn db_instance_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the instance.

pub fn set_db_instance_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the instance.

pub fn get_db_instance_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the instance.

pub fn enabled_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self

Appends an item to enabled_cloudwatch_logs_exports.

To override the contents of this collection use set_enabled_cloudwatch_logs_exports.

A list of log types that this instance is configured to export to CloudWatch Logs.

pub fn set_enabled_cloudwatch_logs_exports( self, input: Option<Vec<String>> ) -> Self

A list of log types that this instance is configured to export to CloudWatch Logs.

pub fn get_enabled_cloudwatch_logs_exports(&self) -> &Option<Vec<String>>

A list of log types that this instance is configured to export to CloudWatch Logs.

pub fn build(self) -> DbInstance

Consumes the builder and constructs a DbInstance.

Trait Implementations

impl Clone for DbInstanceBuilder

fn clone(&self) -> DbInstanceBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DbInstanceBuilder

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

Formats the value using the given formatter.

impl Default for DbInstanceBuilder

fn default() -> DbInstanceBuilder

Returns the “default value” for a type.

impl PartialEq for DbInstanceBuilder

fn eq(&self, other: &DbInstanceBuilder) -> 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 DbInstanceBuilder