AWS Native is in preview. AWS Classic is fully supported.
aws-native.redshiftserverless.getNamespace
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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>
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]
func LookupNamespace(ctx *Context, args *LookupNamespaceArgs, opts ...InvokeOption) (*LookupNamespaceResult, error)
func LookupNamespaceOutput(ctx *Context, args *LookupNamespaceOutputArgs, opts ...InvokeOption) LookupNamespaceResultOutput
> 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)
}
public static CompletableFuture<GetNamespaceResult> getNamespace(GetNamespaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:redshiftserverless:getNamespace
arguments:
# arguments dictionary
The following arguments are supported:
- 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.
- 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.
- 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.
- 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.
- namespace_
name 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.
- 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.
getNamespace Result
The following output properties are available:
- Admin
Password stringSecret Kms Key Id - 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 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 stringRole Arn - The default IAM role ARN for the namespace that is being created.
- Iam
Roles 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.
- Kms
Key stringId - 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 List<Pulumi.Aws Native. Redshift Serverless. Namespace Log Export> - 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
Resource objectPolicy 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.- Namespace
Value Pulumi.Aws Native. Redshift Serverless. Outputs. Namespace - Definition of Namespace resource.
- Snapshot
Copy List<Pulumi.Configurations Aws Native. Redshift Serverless. Outputs. Namespace Snapshot Copy Configuration> - The snapshot copy configurations for the namespace.
- Admin
Password stringSecret Kms Key Id - 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 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 stringRole Arn - The default IAM role ARN for the namespace that is being created.
- Iam
Roles []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.
- Kms
Key stringId - 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 []NamespaceLog Export - 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
Type - Definition of Namespace resource.
- Namespace
Resource interface{}Policy 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 []NamespaceConfigurations Snapshot Copy Configuration - The snapshot copy configurations for the namespace.
- admin
Password StringSecret Kms Key Id - 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 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 StringRole Arn - The default IAM role ARN for the namespace that is being created.
- iam
Roles 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.
- kms
Key StringId - 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 List<NamespaceLog Export> - 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 ObjectPolicy 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 List<NamespaceConfigurations Snapshot Copy Configuration> - The snapshot copy configurations for the namespace.
- admin
Password stringSecret Kms Key Id - 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 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 stringRole Arn - The default IAM role ARN for the namespace that is being created.
- iam
Roles 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.
- kms
Key stringId - 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 NamespaceLog Export[] - 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 anyPolicy 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 NamespaceConfigurations Snapshot Copy Configuration[] - The snapshot copy configurations for the namespace.
- admin_
password_ strsecret_ kms_ key_ id - 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_ strrole_ arn - 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_ strid - 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[NamespaceLog Export] - 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_ Anypolicy 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_ Sequence[Namespaceconfigurations Snapshot Copy Configuration] - The snapshot copy configurations for the namespace.
- admin
Password StringSecret Kms Key Id - 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 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 StringRole Arn - The default IAM role ARN for the namespace that is being created.
- iam
Roles 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.
- kms
Key StringId - 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 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.
- namespace
Resource AnyPolicy 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 List<Property Map>Configurations - The snapshot copy configurations for the namespace.
Supporting Types
Namespace
- Admin
Password stringSecret Arn - Admin
Password stringSecret Kms Key Id - Admin
Username string - Creation
Date string - Db
Name string - Default
Iam stringRole Arn - Iam
Roles List<string> - Kms
Key stringId - Log
Exports List<Pulumi.Aws Native. Redshift Serverless. Namespace Log Export> - Namespace
Arn string - Namespace
Id string - Namespace
Name string - Status
Pulumi.
Aws Native. Redshift Serverless. Namespace Status
- Admin
Password stringSecret Arn - Admin
Password stringSecret Kms Key Id - Admin
Username string - Creation
Date string - Db
Name string - Default
Iam stringRole Arn - Iam
Roles []string - Kms
Key stringId - Log
Exports []NamespaceLog Export - Namespace
Arn string - Namespace
Id string - Namespace
Name string - Status
Namespace
Status
- admin
Password StringSecret Arn - admin
Password StringSecret Kms Key Id - admin
Username String - creation
Date String - db
Name String - default
Iam StringRole Arn - iam
Roles List<String> - kms
Key StringId - log
Exports List<NamespaceLog Export> - namespace
Arn String - namespace
Id String - namespace
Name String - status
Namespace
Status
- admin
Password stringSecret Arn - admin
Password stringSecret Kms Key Id - admin
Username string - creation
Date string - db
Name string - default
Iam stringRole Arn - iam
Roles string[] - kms
Key stringId - log
Exports NamespaceLog Export[] - namespace
Arn string - namespace
Id string - namespace
Name string - status
Namespace
Status
- admin
Password StringSecret Arn - admin
Password StringSecret Kms Key Id - admin
Username String - creation
Date String - db
Name String - default
Iam StringRole Arn - iam
Roles List<String> - kms
Key StringId - log
Exports List<"useractivitylog" | "userlog" | "connectionlog"> - namespace
Arn String - namespace
Id String - namespace
Name String - status "AVAILABLE" | "MODIFYING" | "DELETING"
NamespaceLogExport
NamespaceSnapshotCopyConfiguration
- Destination
Region string - Destination
Kms stringKey Id - Snapshot
Retention intPeriod
- Destination
Region string - Destination
Kms stringKey Id - Snapshot
Retention intPeriod
- destination
Region String - destination
Kms StringKey Id - snapshot
Retention IntegerPeriod
- destination
Region string - destination
Kms stringKey Id - snapshot
Retention numberPeriod
- destination
Region String - destination
Kms StringKey Id - snapshot
Retention NumberPeriod
NamespaceStatus
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.