Class: Aws::RedshiftDataAPIService::Types::ListDatabasesRequest

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftDataAPIService::Types::ListDatabasesRequest

Defined in:

gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_identifier ⇒ String

  The cluster identifier.

• #database ⇒ String

  The name of the database.

• #db_user ⇒ String

  The database user name.

• #max_results ⇒ Integer

  The maximum number of databases to return in the response.

• #next_token ⇒ String

  A value that indicates the starting point for the next set of response records in a subsequent request.

• #secret_arn ⇒ String

  The name or ARN of the secret that enables access to the database.

• #workgroup_name ⇒ String

  The serverless workgroup name or Amazon Resource Name (ARN).

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ String

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

Returns:

• (Integer)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 852

class ListDatabasesRequest < Struct.new(
  :cluster_identifier,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end