/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::GetClusterCredentials

NAME

Paws::RedShift::GetClusterCredentials - Arguments for method GetClusterCredentials on Paws::RedShift

DESCRIPTION

This class represents the parameters used for calling the method GetClusterCredentials on the Amazon Redshift service. Use the attributes of this class as arguments to method GetClusterCredentials.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetClusterCredentials.

SYNOPSIS

my $redshift = Paws->service('RedShift');
my $ClusterCredentials = $redshift->GetClusterCredentials(
  ClusterIdentifier => 'MyString',
  DbUser            => 'MyString',
  AutoCreate        => 1,            # OPTIONAL
  DbGroups          => [
    'MyString', ...                  # max: 2147483647
  ],    # OPTIONAL
  DbName          => 'MyString',    # OPTIONAL
  DurationSeconds => 1,             # OPTIONAL
);

# Results:
my $DbPassword = $ClusterCredentials->DbPassword;
my $DbUser     = $ClusterCredentials->DbUser;
my $Expiration = $ClusterCredentials->Expiration;

# Returns a L<Paws::RedShift::ClusterCredentials> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/redshift/GetClusterCredentials

ATTRIBUTES

AutoCreate => Bool

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

REQUIRED ClusterIdentifier => Str

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

DbGroups => ArrayRef[Str|Undef]

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 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.

DbName => 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 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.

REQUIRED DbUser => 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 (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) 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 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.

DurationSeconds => Int

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

SEE ALSO

This class forms part of Paws, documenting arguments for method GetClusterCredentials in Paws::RedShift

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues