Class: Aws::RedshiftServerless::Types::UpdateNamespaceRequest

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftServerless::Types::UpdateNamespaceRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:admin_user_password, :admin_username]

Instance Attribute Summary

• #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_user_password ⇒ String

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

• #admin_username ⇒ String

  The username of the administrator for 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.

• #log_exports ⇒ Array<String>

  The types of logs the namespace can export.

• #manage_admin_password ⇒ Boolean

  If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials.

• #namespace_name ⇒ String

  The name of the namespace to update.

Instance Attribute Details

#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. You can only use this parameter if manageAdminPassword is true.

Returns:

• (String)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#admin_user_password ⇒ String

The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.

You can't use adminUserPassword if manageAdminPassword is true.

Returns:

• (String)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#admin_username ⇒ String

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

Returns:

• (String)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :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. This parameter must be updated together with iamRoles.

Returns:

• (String)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#iam_roles ⇒ Array<String>

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

Returns:

• (Array<String>)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :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 3305

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#log_exports ⇒ Array<String>

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

Returns:

• (Array<String>)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#manage_admin_password ⇒ Boolean

If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.

Returns:

• (Boolean)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end

#namespace_name ⇒ String

The name of the namespace to update. You can't update the name of a namespace once it is created.

Returns:

• (String)

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

class UpdateNamespaceRequest < Struct.new(
  :admin_password_secret_kms_key_id,
  :admin_user_password,
  :admin_username,
  :default_iam_role_arn,
  :iam_roles,
  :kms_key_id,
  :log_exports,
  :manage_admin_password,
  :namespace_name)
  SENSITIVE = [:admin_user_password, :admin_username]
  include Aws::Structure
end