Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. Namespace
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.Namespace

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS QuickSight Namespace.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Namespace("example", {namespace: "example"});
Copy
import pulumi
import pulumi_aws as aws

example = aws.quicksight.Namespace("example", namespace="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewNamespace(ctx, "example", &quicksight.NamespaceArgs{
			Namespace: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.Namespace("example", new()
    {
        NameSpace = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Namespace;
import com.pulumi.aws.quicksight.NamespaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Namespace("example", NamespaceArgs.builder()
            .namespace("example")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:quicksight:Namespace
    properties:
      namespace: example
Copy

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: NamespaceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Namespace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              namespace: Optional[str] = None,
              aws_account_id: Optional[str] = None,
              identity_store: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              timeouts: Optional[NamespaceTimeoutsArgs] = None)
func NewNamespace(ctx *Context, name string, args NamespaceArgs, opts ...ResourceOption) (*Namespace, error)
public Namespace(string name, NamespaceArgs args, CustomResourceOptions? opts = null)
public Namespace(String name, NamespaceArgs args)
public Namespace(String name, NamespaceArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. NamespaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NamespaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var namespaceResource = new Aws.Quicksight.Namespace("namespaceResource", new()
{
    NameSpace = "string",
    AwsAccountId = "string",
    IdentityStore = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Quicksight.Inputs.NamespaceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});
Copy
example, err := quicksight.NewNamespace(ctx, "namespaceResource", &quicksight.NamespaceArgs{
	Namespace:     pulumi.String("string"),
	AwsAccountId:  pulumi.String("string"),
	IdentityStore: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &quicksight.NamespaceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})
Copy
var namespaceResource = new com.pulumi.aws.quicksight.Namespace("namespaceResource", com.pulumi.aws.quicksight.NamespaceArgs.builder()
    .namespace("string")
    .awsAccountId("string")
    .identityStore("string")
    .tags(Map.of("string", "string"))
    .timeouts(NamespaceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());
Copy
namespace_resource = aws.quicksight.Namespace("namespaceResource",
    namespace="string",
    aws_account_id="string",
    identity_store="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })
Copy
const namespaceResource = new aws.quicksight.Namespace("namespaceResource", {
    namespace: "string",
    awsAccountId: "string",
    identityStore: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});
Copy
type: aws:quicksight:Namespace
properties:
    awsAccountId: string
    identityStore: string
    namespace: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Namespace resource accepts the following input properties:

NameSpace This property is required. string

Name of the namespace.

The following arguments are optional:

AwsAccountId string
AWS account ID.
IdentityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
Tags Dictionary<string, string>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timeouts NamespaceTimeouts
Namespace This property is required. string

Name of the namespace.

The following arguments are optional:

AwsAccountId string
AWS account ID.
IdentityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
Tags map[string]string
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timeouts NamespaceTimeoutsArgs
namespace This property is required. String

Name of the namespace.

The following arguments are optional:

awsAccountId String
AWS account ID.
identityStore String
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
tags Map<String,String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts NamespaceTimeouts
namespace This property is required. string

Name of the namespace.

The following arguments are optional:

awsAccountId string
AWS account ID.
identityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
tags {[key: string]: string}
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts NamespaceTimeouts
namespace This property is required. str

Name of the namespace.

The following arguments are optional:

aws_account_id str
AWS account ID.
identity_store str
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
tags Mapping[str, str]
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts NamespaceTimeoutsArgs
namespace This property is required. String

Name of the namespace.

The following arguments are optional:

awsAccountId String
AWS account ID.
identityStore String
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
tags Map<String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timeouts Property Map

Outputs

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

Arn string
ARN of the Namespace.
CapacityRegion string
Namespace AWS Region.
CreationStatus string
Creation status of the namespace.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
ARN of the Namespace.
CapacityRegion string
Namespace AWS Region.
CreationStatus string
Creation status of the namespace.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the Namespace.
capacityRegion String
Namespace AWS Region.
creationStatus String
Creation status of the namespace.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
ARN of the Namespace.
capacityRegion string
Namespace AWS Region.
creationStatus string
Creation status of the namespace.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
ARN of the Namespace.
capacity_region str
Namespace AWS Region.
creation_status str
Creation status of the namespace.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the Namespace.
capacityRegion String
Namespace AWS Region.
creationStatus String
Creation status of the namespace.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Namespace Resource

Get an existing Namespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NamespaceState, opts?: CustomResourceOptions): Namespace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        capacity_region: Optional[str] = None,
        creation_status: Optional[str] = None,
        identity_store: Optional[str] = None,
        namespace: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[NamespaceTimeoutsArgs] = None) -> Namespace
func GetNamespace(ctx *Context, name string, id IDInput, state *NamespaceState, opts ...ResourceOption) (*Namespace, error)
public static Namespace Get(string name, Input<string> id, NamespaceState? state, CustomResourceOptions? opts = null)
public static Namespace get(String name, Output<String> id, NamespaceState state, CustomResourceOptions options)
resources:  _:    type: aws:quicksight:Namespace    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
ARN of the Namespace.
AwsAccountId string
AWS account ID.
CapacityRegion string
Namespace AWS Region.
CreationStatus string
Creation status of the namespace.
IdentityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
NameSpace string

Name of the namespace.

The following arguments are optional:

Tags Dictionary<string, string>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Timeouts NamespaceTimeouts
Arn string
ARN of the Namespace.
AwsAccountId string
AWS account ID.
CapacityRegion string
Namespace AWS Region.
CreationStatus string
Creation status of the namespace.
IdentityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
Namespace string

Name of the namespace.

The following arguments are optional:

Tags map[string]string
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Timeouts NamespaceTimeoutsArgs
arn String
ARN of the Namespace.
awsAccountId String
AWS account ID.
capacityRegion String
Namespace AWS Region.
creationStatus String
Creation status of the namespace.
identityStore String
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
namespace String

Name of the namespace.

The following arguments are optional:

tags Map<String,String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts NamespaceTimeouts
arn string
ARN of the Namespace.
awsAccountId string
AWS account ID.
capacityRegion string
Namespace AWS Region.
creationStatus string
Creation status of the namespace.
identityStore string
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
namespace string

Name of the namespace.

The following arguments are optional:

tags {[key: string]: string}
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts NamespaceTimeouts
arn str
ARN of the Namespace.
aws_account_id str
AWS account ID.
capacity_region str
Namespace AWS Region.
creation_status str
Creation status of the namespace.
identity_store str
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
namespace str

Name of the namespace.

The following arguments are optional:

tags Mapping[str, str]
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts NamespaceTimeoutsArgs
arn String
ARN of the Namespace.
awsAccountId String
AWS account ID.
capacityRegion String
Namespace AWS Region.
creationStatus String
Creation status of the namespace.
identityStore String
User identity directory type. Defaults to QUICKSIGHT, the only current valid value.
namespace String

Name of the namespace.

The following arguments are optional:

tags Map<String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

timeouts Property Map

Supporting Types

NamespaceTimeouts
, NamespaceTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Import

Using pulumi import, import QuickSight Namespace using the AWS account ID and namespace separated by commas (,). For example:

$ pulumi import aws:quicksight/namespace:Namespace example 123456789012,example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws