Struct aws_sdk_redshift::operation::get_cluster_credentials::builders::GetClusterCredentialsInputBuilder

#[non_exhaustive]
pub struct GetClusterCredentialsInputBuilder { /* private fields */ }

A builder for GetClusterCredentialsInput.

Implementations

impl GetClusterCredentialsInputBuilder

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.

This field is required.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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.

pub fn db_groups(self, input: impl Into<String>) -> Self

Appends an item to db_groups.

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.

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.

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.

pub fn custom_domain_name(self, input: impl Into<String>) -> Self

The custom domain name for the cluster credentials.

pub fn set_custom_domain_name(self, input: Option<String>) -> Self

The custom domain name for the cluster credentials.

pub fn get_custom_domain_name(&self) -> &Option<String>

The custom domain name for the cluster credentials.

pub fn build(self) -> Result<GetClusterCredentialsInput, BuildError>

Consumes the builder and constructs a GetClusterCredentialsInput.

impl GetClusterCredentialsInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetClusterCredentialsOutput, SdkError<GetClusterCredentialsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetClusterCredentialsInputBuilder

fn clone(&self) -> GetClusterCredentialsInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetClusterCredentialsInputBuilder

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

Formats the value using the given formatter.

impl Default for GetClusterCredentialsInputBuilder

fn default() -> GetClusterCredentialsInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetClusterCredentialsInputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetClusterCredentialsInputBuilder