pub struct CreateClusterFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateCluster.
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
Implementations§
Source§impl CreateClusterFluentBuilder
impl CreateClusterFluentBuilder
Sourcepub fn as_input(&self) -> &CreateClusterInputBuilder
pub fn as_input(&self) -> &CreateClusterInputBuilder
Access the CreateCluster as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateClusterOutput, CreateClusterError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateClusterOutput, CreateClusterError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn cluster_name(self, input: impl Into<String>) -> Self
pub fn cluster_name(self, input: impl Into<String>) -> Self
The name of the new elastic cluster. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
Sourcepub fn set_cluster_name(self, input: Option<String>) -> Self
pub fn set_cluster_name(self, input: Option<String>) -> Self
The name of the new elastic cluster. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
Sourcepub fn get_cluster_name(&self) -> &Option<String>
pub fn get_cluster_name(&self) -> &Option<String>
The name of the new elastic cluster. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
Sourcepub fn auth_type(self, input: Auth) -> Self
pub fn auth_type(self, input: Auth) -> Self
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
Sourcepub fn set_auth_type(self, input: Option<Auth>) -> Self
pub fn set_auth_type(self, input: Option<Auth>) -> Self
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
Sourcepub fn get_auth_type(&self) -> &Option<Auth>
pub fn get_auth_type(&self) -> &Option<Auth>
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
Sourcepub fn admin_user_name(self, input: impl Into<String>) -> Self
pub fn admin_user_name(self, input: impl Into<String>) -> Self
The name of the Amazon DocumentDB elastic clusters administrator.
Constraints:
-
Must be from 1 to 63 letters or numbers.
-
The first character must be a letter.
-
Cannot be a reserved word.
Sourcepub fn set_admin_user_name(self, input: Option<String>) -> Self
pub fn set_admin_user_name(self, input: Option<String>) -> Self
The name of the Amazon DocumentDB elastic clusters administrator.
Constraints:
-
Must be from 1 to 63 letters or numbers.
-
The first character must be a letter.
-
Cannot be a reserved word.
Sourcepub fn get_admin_user_name(&self) -> &Option<String>
pub fn get_admin_user_name(&self) -> &Option<String>
The name of the Amazon DocumentDB elastic clusters administrator.
Constraints:
-
Must be from 1 to 63 letters or numbers.
-
The first character must be a letter.
-
Cannot be a reserved word.
Sourcepub fn admin_user_password(self, input: impl Into<String>) -> Self
pub fn admin_user_password(self, input: impl Into<String>) -> Self
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
Constraints:
-
Must contain from 8 to 100 characters.
-
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
Sourcepub fn set_admin_user_password(self, input: Option<String>) -> Self
pub fn set_admin_user_password(self, input: Option<String>) -> Self
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
Constraints:
-
Must contain from 8 to 100 characters.
-
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
Sourcepub fn get_admin_user_password(&self) -> &Option<String>
pub fn get_admin_user_password(&self) -> &Option<String>
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
Constraints:
-
Must contain from 8 to 100 characters.
-
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
Sourcepub fn shard_capacity(self, input: i32) -> Self
pub fn shard_capacity(self, input: i32) -> Self
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Sourcepub fn set_shard_capacity(self, input: Option<i32>) -> Self
pub fn set_shard_capacity(self, input: Option<i32>) -> Self
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Sourcepub fn get_shard_capacity(&self) -> &Option<i32>
pub fn get_shard_capacity(&self) -> &Option<i32>
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Sourcepub fn shard_count(self, input: i32) -> Self
pub fn shard_count(self, input: i32) -> Self
The number of shards assigned to the elastic cluster. Maximum is 32.
Sourcepub fn set_shard_count(self, input: Option<i32>) -> Self
pub fn set_shard_count(self, input: Option<i32>) -> Self
The number of shards assigned to the elastic cluster. Maximum is 32.
Sourcepub fn get_shard_count(&self) -> &Option<i32>
pub fn get_shard_count(&self) -> &Option<i32>
The number of shards assigned to the elastic cluster. Maximum is 32.
Sourcepub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self
pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to vpcSecurityGroupIds.
To override the contents of this collection use set_vpc_security_group_ids.
A list of EC2 VPC security groups to associate with the new elastic cluster.
Sourcepub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self
A list of EC2 VPC security groups to associate with the new elastic cluster.
Sourcepub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>
pub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>
A list of EC2 VPC security groups to associate with the new elastic cluster.
Sourcepub fn subnet_ids(self, input: impl Into<String>) -> Self
pub fn subnet_ids(self, input: impl Into<String>) -> Self
Appends an item to subnetIds.
To override the contents of this collection use set_subnet_ids.
The Amazon EC2 subnet IDs for the new elastic cluster.
Sourcepub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
The Amazon EC2 subnet IDs for the new elastic cluster.
Sourcepub fn get_subnet_ids(&self) -> &Option<Vec<String>>
pub fn get_subnet_ids(&self) -> &Option<Vec<String>>
The Amazon EC2 subnet IDs for the new elastic cluster.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The KMS key identifier to use to encrypt the new elastic cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The KMS key identifier to use to encrypt the new elastic cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The KMS key identifier to use to encrypt the new elastic cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The client token for the elastic cluster.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The client token for the elastic cluster.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
The client token for the elastic cluster.
Sourcepub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Sourcepub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Sourcepub fn get_preferred_maintenance_window(&self) -> &Option<String>
pub fn get_preferred_maintenance_window(&self) -> &Option<String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
The tags to be assigned to the new elastic cluster.
The tags to be assigned to the new elastic cluster.
The tags to be assigned to the new elastic cluster.
Sourcepub fn backup_retention_period(self, input: i32) -> Self
pub fn backup_retention_period(self, input: i32) -> Self
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
The number of days for which automatic snapshots are retained.
Sourcepub fn get_backup_retention_period(&self) -> &Option<i32>
pub fn get_backup_retention_period(&self) -> &Option<i32>
The number of days for which automatic snapshots are retained.
Sourcepub fn preferred_backup_window(self, input: impl Into<String>) -> Self
pub fn preferred_backup_window(self, input: impl Into<String>) -> Self
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
The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
Sourcepub fn get_preferred_backup_window(&self) -> &Option<String>
pub fn get_preferred_backup_window(&self) -> &Option<String>
The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
Sourcepub fn shard_instance_count(self, input: i32) -> Self
pub fn shard_instance_count(self, input: i32) -> Self
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Sourcepub fn set_shard_instance_count(self, input: Option<i32>) -> Self
pub fn set_shard_instance_count(self, input: Option<i32>) -> Self
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Sourcepub fn get_shard_instance_count(&self) -> &Option<i32>
pub fn get_shard_instance_count(&self) -> &Option<i32>
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Trait Implementations§
Source§impl Clone for CreateClusterFluentBuilder
impl Clone for CreateClusterFluentBuilder
Source§fn clone(&self) -> CreateClusterFluentBuilder
fn clone(&self) -> CreateClusterFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateClusterFluentBuilder
impl !RefUnwindSafe for CreateClusterFluentBuilder
impl Send for CreateClusterFluentBuilder
impl Sync for CreateClusterFluentBuilder
impl Unpin for CreateClusterFluentBuilder
impl !UnwindSafe for CreateClusterFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);