AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Redshift::Model::GetClusterCredentialsRequest Class Reference

#include <GetClusterCredentialsRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::GetClusterCredentialsRequest:

Public Member Functions

 GetClusterCredentialsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDbUser () const
 
bool DbUserHasBeenSet () const
 
void SetDbUser (const Aws::String &value)
 
void SetDbUser (Aws::String &&value)
 
void SetDbUser (const char *value)
 
GetClusterCredentialsRequestWithDbUser (const Aws::String &value)
 
GetClusterCredentialsRequestWithDbUser (Aws::String &&value)
 
GetClusterCredentialsRequestWithDbUser (const char *value)
 
const Aws::StringGetDbName () const
 
bool DbNameHasBeenSet () const
 
void SetDbName (const Aws::String &value)
 
void SetDbName (Aws::String &&value)
 
void SetDbName (const char *value)
 
GetClusterCredentialsRequestWithDbName (const Aws::String &value)
 
GetClusterCredentialsRequestWithDbName (Aws::String &&value)
 
GetClusterCredentialsRequestWithDbName (const char *value)
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
GetClusterCredentialsRequestWithClusterIdentifier (const Aws::String &value)
 
GetClusterCredentialsRequestWithClusterIdentifier (Aws::String &&value)
 
GetClusterCredentialsRequestWithClusterIdentifier (const char *value)
 
int GetDurationSeconds () const
 
bool DurationSecondsHasBeenSet () const
 
void SetDurationSeconds (int value)
 
GetClusterCredentialsRequestWithDurationSeconds (int value)
 
bool GetAutoCreate () const
 
bool AutoCreateHasBeenSet () const
 
void SetAutoCreate (bool value)
 
GetClusterCredentialsRequestWithAutoCreate (bool value)
 
const Aws::Vector< Aws::String > & GetDbGroups () const
 
bool DbGroupsHasBeenSet () const
 
void SetDbGroups (const Aws::Vector< Aws::String > &value)
 
void SetDbGroups (Aws::Vector< Aws::String > &&value)
 
GetClusterCredentialsRequestWithDbGroups (const Aws::Vector< Aws::String > &value)
 
GetClusterCredentialsRequestWithDbGroups (Aws::Vector< Aws::String > &&value)
 
GetClusterCredentialsRequestAddDbGroups (const Aws::String &value)
 
GetClusterCredentialsRequestAddDbGroups (Aws::String &&value)
 
