Struct aws_sdk_docdb::types::builders::DbClusterBuilder

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

A builder for DbCluster.

Implementations

impl DbClusterBuilder

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

Appends an item to availability_zones.

To override the contents of this collection use set_availability_zones.

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

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

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

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

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

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 db_cluster_identifier(self, input: impl Into<String>) -> Self

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

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

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

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

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

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

Specifies the name of the cluster parameter group for the cluster.

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

Specifies the name of the cluster parameter group for the cluster.

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

Specifies the name of the cluster parameter group for the cluster.

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

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

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

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

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

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

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

Specifies the current state of this cluster.

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

Specifies the current state of this cluster.

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

Specifies the current state of this cluster.

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

Specifies the progress of the operation as a percentage.

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

Specifies the progress of the operation as a percentage.

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

Specifies the progress of the operation as a percentage.

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

The earliest time to which a database can be restored with point-in-time restore.

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

The earliest time to which a database can be restored with point-in-time restore.

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

The earliest time to which a database can be restored with point-in-time restore.

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

Specifies the connection endpoint for the primary instance of the cluster.

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

Specifies the connection endpoint for the primary instance of the cluster.

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

Specifies the connection endpoint for the primary instance of the cluster.

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

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

Specifies whether the cluster has instances in multiple Availability Zones.

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

Specifies whether the cluster has instances in multiple Availability Zones.

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

Specifies whether the cluster has instances in multiple Availability Zones.

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

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

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

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

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

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

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 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 port(self, input: i32) -> Self

Specifies the port that the database engine is listening on.

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

Specifies the port that the database engine is listening on.

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

Specifies the port that the database engine is listening on.

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

Contains the master user name for the cluster.

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

Contains the master user name for the cluster.

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

Contains the master user name for the cluster.

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 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 replication_source_identifier(self, input: impl Into<String>) -> Self

Contains the identifier of the source cluster if this cluster is a secondary cluster.

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

Contains the identifier of the source cluster if this cluster is a secondary cluster.

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

Contains the identifier of the source cluster if this cluster is a secondary cluster.

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

Appends an item to read_replica_identifiers.

To override the contents of this collection use set_read_replica_identifiers.

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

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

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

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

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

pub fn db_cluster_members(self, input: DbClusterMember) -> Self

Appends an item to db_cluster_members.

To override the contents of this collection use set_db_cluster_members.

Provides the list of instances that make up the cluster.

pub fn set_db_cluster_members(self, input: Option<Vec<DbClusterMember>>) -> Self

Provides the list of instances that make up the cluster.

pub fn get_db_cluster_members(&self) -> &Option<Vec<DbClusterMember>>

Provides the list of instances that make up the cluster.

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 virtual private cloud (VPC) security groups that the cluster belongs to.

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

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

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

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

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

Specifies whether the cluster is encrypted.

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

Specifies whether the cluster is encrypted.

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

Specifies whether the cluster is encrypted.

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

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

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

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

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

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

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

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

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

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

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

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

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

The Amazon Resource Name (ARN) for the cluster.

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

The Amazon Resource Name (ARN) for the cluster.

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

The Amazon Resource Name (ARN) for the cluster.

pub fn associated_roles(self, input: DbClusterRole) -> Self

Appends an item to associated_roles.

To override the contents of this collection use set_associated_roles.

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

pub fn set_associated_roles(self, input: Option<Vec<DbClusterRole>>) -> Self

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

pub fn get_associated_roles(&self) -> &Option<Vec<DbClusterRole>>

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

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

Identifies the clone group to which the DB cluster is associated.

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

Identifies the clone group to which the DB cluster is associated.

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

Identifies the clone group to which the DB cluster is associated.

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

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 cluster is configured to export to Amazon CloudWatch Logs.

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

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

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

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

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

pub fn build(self) -> DbCluster

Consumes the builder and constructs a DbCluster.

Trait Implementations

impl Clone for DbClusterBuilder

fn clone(&self) -> DbClusterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DbClusterBuilder

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

Formats the value using the given formatter.

impl Default for DbClusterBuilder

fn default() -> DbClusterBuilder

Returns the “default value” for a type.

impl PartialEq for DbClusterBuilder

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