Struct aws_sdk_docdb::model::db_instance::Builder
source · [−]#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for DbInstance
Implementations
sourceimpl Builder
impl Builder
sourcepub fn db_instance_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_db_instance_identifier(self, input: Option<String>) -> Self
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.
sourcepub fn db_instance_class(self, input: impl Into<String>) -> Self
pub fn db_instance_class(self, input: impl Into<String>) -> Self
Contains the name of the compute and memory capacity class of the instance.
sourcepub fn set_db_instance_class(self, input: Option<String>) -> Self
pub fn set_db_instance_class(self, input: Option<String>) -> Self
Contains the name of the compute and memory capacity class of the instance.
sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
Provides the name of the database engine to be used for this instance.
sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
Provides the name of the database engine to be used for this instance.
sourcepub fn db_instance_status(self, input: impl Into<String>) -> Self
pub fn db_instance_status(self, input: impl Into<String>) -> Self
Specifies the current state of this database.
sourcepub fn set_db_instance_status(self, input: Option<String>) -> Self
pub fn set_db_instance_status(self, input: Option<String>) -> Self
Specifies the current state of this database.
sourcepub fn set_endpoint(self, input: Option<Endpoint>) -> Self
pub fn set_endpoint(self, input: Option<Endpoint>) -> Self
Specifies the connection endpoint.
sourcepub fn instance_create_time(self, input: DateTime) -> Self
pub fn instance_create_time(self, input: DateTime) -> Self
Provides the date and time that the instance was created.
sourcepub fn set_instance_create_time(self, input: Option<DateTime>) -> Self
pub fn set_instance_create_time(self, input: Option<DateTime>) -> Self
Provides the date and time that the instance was created.
sourcepub fn preferred_backup_window(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_preferred_backup_window(self, input: Option<String>) -> Self
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
.
sourcepub fn backup_retention_period(self, input: i32) -> Self
pub fn backup_retention_period(self, input: i32) -> Self
Specifies the number of days for which automatic snapshots are retained.
sourcepub fn set_backup_retention_period(self, input: Option<i32>) -> Self
pub fn set_backup_retention_period(self, input: Option<i32>) -> Self
Specifies the number of days for which automatic snapshots are retained.
sourcepub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self
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.
sourcepub fn set_vpc_security_groups(
self,
input: Option<Vec<VpcSecurityGroupMembership>>
) -> Self
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.
sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
Specifies the name of the Availability Zone that the instance is located in.
sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
Specifies the name of the Availability Zone that the instance is located in.
sourcepub fn db_subnet_group(self, input: DbSubnetGroup) -> Self
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.
sourcepub fn set_db_subnet_group(self, input: Option<DbSubnetGroup>) -> Self
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.
sourcepub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
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).
sourcepub fn pending_modified_values(self, input: PendingModifiedValues) -> Self
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.
sourcepub fn set_pending_modified_values(
self,
input: Option<PendingModifiedValues>
) -> Self
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.
sourcepub fn latest_restorable_time(self, input: DateTime) -> Self
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.
sourcepub fn set_latest_restorable_time(self, input: Option<DateTime>) -> Self
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.
sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
Indicates the database engine version.
sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
Indicates the database engine version.
sourcepub fn auto_minor_version_upgrade(self, input: bool) -> Self
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.
sourcepub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
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.
sourcepub fn publicly_accessible(self, input: bool) -> Self
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
.
sourcepub fn set_publicly_accessible(self, input: Option<bool>) -> Self
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
.
sourcepub fn status_infos(self, input: DbInstanceStatusInfo) -> Self
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.
sourcepub fn set_status_infos(self, input: Option<Vec<DbInstanceStatusInfo>>) -> Self
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.
sourcepub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
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.
sourcepub fn storage_encrypted(self, input: bool) -> Self
pub fn storage_encrypted(self, input: bool) -> Self
Specifies whether or not the instance is encrypted.
sourcepub fn set_storage_encrypted(self, input: Option<bool>) -> Self
pub fn set_storage_encrypted(self, input: Option<bool>) -> Self
Specifies whether or not the instance is encrypted.
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
If StorageEncrypted
is true
, the KMS key identifier for the encrypted instance.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
If StorageEncrypted
is true
, the KMS key identifier for the encrypted instance.
sourcepub fn dbi_resource_id(self, input: impl Into<String>) -> Self
pub fn dbi_resource_id(self, input: impl Into<String>) -> Self
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
sourcepub fn set_dbi_resource_id(self, input: Option<String>) -> Self
pub fn set_dbi_resource_id(self, input: Option<String>) -> Self
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
sourcepub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self
pub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self
The identifier of the CA certificate for this DB instance.
sourcepub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self
pub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self
The identifier of the CA certificate for this DB instance.
sourcepub fn promotion_tier(self, input: i32) -> Self
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.
sourcepub fn set_promotion_tier(self, input: Option<i32>) -> Self
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.
sourcepub fn db_instance_arn(self, input: impl Into<String>) -> Self
pub fn db_instance_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the instance.
sourcepub fn set_db_instance_arn(self, input: Option<String>) -> Self
pub fn set_db_instance_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the instance.
sourcepub fn enabled_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_enabled_cloudwatch_logs_exports(
self,
input: Option<Vec<String>>
) -> Self
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.
sourcepub fn build(self) -> DbInstance
pub fn build(self) -> DbInstance
Consumes the builder and constructs a DbInstance
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more