GetClusterCredentialsRequestAddDbGroups (const char *value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The request parameters to get cluster credentials.

See Also:

AWS API Reference

Definition at line 26 of file GetClusterCredentialsRequest.h.

Constructor & Destructor Documentation

◆ GetClusterCredentialsRequest()

Aws::Redshift::Model::GetClusterCredentialsRequest::GetClusterCredentialsRequest ( )

Member Function Documentation

◆ AddDbGroups() [1/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::AddDbGroups ( const Aws::String value)
inline

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.

Definition at line 544 of file GetClusterCredentialsRequest.h.

◆ AddDbGroups() [2/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::AddDbGroups ( Aws::String &&  value)
inline

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.

Definition at line 559 of file GetClusterCredentialsRequest.h.

◆ AddDbGroups() [3/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::AddDbGroups ( const char *  value)
inline

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.

Definition at line 574 of file GetClusterCredentialsRequest.h.

◆ AutoCreateHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::AutoCreateHasBeenSet ( ) const
inline

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

Definition at line 426 of file GetClusterCredentialsRequest.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::ClusterIdentifierHasBeenSet ( ) const
inline

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

Definition at line 352 of file GetClusterCredentialsRequest.h.

◆ DbGroupsHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::DbGroupsHasBeenSet ( ) const
inline

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.

Definition at line 469 of file GetClusterCredentialsRequest.h.

◆ DbNameHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::DbNameHasBeenSet ( ) const
inline

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.

Definition at line 255 of file GetClusterCredentialsRequest.h.

◆ DbUserHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::DbUserHasBeenSet ( ) const
inline

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.

Definition at line 88 of file GetClusterCredentialsRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::GetClusterCredentialsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DurationSecondsHasBeenSet()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::DurationSecondsHasBeenSet ( ) const
inline

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Definition at line 401 of file GetClusterCredentialsRequest.h.

◆ GetAutoCreate()

bool Aws::Redshift::Model::GetClusterCredentialsRequest::GetAutoCreate ( ) const
inline

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

Definition at line 420 of file GetClusterCredentialsRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::GetClusterCredentialsRequest::GetClusterIdentifier ( ) const
inline

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

Definition at line 346 of file GetClusterCredentialsRequest.h.

◆ GetDbGroups()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::GetClusterCredentialsRequest::GetDbGroups ( ) const
inline

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.

Definition at line 454 of file GetClusterCredentialsRequest.h.

◆ GetDbName()

const Aws::String& Aws::Redshift::Model::GetClusterCredentialsRequest::GetDbName ( ) const
inline

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.

Definition at line 241 of file GetClusterCredentialsRequest.h.

◆ GetDbUser()

const Aws::String& Aws::Redshift::Model::GetClusterCredentialsRequest::GetDbUser ( ) const
inline

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.

Definition at line 65 of file GetClusterCredentialsRequest.h.

◆ GetDurationSeconds()

int Aws::Redshift::Model::GetClusterCredentialsRequest::GetDurationSeconds ( ) const
inline

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Definition at line 395 of file GetClusterCredentialsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::GetClusterCredentialsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetClusterCredentialsRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::GetClusterCredentialsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoCreate()

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetAutoCreate ( bool  value)
inline

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

Definition at line 432 of file GetClusterCredentialsRequest.h.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 358 of file GetClusterCredentialsRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 364 of file GetClusterCredentialsRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetClusterIdentifier ( const char *  value)
inline

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

Definition at line 370 of file GetClusterCredentialsRequest.h.

◆ SetDbGroups() [1/2]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 484 of file GetClusterCredentialsRequest.h.

◆ SetDbGroups() [2/2]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 499 of file GetClusterCredentialsRequest.h.

◆ SetDbName() [1/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbName ( const Aws::String value)
inline

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.

Definition at line 269 of file GetClusterCredentialsRequest.h.

◆ SetDbName() [2/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbName ( Aws::String &&  value)
inline

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.

Definition at line 283 of file GetClusterCredentialsRequest.h.

◆ SetDbName() [3/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbName ( const char *  value)
inline

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.

Definition at line 297 of file GetClusterCredentialsRequest.h.

◆ SetDbUser() [1/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbUser ( const Aws::String value)
inline

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.

Definition at line 111 of file GetClusterCredentialsRequest.h.

◆ SetDbUser() [2/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbUser ( Aws::String &&  value)
inline

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.

Definition at line 134 of file GetClusterCredentialsRequest.h.

◆ SetDbUser() [3/3]

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDbUser ( const char *  value)
inline

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.

Definition at line 157 of file GetClusterCredentialsRequest.h.

◆ SetDurationSeconds()

void Aws::Redshift::Model::GetClusterCredentialsRequest::SetDurationSeconds ( int  value)
inline

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Definition at line 407 of file GetClusterCredentialsRequest.h.

◆ WithAutoCreate()

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithAutoCreate ( bool  value)
inline

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

Definition at line 438 of file GetClusterCredentialsRequest.h.

◆ WithClusterIdentifier() [1/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 376 of file GetClusterCredentialsRequest.h.

◆ WithClusterIdentifier() [2/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 382 of file GetClusterCredentialsRequest.h.

◆ WithClusterIdentifier() [3/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithClusterIdentifier ( const char *  value)
inline

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

Definition at line 388 of file GetClusterCredentialsRequest.h.

◆ WithDbGroups() [1/2]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 514 of file GetClusterCredentialsRequest.h.

◆ WithDbGroups() [2/2]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 529 of file GetClusterCredentialsRequest.h.

◆ WithDbName() [1/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbName ( const Aws::String value)
inline

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.

Definition at line 311 of file GetClusterCredentialsRequest.h.

◆ WithDbName() [2/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbName ( Aws::String &&  value)
inline

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.

Definition at line 325 of file GetClusterCredentialsRequest.h.

◆ WithDbName() [3/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbName ( const char *  value)
inline

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.

Definition at line 339 of file GetClusterCredentialsRequest.h.

◆ WithDbUser() [1/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbUser ( const Aws::String value)
inline

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.

Definition at line 180 of file GetClusterCredentialsRequest.h.

◆ WithDbUser() [2/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbUser ( Aws::String &&  value)
inline

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.

Definition at line 203 of file GetClusterCredentialsRequest.h.

◆ WithDbUser() [3/3]

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDbUser ( const char *  value)
inline

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.

Definition at line 226 of file GetClusterCredentialsRequest.h.

◆ WithDurationSeconds()

GetClusterCredentialsRequest& Aws::Redshift::Model::GetClusterCredentialsRequest::WithDurationSeconds ( int  value)
inline

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Definition at line 413 of file GetClusterCredentialsRequest.h.


The documentation for this class was generated from the following file: