Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. redshiftserverless
  5. Namespace

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.redshiftserverless.Namespace

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::RedshiftServerless::Namespace Resource Type

    Create Namespace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Namespace(name: string, args?: NamespaceArgs, opts?: CustomResourceOptions);
    @overload
def Namespace(resource_name: str,
              args: Optional[NamespaceArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Namespace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              admin_password_secret_kms_key_id: Optional[str] = None,
              admin_user_password: Optional[str] = None,
              admin_username: Optional[str] = None,
              db_name: Optional[str] = None,
              default_iam_role_arn: Optional[str] = None,
              final_snapshot_name: Optional[str] = None,
              final_snapshot_retention_period: Optional[int] = None,
              iam_roles: Optional[Sequence[str]] = None,
              kms_key_id: Optional[str] = None,
              log_exports: Optional[Sequence[NamespaceLogExport]] = None,
              manage_admin_password: Optional[bool] = None,
              namespace_name: Optional[str] = None,
              namespace_resource_policy: Optional[Any] = None,
              redshift_idc_application_arn: Optional[str] = None,
              snapshot_copy_configurations: Optional[Sequence[NamespaceSnapshotCopyConfigurationArgs]] = None,
              tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewNamespace(ctx *Context, name string, args *NamespaceArgs, opts ...ResourceOption) (*Namespace, error)
    public Namespace(string name, NamespaceArgs? args = null, CustomResourceOptions? opts = null)
    public Namespace(String name, NamespaceArgs args)
public Namespace(String name, NamespaceArgs args, CustomResourceOptions options)

    type: aws-native:redshiftserverless:Namespace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NamespaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const namespaceResource = new aws_native.redshiftserverless.Namespace("namespaceResource", {
    adminPasswordSecretKmsKeyId: "string",
    adminUserPassword: "string",
    adminUsername: "string",
    dbName: "string",
    defaultIamRoleArn: "string",
    finalSnapshotName: "string",
    finalSnapshotRetentionPeriod: 0,
    iamRoles: ["string"],
    kmsKeyId: "string",
    logExports: [aws_native.redshiftserverless.NamespaceLogExport.Useractivitylog],
    manageAdminPassword: false,
    namespaceName: "string",
    namespaceResourcePolicy: "any",
    redshiftIdcApplicationArn: "string",
    snapshotCopyConfigurations: [{
        destinationRegion: "string",
        destinationKmsKeyId: "string",
        snapshotRetentionPeriod: 0,
    }],
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    Namespace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Namespace resource accepts the following input properties:

    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.
    AdminUserPassword 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.
    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
    ManageAdminPassword bool
    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.
    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.
    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.

    RedshiftIdcApplicationArn string
    The ARN for the Redshift application that integrates with IAM Identity Center.
    SnapshotCopyConfigurations List<Pulumi.AwsNative.RedshiftServerless.Inputs.NamespaceSnapshotCopyConfiguration>
    The snapshot copy configurations for the namespace.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    The list of tags 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.
    AdminUserPassword 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.
    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
    ManageAdminPassword bool
    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.
    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.
    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.

    RedshiftIdcApplicationArn string
    The ARN for the Redshift application that integrates with IAM Identity Center.
    SnapshotCopyConfigurations []NamespaceSnapshotCopyConfigurationArgs
    The snapshot copy configurations for the namespace.
    Tags CreateOnlyTagArgs
    The list of tags 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.
    adminUserPassword 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.
    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
    manageAdminPassword 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.
    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.
    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.

    redshiftIdcApplicationArn String
    The ARN for the Redshift application that integrates with IAM Identity Center.
    snapshotCopyConfigurations List<NamespaceSnapshotCopyConfiguration>
    The snapshot copy configurations for the namespace.
    tags List<CreateOnlyTag>
    The list of tags 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.
    adminUserPassword 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.
    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
    manageAdminPassword 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.
    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.
    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.

    redshiftIdcApplicationArn string
    The ARN for the Redshift application that integrates with IAM Identity Center.
    snapshotCopyConfigurations NamespaceSnapshotCopyConfiguration[]
    The snapshot copy configurations for the namespace.
    tags CreateOnlyTag[]
    The list of tags 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_user_password str
    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 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
    manage_admin_password bool
    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_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_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.

    redshift_idc_application_arn str
    The ARN for the Redshift application that integrates with IAM Identity Center.
    snapshot_copy_configurations Sequence[NamespaceSnapshotCopyConfigurationArgs]
    The snapshot copy configurations for the namespace.
    tags Sequence[CreateOnlyTagArgs]
    The list of tags 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.
    adminUserPassword 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.
    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
    manageAdminPassword 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.
    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.
    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.

    redshiftIdcApplicationArn String
    The ARN for the Redshift application that integrates with IAM Identity Center.
    snapshotCopyConfigurations List<Property Map>
    The snapshot copy configurations for the namespace.
    tags List<Property Map>
    The list of tags for the namespace.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Namespace resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    NamespaceValue Pulumi.AwsNative.RedshiftServerless.Outputs.Namespace
    Definition of Namespace resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Namespace NamespaceType
    Definition of Namespace resource.
    id String
    The provider-assigned unique ID for this managed resource.
    namespace Namespace
    Definition of Namespace resource.
    id string
    The provider-assigned unique ID for this managed resource.
    namespace Namespace
    Definition of Namespace resource.
    id str
    The provider-assigned unique ID for this managed resource.
    namespace Namespace
    Definition of Namespace resource.
    id String
    The provider-assigned unique ID for this managed resource.
    namespace Property Map
    Definition of Namespace resource.

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Namespace, NamespaceArgs

    NamespaceLogExport, NamespaceLogExportArgs

    Useractivitylog
    useractivitylog
    Userlog
    userlog
    Connectionlog
    connectionlog
    NamespaceLogExportUseractivitylog
    useractivitylog
    NamespaceLogExportUserlog
    userlog
    NamespaceLogExportConnectionlog
    connectionlog
    Useractivitylog
    useractivitylog
    Userlog
    userlog
    Connectionlog
    connectionlog
    Useractivitylog
    useractivitylog
    Userlog
    userlog
    Connectionlog
    connectionlog
    USERACTIVITYLOG
    useractivitylog
    USERLOG
    userlog
    CONNECTIONLOG
    connectionlog
    "useractivitylog"
    useractivitylog
    "userlog"
    userlog
    "connectionlog"
    connectionlog

    NamespaceSnapshotCopyConfiguration, NamespaceSnapshotCopyConfigurationArgs

    NamespaceStatus, NamespaceStatusArgs

    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    NamespaceStatusAvailable
    AVAILABLE
    NamespaceStatusModifying
    MODIFYING
    NamespaceStatusDeleting
    DELETING
    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    AVAILABLE
    AVAILABLE
    MODIFYING
    MODIFYING
    DELETING
    DELETING
    "AVAILABLE"
    AVAILABLE
    "MODIFYING"
    MODIFYING
    "DELETING"
    DELETING

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native