pub struct GetClusterCredentialsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetClusterCredentials
.
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM:
if AutoCreate
is False
or IAMA:
if AutoCreate
is True
. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include the redshift:CreateClusterUser
permission.
If the DbName
parameter is specified, the IAM policy must allow access to the resource dbname
for the specified database name.
Implementations§
Source§impl GetClusterCredentialsFluentBuilder
impl GetClusterCredentialsFluentBuilder
Sourcepub fn as_input(&self) -> &GetClusterCredentialsInputBuilder
pub fn as_input(&self) -> &GetClusterCredentialsInputBuilder
Access the GetClusterCredentials as a reference.
Sourcepub async fn send(
self,
) -> Result<GetClusterCredentialsOutput, SdkError<GetClusterCredentialsError, HttpResponse>>
pub async fn send( self, ) -> Result<GetClusterCredentialsOutput, SdkError<GetClusterCredentialsError, 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<GetClusterCredentialsOutput, GetClusterCredentialsError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetClusterCredentialsOutput, GetClusterCredentialsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn db_user(self, input: impl Into<String>) -> Self
pub fn db_user(self, input: impl Into<String>) -> Self
The name of a database user. If a user name matching DbUser
exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser
doesn't exist in the database and Autocreate
is True
, a new user is created using the value for DbUser
with PUBLIC permissions. If a database user matching the value for DbUser
doesn't exist and Autocreate
is False
, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn set_db_user(self, input: Option<String>) -> Self
pub fn set_db_user(self, input: Option<String>) -> Self
The name of a database user. If a user name matching DbUser
exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser
doesn't exist in the database and Autocreate
is True
, a new user is created using the value for DbUser
with PUBLIC permissions. If a database user matching the value for DbUser
doesn't exist and Autocreate
is False
, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn get_db_user(&self) -> &Option<String>
pub fn get_db_user(&self) -> &Option<String>
The name of a database user. If a user name matching DbUser
exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser
doesn't exist in the database and Autocreate
is True
, a new user is created using the value for DbUser
with PUBLIC permissions. If a database user matching the value for DbUser
doesn't exist and Autocreate
is False
, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn db_name(self, input: impl Into<String>) -> Self
pub fn db_name(self, input: impl Into<String>) -> Self
The name of a database that DbUser
is authorized to log on to. If DbName
is not specified, DbUser
can log on to any existing database.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn set_db_name(self, input: Option<String>) -> Self
pub fn set_db_name(self, input: Option<String>) -> Self
The name of a database that DbUser
is authorized to log on to. If DbName
is not specified, DbUser
can log on to any existing database.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn get_db_name(&self) -> &Option<String>
pub fn get_db_name(&self) -> &Option<String>
The name of a database that DbUser
is authorized to log on to. If DbName
is not specified, DbUser
can log on to any existing database.
Constraints:
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.
Sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.
Sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.
Sourcepub fn duration_seconds(self, input: i32) -> Self
pub fn duration_seconds(self, input: i32) -> Self
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
Sourcepub fn set_duration_seconds(self, input: Option<i32>) -> Self
pub fn set_duration_seconds(self, input: Option<i32>) -> Self
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
Sourcepub fn get_duration_seconds(&self) -> &Option<i32>
pub fn get_duration_seconds(&self) -> &Option<i32>
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
Sourcepub fn auto_create(self, input: bool) -> Self
pub fn auto_create(self, input: bool) -> Self
Create a database user with the name specified for the user named in DbUser
if one does not exist.
Sourcepub fn set_auto_create(self, input: Option<bool>) -> Self
pub fn set_auto_create(self, input: Option<bool>) -> Self
Create a database user with the name specified for the user named in DbUser
if one does not exist.
Sourcepub fn get_auto_create(&self) -> &Option<bool>
pub fn get_auto_create(&self) -> &Option<bool>
Create a database user with the name specified for the user named in DbUser
if one does not exist.
Sourcepub fn db_groups(self, input: impl Into<String>) -> Self
pub fn db_groups(self, input: impl Into<String>) -> Self
Appends an item to DbGroups
.
To override the contents of this collection use set_db_groups
.
A list of the names of existing database groups that the user named in DbUser
will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn set_db_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_db_groups(self, input: Option<Vec<String>>) -> Self
A list of the names of existing database groups that the user named in DbUser
will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn get_db_groups(&self) -> &Option<Vec<String>>
pub fn get_db_groups(&self) -> &Option<Vec<String>>
A list of the names of existing database groups that the user named in DbUser
will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
-
Must be 1 to 64 alphanumeric characters or hyphens
-
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
First character must be a letter.
-
Must not contain a colon ( : ) or slash ( / ).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn custom_domain_name(self, input: impl Into<String>) -> Self
pub fn custom_domain_name(self, input: impl Into<String>) -> Self
The custom domain name for the cluster credentials.
Sourcepub fn set_custom_domain_name(self, input: Option<String>) -> Self
pub fn set_custom_domain_name(self, input: Option<String>) -> Self
The custom domain name for the cluster credentials.
Sourcepub fn get_custom_domain_name(&self) -> &Option<String>
pub fn get_custom_domain_name(&self) -> &Option<String>
The custom domain name for the cluster credentials.
Trait Implementations§
Source§impl Clone for GetClusterCredentialsFluentBuilder
impl Clone for GetClusterCredentialsFluentBuilder
Source§fn clone(&self) -> GetClusterCredentialsFluentBuilder
fn clone(&self) -> GetClusterCredentialsFluentBuilder
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 GetClusterCredentialsFluentBuilder
impl !RefUnwindSafe for GetClusterCredentialsFluentBuilder
impl Send for GetClusterCredentialsFluentBuilder
impl Sync for GetClusterCredentialsFluentBuilder
impl Unpin for GetClusterCredentialsFluentBuilder
impl !UnwindSafe for GetClusterCredentialsFluentBuilder
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);