Struct aws_sdk_redshift::input::GetClusterCredentialsInput

#[non_exhaustive]
pub struct GetClusterCredentialsInput {
    pub db_user: Option<String>,
    pub db_name: Option<String>,
    pub cluster_identifier: Option<String>,
    pub duration_seconds: Option<i32>,
    pub auto_create: Option<bool>,
    pub db_groups: Option<Vec<String>>,
}

The request parameters to get cluster credentials.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_user: 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 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.

db_name: 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 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.

cluster_identifier: Option<String>

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

duration_seconds: Option<i32>

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

auto_create: Option<bool>

Create a database user with the name specified for the user named in DbUser if one does not exist.

db_groups: 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.

Implementations

impl GetClusterCredentialsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetClusterCredentials, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GetClusterCredentials>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetClusterCredentialsInput

impl GetClusterCredentialsInput

pub fn db_user(&self) -> Option<&str>

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 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.

pub fn db_name(&self) -> Option<&str>

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 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.

pub fn cluster_identifier(&self) -> Option<&str>

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

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

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

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

Create a database user with the name specified for the user named in DbUser if one does not exist.

pub fn db_groups(&self) -> Option<&[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.

Trait Implementations

impl Clone for GetClusterCredentialsInput

fn clone(&self) -> GetClusterCredentialsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetClusterCredentialsInput

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

Formats the value using the given formatter.

impl PartialEq<GetClusterCredentialsInput> for GetClusterCredentialsInput

fn eq(&self, other: &GetClusterCredentialsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetClusterCredentialsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for GetClusterCredentialsInput