namespaces_list_only
Lists namespaces
in a region or regions, for all properties use namespaces
Overview
Name | namespaces_list_only |
Type | Resource |
Description | Definition of AWS::RedshiftServerless::Namespace Resource Type |
Id | aws.redshiftserverless.namespaces_list_only |
Fields
Name | Datatype | Description |
---|---|---|
admin_password_secret_kms_key_id | string | The ID of the AWS 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. |
admin_user_password | string | The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true. |
admin_username | string | The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. |
db_name | string | The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. |
default_iam_role_arn | string | The default IAM role ARN for the namespace that is being created. |
iam_roles | array | A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10. |
kms_key_id | string | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace. |
log_exports | array | The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog |
manage_admin_password | boolean | If true, Amazon Redshift uses AWS 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. |
namespace | object | Definition of Namespace resource. |
namespace_name | string | A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account. |
tags | array | The list of tags for the namespace. |
final_snapshot_name | string | The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace |
final_snapshot_retention_period | integer | The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. |
namespace_resource_policy | object | The resource policy document that will be attached to the namespace. |
redshift_idc_application_arn | string | The ARN for the Redshift application that integrates with IAM Identity Center. |
snapshot_copy_configurations | array | The snapshot copy configurations for the namespace. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all namespaces
in a region.
SELECT
region,
namespace_name
FROM aws.redshiftserverless.namespaces_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the namespaces_list_only
resource, see namespaces