AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getNamespace

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:

NamespaceName 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 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 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 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.

namespaceName 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:

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.

FinalSnapshotName string

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

FinalSnapshotRetentionPeriod int

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.

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

NamespaceValue Pulumi.AwsNative.RedshiftServerless.Outputs.Namespace
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.

FinalSnapshotName string

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

FinalSnapshotRetentionPeriod int

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.

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
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.

finalSnapshotName String

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

finalSnapshotRetentionPeriod 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.

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
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.

finalSnapshotName string

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

finalSnapshotRetentionPeriod number

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.

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
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.

final_snapshot_name str

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

final_snapshot_retention_period int

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.

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
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.

finalSnapshotName String

The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace

finalSnapshotRetentionPeriod Number

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.

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

Supporting Types

Namespace

NamespaceLogExport

NamespaceStatus

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0