tcld namespace command reference
The tcld namespace
commands enable Namespace operations in Temporal Cloud.
Alias: n
- tcld namespace create
- tcld namespace delete
- tcld namespace get
- tcld namespace list
- tcld namespace export
- tcld namespace accepted-client-ca
- tcld namespace certificate-filters
- tcld namespace search-attributes
- tcld namespace retention
- tcld namespace update-codec-server
create
The tcld namespace create
command creates a Temporal Namespace in Temporal Cloud.
Alias: c
tcld namespace create
The following modifiers control the behavior of the command.
--request-id
The request identifier to use for the asynchronous operation. If not set, the server assigns an identifier.
Alias: -r
--ca-certificate
Required modifier unless --ca-certificate-file
is specified
A base64-encoded CA certificate.
If both --ca-certificate
and --ca-certificate-file
are specified, only --ca-certificate
is used.
Alias: -c
--namespace
Required modifier
Specify the name of the Namespace to create.
Alias: -n
--region
Required modifier
The region to create the Namespace in.
Valid options: ap-northeast-1
| ap-southeast-1
| ap-southeast-2
| ca-central-1
| eu-central-1
| eu-west-1
| eu-west-2
| us-east-1
| us-west-2
Alias: --re
--retention-days
The number of days that data about closed Workflow Executions will be retained (default: 30).
Alias: --rd
--ca-certificate-file
Required modifier unless --ca-certificate
is specified
A path to a CA certificate PEM file.
If both --ca-certificate
and --ca-certificate-file
are specified, only --ca-certificate
is used.
Alias: --cf
--certificate-filter-file
Required modifier unless --certificate-filter-input
is specified
Path to a JSON file that defines the certificate filters to be applied to the Namespace. The specified filters replace any existing filters.
Sample JSON: { "filters": [ { "commonName": "test1" } ] }
If both --certificate-filter-file
and --certificate-filter-input
are specified, the command returns an error.
Alias: --cff
--certificate-filter-input
Required modifier unless --certificate-filter-file
is specified
A JSON string that defines the certificate filters to be applied to the Namespace. The specified filters replace any existing filters.
Sample JSON: { "filters": [ { "commonName": "test1" } ] }
If both --certificate-filter-input
and --certificate-filter-file
are specified, the command returns an error.
Alias: --cfi
--search-attribute
Required modifier; can be specified more than once
A custom Search Attribute in the form _name_=_type_
.
Valid values for type: Bool
| Datetime
| Double
| Int
| Keyword
| Text
Alias: --sa
--user-namespace-permission
Can be specified more than once
A Namespace-level permission for a user in the form _email_=_permission_
.
Valid values for permission: Admin
| Write
| Read
Alias: -p
--endpoint
The codec server endpoint to decode payloads for all users interacting with this Namespace. Must be HTTPS.
Alias: -e
--pass-access-token
Pass the user access token to the remote endpoint (default: false).
Alias: --pat
--include-credentials
Include cross-origin credentials (default: false).
Alias: --ic
Example
tcld namespace create --namespace <namespace_id> --region us-west-2 --retention-days 60 --certificate-filter-input '{"filters": [{"commonName": "test1"}]}' --user-namespace-permission "user@example.com=Admin" --search-attribute "customer_id=Int" --search-attribute "customer_name=Text" --endpoint "https://test-codec-server.com" --pass-access-token --include-credentials
delete
The tcld namespace delete
command deletes the specified Namespace in Temporal Cloud.
Alias: d
tcld namespace delete
The following modifiers control the behavior of the command.
--namespace
Required modifier
Specify the Namespace hosted on Temporal Cloud to be deleted.
Alias: -n
--request-id
The request identifier to use for the asynchronous operation. If not set, the server assigns an identifier.
Alias: -r
--resource-version
A resource version (ETag) to update from. If not set, the CLI uses the latest.
Alias: -v
Example
tcld namespace delete --namespace <namespace_id>
get
The tcld namespace get
command gets information about the specified Namespace in Temporal Cloud.
Alias: g
tcld namespace get
The following modifier controls the behavior of the command.
--namespace
Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.
Alias: -n
Example
tcld namespace get --namespace <namespace_id>
list
The tcld namespace list
command lists all Namespaces in Temporal Cloud.
Alias: l
tcld namespace list
The command has no modifiers.
export
The tcld namespace export s3
commands manage Workflow History Exports.
Valid options: s3
Alias: es
- tcld namespace export s3 create
- tcld namespace export s3 get
- tcld namespace export s3 delete
- tcld namespace export s3 list
- tcld namespace export s3 update
- tcld namespace export s3 validate
create
The tcld namespace export s3 create
command allows users to create an export sink for the Namespace of a Temporal Cloud account.
Example
tcld namespace export s3 create --namespace <namespace_id> --sink-name <sink_name> --s3-bucket-name <bucket_name> --role-arn <role_arn>
The following modifiers control the behavior of the command.
--namespace
Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.
Alias: -n
Required modifier
--sink-name
Provide a name for the export sink.
Required modifier
--role-arn
Provide role arn for the IAM Role.
Required modifier
--s3-bucket-name
Provide the name of an AWS S3 bucket that Temporal will send closed workflow histories to.
Required modifier
--request-id
Specify a request identifier to use for the asynchronous operation. If not specified, the server assigns a request identifier.
Alias: -r
--kms-arn
Provide the ARN of the KMS key to use for encryption. Note: If the KMS ARN needs to be added or updated, users should create the IAM Role with KMS or modify the created IAM Role accordingly. Providing it as part of the input won't help.
get
The tcld namespace export s3 get
command allows users to retrieve details about an existing export sink from the Namespace of a Temporal Cloud account.
Example
tcld namespace export s3 get --namespace <namespace_id> --sink-name <sink_name>
The following modifiers control the behavior of the command.
--namespace
Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.
Alias: -n
Required modifier
--sink-name
Provide the name of the export sink you wish to retrieve details for.
Required modifier
delete
The tcld namespace export s3 delete
command allows users to delete an existing export sink from the Namespace of a Temporal Cloud account.
Example
tcld namespace export s3 delete --namespace <namespace_id> --sink-name <sink_name>
The following modifiers control the behavior of the command.
--namespace
Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.
Alias: -n
Required modifier
--sink-name
Provide the name of the export sink you wish to delete.
Required modifier
--resource-version
Specify a resource version (ETag) to delete from. If not specified, the CLI will use the latest version.
Alias: -v
--request-id
Specify a request identifier to use for the asynchronous operation. If not specified, the server assigns a request identifier.
Alias: -r
list
The tcld namespace export s3 list
command allows users to list all existing export sinks within the Namespace of a Temporal Cloud account.
Example
tcld namespace export s3 list --namespace <namespace_id>
The following modifiers control the behavior of the command.
--namespace
Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.
Alias: -n
Required modifier
--page-size
Determine the number of results to return per page for list operations. If not specified, the default value is 100.
--page-token
Provide the page token to continue listing results from where the previous list operation left off.
update
The tcld namespace export s3 update
command allows users to modify the details of an existing export sink within the Namespace of a Temporal Cloud account.
Example
tcld namespace export s3 update --namespace <namespace_id> --sink-name <sink_name> --enabled true
The following modifiers control the behavior of the command.