pub struct ModifyTenantDatabaseFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ModifyTenantDatabase
.
Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
Implementations§
Source§impl ModifyTenantDatabaseFluentBuilder
impl ModifyTenantDatabaseFluentBuilder
Sourcepub fn as_input(&self) -> &ModifyTenantDatabaseInputBuilder
pub fn as_input(&self) -> &ModifyTenantDatabaseInputBuilder
Access the ModifyTenantDatabase as a reference.
Sourcepub async fn send(
self,
) -> Result<ModifyTenantDatabaseOutput, SdkError<ModifyTenantDatabaseError, HttpResponse>>
pub async fn send( self, ) -> Result<ModifyTenantDatabaseOutput, SdkError<ModifyTenantDatabaseError, 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<ModifyTenantDatabaseOutput, ModifyTenantDatabaseError, Self>
pub fn customize( self, ) -> CustomizableOperation<ModifyTenantDatabaseOutput, ModifyTenantDatabaseError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn db_instance_identifier(self, input: impl Into<String>) -> Self
pub fn db_instance_identifier(self, input: impl Into<String>) -> Self
The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB instance.
Sourcepub fn set_db_instance_identifier(self, input: Option<String>) -> Self
pub fn set_db_instance_identifier(self, input: Option<String>) -> Self
The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB instance.
Sourcepub fn get_db_instance_identifier(&self) -> &Option<String>
pub fn get_db_instance_identifier(&self) -> &Option<String>
The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB instance.
Sourcepub fn tenant_db_name(self, input: impl Into<String>) -> Self
pub fn tenant_db_name(self, input: impl Into<String>) -> Self
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing tenant database.
Sourcepub fn set_tenant_db_name(self, input: Option<String>) -> Self
pub fn set_tenant_db_name(self, input: Option<String>) -> Self
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing tenant database.
Sourcepub fn get_tenant_db_name(&self) -> &Option<String>
pub fn get_tenant_db_name(&self) -> &Option<String>
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing tenant database.
Sourcepub fn master_user_password(self, input: impl Into<String>) -> Self
pub fn master_user_password(self, input: impl Into<String>) -> Self
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
-
Can include any printable ASCII character except
/
,"
(double quote),@
,&
(ampersand), and'
(single quote).
Length constraints:
-
Must contain between 8 and 30 characters.
Sourcepub fn set_master_user_password(self, input: Option<String>) -> Self
pub fn set_master_user_password(self, input: Option<String>) -> Self
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
-
Can include any printable ASCII character except
/
,"
(double quote),@
,&
(ampersand), and'
(single quote).
Length constraints:
-
Must contain between 8 and 30 characters.
Sourcepub fn get_master_user_password(&self) -> &Option<String>
pub fn get_master_user_password(&self) -> &Option<String>
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
-
Can include any printable ASCII character except
/
,"
(double quote),@
,&
(ampersand), and'
(single quote).
Length constraints:
-
Must contain between 8 and 30 characters.
Sourcepub fn new_tenant_db_name(self, input: impl Into<String>) -> Self
pub fn new_tenant_db_name(self, input: impl Into<String>) -> Self
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
-
Can't be the string null or any other reserved word.
-
Can't be longer than 8 characters.
Sourcepub fn set_new_tenant_db_name(self, input: Option<String>) -> Self
pub fn set_new_tenant_db_name(self, input: Option<String>) -> Self
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
-
Can't be the string null or any other reserved word.
-
Can't be longer than 8 characters.
Sourcepub fn get_new_tenant_db_name(&self) -> &Option<String>
pub fn get_new_tenant_db_name(&self) -> &Option<String>
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
-
Can't be the string null or any other reserved word.
-
Can't be longer than 8 characters.
Sourcepub fn manage_master_user_password(self, input: bool) -> Self
pub fn manage_master_user_password(self, input: bool) -> Self
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword
.
If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword
. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
Sourcepub fn set_manage_master_user_password(self, input: Option<bool>) -> Self
pub fn set_manage_master_user_password(self, input: Option<bool>) -> Self
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword
.
If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword
. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
Sourcepub fn get_manage_master_user_password(&self) -> &Option<bool>
pub fn get_manage_master_user_password(&self) -> &Option<bool>
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword
.
If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword
. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
Sourcepub fn rotate_master_user_password(self, input: bool) -> Self
pub fn rotate_master_user_password(self, input: bool) -> Self
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
You must apply the change immediately when rotating the master user password.
Sourcepub fn set_rotate_master_user_password(self, input: Option<bool>) -> Self
pub fn set_rotate_master_user_password(self, input: Option<bool>) -> Self
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
You must apply the change immediately when rotating the master user password.
Sourcepub fn get_rotate_master_user_password(&self) -> &Option<bool>
pub fn get_rotate_master_user_password(&self) -> &Option<bool>
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
-
You must apply the change immediately when rotating the master user password.
Sourcepub fn master_user_secret_kms_key_id(self, input: impl Into<String>) -> Self
pub fn master_user_secret_kms_key_id(self, input: impl Into<String>) -> Self
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
-
The tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
-
You're turning on
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.If you're turning on
ManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a self-managed KMS key.
The Amazon Web Services KMS key identifier is any of the following:
-
Key ARN
-
Key ID
-
Alias ARN
-
Alias name for the KMS key
To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Sourcepub fn set_master_user_secret_kms_key_id(self, input: Option<String>) -> Self
pub fn set_master_user_secret_kms_key_id(self, input: Option<String>) -> Self
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
-
The tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
-
You're turning on
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.If you're turning on
ManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a self-managed KMS key.
The Amazon Web Services KMS key identifier is any of the following:
-
Key ARN
-
Key ID
-
Alias ARN
-
Alias name for the KMS key
To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Sourcepub fn get_master_user_secret_kms_key_id(&self) -> &Option<String>
pub fn get_master_user_secret_kms_key_id(&self) -> &Option<String>
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
-
The tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
-
You're turning on
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.If you're turning on
ManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a self-managed KMS key.
The Amazon Web Services KMS key identifier is any of the following:
-
Key ARN
-
Key ID
-
Alias ARN
-
Alias name for the KMS key
To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Trait Implementations§
Source§impl Clone for ModifyTenantDatabaseFluentBuilder
impl Clone for ModifyTenantDatabaseFluentBuilder
Source§fn clone(&self) -> ModifyTenantDatabaseFluentBuilder
fn clone(&self) -> ModifyTenantDatabaseFluentBuilder
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 ModifyTenantDatabaseFluentBuilder
impl !RefUnwindSafe for ModifyTenantDatabaseFluentBuilder
impl Send for ModifyTenantDatabaseFluentBuilder
impl Sync for ModifyTenantDatabaseFluentBuilder
impl Unpin for ModifyTenantDatabaseFluentBuilder
impl !UnwindSafe for ModifyTenantDatabaseFluentBuilder
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);