Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. redshiftserverless
  5. getNamespace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.redshiftserverless.getNamespace

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::RedshiftServerless::Namespace Resource Type

Using getNamespace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNamespace(args: GetNamespaceArgs, opts?: InvokeOptions): Promise<GetNamespaceResult>
function getNamespaceOutput(args: GetNamespaceOutputArgs, opts?: InvokeOptions): Output<GetNamespaceResult>
Copy
def get_namespace(namespace_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetNamespaceResult
def get_namespace_output(namespace_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetNamespaceResult]
Copy
func LookupNamespace(ctx *Context, args *LookupNamespaceArgs, opts ...InvokeOption) (*LookupNamespaceResult, error)
func LookupNamespaceOutput(ctx *Context, args *LookupNamespaceOutputArgs, opts ...InvokeOption) LookupNamespaceResultOutput
Copy

> Note: This function is named LookupNamespace in the Go SDK.

public static class GetNamespace 
{
    public static Task<GetNamespaceResult> InvokeAsync(GetNamespaceArgs args, InvokeOptions? opts = null)
    public static Output<GetNamespaceResult> Invoke(GetNamespaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNamespaceResult> getNamespace(GetNamespaceArgs args, InvokeOptions options)
public static Output<GetNamespaceResult> getNamespace(GetNamespaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:redshiftserverless:getNamespace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NamespaceName This property is required. 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.
NamespaceName This property is required. 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.
namespaceName This property is required. 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.
namespaceName This property is required. 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.
namespace_name This property is required. str
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.
namespaceName This property is required. 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.

getNamespace Result

The following output properties are available:

AdminPasswordSecretKmsKeyId 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.
AdminUsername 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.
DbName 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.
DefaultIamRoleArn string
The default IAM role ARN for the namespace that is being created.
IamRoles List<string>
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.
KmsKeyId string
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
LogExports List<Pulumi.AwsNative.RedshiftServerless.NamespaceLogExport>
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
NamespaceResourcePolicy object

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

NamespaceValue Pulumi.AwsNative.RedshiftServerless.Outputs.Namespace
Definition of Namespace resource.
SnapshotCopyConfigurations List<Pulumi.AwsNative.RedshiftServerless.Outputs.NamespaceSnapshotCopyConfiguration>
The snapshot copy configurations for the namespace.
AdminPasswordSecretKmsKeyId 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.
AdminUsername 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.
DbName 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.
DefaultIamRoleArn string
The default IAM role ARN for the namespace that is being created.
IamRoles []string
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.
KmsKeyId string
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
LogExports []NamespaceLogExport
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
Namespace NamespaceType
Definition of Namespace resource.
NamespaceResourcePolicy interface{}

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

SnapshotCopyConfigurations []NamespaceSnapshotCopyConfiguration
The snapshot copy configurations for the namespace.
adminPasswordSecretKmsKeyId 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.
adminUsername 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.
dbName 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.
defaultIamRoleArn String
The default IAM role ARN for the namespace that is being created.
iamRoles List<String>
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.
kmsKeyId String
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
logExports List<NamespaceLogExport>
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
namespace Namespace
Definition of Namespace resource.
namespaceResourcePolicy Object

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

snapshotCopyConfigurations List<NamespaceSnapshotCopyConfiguration>
The snapshot copy configurations for the namespace.
adminPasswordSecretKmsKeyId 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.
adminUsername 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.
dbName 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.
defaultIamRoleArn string
The default IAM role ARN for the namespace that is being created.
iamRoles string[]
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.
kmsKeyId string
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
logExports NamespaceLogExport[]
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
namespace Namespace
Definition of Namespace resource.
namespaceResourcePolicy any

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

snapshotCopyConfigurations NamespaceSnapshotCopyConfiguration[]
The snapshot copy configurations for the namespace.
admin_password_secret_kms_key_id str
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_username str
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 str
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 str
The default IAM role ARN for the namespace that is being created.
iam_roles Sequence[str]
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 str
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 Sequence[NamespaceLogExport]
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
namespace Namespace
Definition of Namespace resource.
namespace_resource_policy Any

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

snapshot_copy_configurations Sequence[NamespaceSnapshotCopyConfiguration]
The snapshot copy configurations for the namespace.
adminPasswordSecretKmsKeyId 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.
adminUsername 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.
dbName 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.
defaultIamRoleArn String
The default IAM role ARN for the namespace that is being created.
iamRoles List<String>
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.
kmsKeyId String
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
logExports List<"useractivitylog" | "userlog" | "connectionlog">
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
namespace Property Map
Definition of Namespace resource.
namespaceResourcePolicy Any

The resource policy document that will be attached to the namespace.

Search the CloudFormation User Guide for AWS::RedshiftServerless::Namespace for more information about the expected schema for this property.

snapshotCopyConfigurations List<Property Map>
The snapshot copy configurations for the namespace.

Supporting Types

Namespace

AdminPasswordSecretArn string
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
AdminPasswordSecretKmsKeyId string
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
AdminUsername string
The username of the administrator for the first database created in the namespace.
CreationDate string
The date of when the namespace was created.
DbName string
The name of the first database created in the namespace.
DefaultIamRoleArn string
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
IamRoles List<string>
A list of IAM roles to associate with the namespace.
KmsKeyId string
The ID of the AWS Key Management Service key used to encrypt your data.
LogExports List<Pulumi.AwsNative.RedshiftServerless.NamespaceLogExport>
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
NamespaceArn string
The Amazon Resource Name (ARN) associated with a namespace.
NamespaceId string
The unique identifier of a namespace.
NamespaceName 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.
Status Pulumi.AwsNative.RedshiftServerless.NamespaceStatus
The status of the namespace.
AdminPasswordSecretArn string
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
AdminPasswordSecretKmsKeyId string
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
AdminUsername string
The username of the administrator for the first database created in the namespace.
CreationDate string
The date of when the namespace was created.
DbName string
The name of the first database created in the namespace.
DefaultIamRoleArn string
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
IamRoles []string
A list of IAM roles to associate with the namespace.
KmsKeyId string
The ID of the AWS Key Management Service key used to encrypt your data.
LogExports []NamespaceLogExport
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
NamespaceArn string
The Amazon Resource Name (ARN) associated with a namespace.
NamespaceId string
The unique identifier of a namespace.
NamespaceName 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.
Status NamespaceStatus
The status of the namespace.
adminPasswordSecretArn String
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId String
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername String
The username of the administrator for the first database created in the namespace.
creationDate String
The date of when the namespace was created.
dbName String
The name of the first database created in the namespace.
defaultIamRoleArn String
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles List<String>
A list of IAM roles to associate with the namespace.
kmsKeyId String
The ID of the AWS Key Management Service key used to encrypt your data.
logExports List<NamespaceLogExport>
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn String
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId String
The unique identifier of a namespace.
namespaceName 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.
status NamespaceStatus
The status of the namespace.
adminPasswordSecretArn string
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId string
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername string
The username of the administrator for the first database created in the namespace.
creationDate string
The date of when the namespace was created.
dbName string
The name of the first database created in the namespace.
defaultIamRoleArn string
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles string[]
A list of IAM roles to associate with the namespace.
kmsKeyId string
The ID of the AWS Key Management Service key used to encrypt your data.
logExports NamespaceLogExport[]
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn string
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId string
The unique identifier of a namespace.
namespaceName 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.
status NamespaceStatus
The status of the namespace.
admin_password_secret_arn str
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
admin_password_secret_kms_key_id str
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
admin_username str
The username of the administrator for the first database created in the namespace.
creation_date str
The date of when the namespace was created.
db_name str
The name of the first database created in the namespace.
default_iam_role_arn str
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iam_roles Sequence[str]
A list of IAM roles to associate with the namespace.
kms_key_id str
The ID of the AWS Key Management Service key used to encrypt your data.
log_exports Sequence[NamespaceLogExport]
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespace_arn str
The Amazon Resource Name (ARN) associated with a namespace.
namespace_id str
The unique identifier of a namespace.
namespace_name str
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.
status NamespaceStatus
The status of the namespace.
adminPasswordSecretArn String
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyId String
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsername String
The username of the administrator for the first database created in the namespace.
creationDate String
The date of when the namespace was created.
dbName String
The name of the first database created in the namespace.
defaultIamRoleArn String
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles List<String>
A list of IAM roles to associate with the namespace.
kmsKeyId String
The ID of the AWS Key Management Service key used to encrypt your data.
logExports List<"useractivitylog" | "userlog" | "connectionlog">
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn String
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId String
The unique identifier of a namespace.
namespaceName 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.
status "AVAILABLE" | "MODIFYING" | "DELETING"
The status of the namespace.

NamespaceLogExport

NamespaceSnapshotCopyConfiguration

DestinationRegion This property is required. string
The destination AWS Region to copy snapshots to.
DestinationKmsKeyId string
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
SnapshotRetentionPeriod int
The retention period of snapshots that are copied to the destination AWS Region .
DestinationRegion This property is required. string
The destination AWS Region to copy snapshots to.
DestinationKmsKeyId string
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
SnapshotRetentionPeriod int
The retention period of snapshots that are copied to the destination AWS Region .
destinationRegion This property is required. String
The destination AWS Region to copy snapshots to.
destinationKmsKeyId String
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
snapshotRetentionPeriod Integer
The retention period of snapshots that are copied to the destination AWS Region .
destinationRegion This property is required. string
The destination AWS Region to copy snapshots to.
destinationKmsKeyId string
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
snapshotRetentionPeriod number
The retention period of snapshots that are copied to the destination AWS Region .
destination_region This property is required. str
The destination AWS Region to copy snapshots to.
destination_kms_key_id str
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
snapshot_retention_period int
The retention period of snapshots that are copied to the destination AWS Region .
destinationRegion This property is required. String
The destination AWS Region to copy snapshots to.
destinationKmsKeyId String
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
snapshotRetentionPeriod Number
The retention period of snapshots that are copied to the destination AWS Region .

NamespaceStatus

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native