Class: Aws::RedshiftServerless::Types::Namespace

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftServerless::Types::Namespace

Defined in:

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

Overview

A collection of database objects and users.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:admin_username]

Instance Attribute Summary

• #admin_password_secret_arn ⇒ String

  The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

• #admin_password_secret_kms_key_id ⇒ String

  The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

• #admin_username ⇒ String

  The username of the administrator for the first database created in the namespace.

• #catalog_arn ⇒ String

  The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

• #creation_date ⇒ Time

  The date of when the namespace was created.

• #db_name ⇒ String

  The name of the first database created in the namespace.

• #default_iam_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

• #iam_roles ⇒ Array<String>

  A list of IAM roles to associate with the namespace.

• #kms_key_id ⇒ String

  The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

• #lakehouse_registration_status ⇒ String

  The status of the lakehouse registration for the namespace.

• #log_exports ⇒ Array<String>

  The types of logs the namespace can export.

• #namespace_arn ⇒ String

  The Amazon Resource Name (ARN) associated with a namespace.

• #namespace_id ⇒ String

  The unique identifier of a namespace.

• #namespace_name ⇒ String

  The name of the namespace.

• #status ⇒ String

  The status of the namespace.

Instance Attribute Details

#admin_password_secret_arn ⇒ String

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#admin_password_secret_kms_key_id ⇒ String

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#admin_username ⇒ String

The username of the administrator for the first database created in the namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#catalog_arn ⇒ String

The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#creation_date ⇒ Time

The date of when the namespace was created.

Returns:

• (Time)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#db_name ⇒ String

The name of the first database created in the namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#default_iam_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#iam_roles ⇒ Array<String>

A list of IAM roles to associate with the namespace.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#lakehouse_registration_status ⇒ String

The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#log_exports ⇒ Array<String>

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#namespace_arn ⇒ String

The Amazon Resource Name (ARN) associated with a namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#namespace_id ⇒ String

The unique identifier of a namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#namespace_name ⇒ String

The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end

#status ⇒ String

The status of the namespace.

Returns:

• (String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2462

class Namespace < Struct.new(
  :admin_password_secret_arn,
  :admin_password_secret_kms_key_id,
  :admin_username,
  :catalog_arn,
  :creation_date,
  :db_name,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :lakehouse_registration_status,
  :log_exports,
  :namespace_arn,
  :namespace_id,
  :namespace_name,
  :status)
  SENSITIVE = [:admin_username]
  include Aws::Structure
end