AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetClusterCredentialsInput

import "github.com/aws/aws-sdk-go/service/redshift"

type GetClusterCredentialsInput struct { AutoCreate *bool `type:"boolean"` ClusterIdentifier *string `type:"string" required:"true"` DbGroups []*string `locationNameList:"DbGroup" type:"list"` DbName *string `type:"string"` DbUser *string `type:"string" required:"true"` DurationSeconds *int64 `type:"integer"` }

The request parameters to get cluster credentials.

AutoCreate

Type: *bool

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

ClusterIdentifier

Type: *string

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

ClusterIdentifier is a required field

DbGroups

Type: []*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 ( / ).

DbName

Type: *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 ( / ).

DbUser

Type: *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 (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 ( / ).

DbUser is a required field

DurationSeconds

Type: *int64

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Method

GoString

func (s GetClusterCredentialsInput) GoString() string

GoString returns the string representation

SetAutoCreate

func (s *GetClusterCredentialsInput) SetAutoCreate(v bool) *GetClusterCredentialsInput

SetAutoCreate sets the AutoCreate field's value.

SetClusterIdentifier

func (s *GetClusterCredentialsInput) SetClusterIdentifier(v string) *GetClusterCredentialsInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetDbGroups

func (s *GetClusterCredentialsInput) SetDbGroups(v []*string) *GetClusterCredentialsInput

SetDbGroups sets the DbGroups field's value.

SetDbName

func (s *GetClusterCredentialsInput) SetDbName(v string) *GetClusterCredentialsInput

SetDbName sets the DbName field's value.

SetDbUser

func (s *GetClusterCredentialsInput) SetDbUser(v string) *GetClusterCredentialsInput

SetDbUser sets the DbUser field's value.

SetDurationSeconds

func (s *GetClusterCredentialsInput) SetDurationSeconds(v int64) *GetClusterCredentialsInput

SetDurationSeconds sets the DurationSeconds field's value.

String

func (s GetClusterCredentialsInput) String() string

String returns the string representation

Validate

func (s *GetClusterCredentialsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: