Class: Aws::Redshift::Types::GetClusterCredentialsMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass GetClusterCredentialsMessage data as a hash:

{
  db_user: "String", # required
  db_name: "String",
  cluster_identifier: "String", # required
  duration_seconds: 1,
  auto_create: false,
  db_groups: ["String"],
}

The request parameters to get cluster credentials.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_create ⇒ Boolean

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

Returns:

  • (Boolean) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end

#cluster_identifier ⇒ String

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

Returns:

  • (String) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end

#db_groups ⇒ Array<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.

[1]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html

Returns:

  • (Array<String>) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end

#db_name ⇒ 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.

[1]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html

Returns:

  • (String) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end

#db_user ⇒ 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.

[1]: docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html [2]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html

Returns:

  • (String) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end

#duration_seconds ⇒ Integer

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Returns:

  • (Integer) 


4979
4980
4981
4982
4983
4984
4985
4986
4987
 
# File 'lib/aws-sdk-redshift/types.rb', line 4979

class GetClusterCredentialsMessage < Struct.new(
  :db_user,
  :db_name,
  :cluster_identifier,
  :duration_seconds,
  :auto_create,
  :db_groups)
  include Aws::Structure
end