Skip to main content

tcld account command reference

View Markdown

The tcld account command account operations.

Alias: a

get

The tcld account get command get account information.

Alias: g

list-regions

The tcld account list-regions command lists all regions where the account can provision namespaces.

Alias: l

metrics

The tcld account metrics command configures the metrics endpoint for the Temporal Cloud Account.

Alias: m

enable

The tcld account metrics enable command enables the metrics endpoint. CA Certificates must be configured prior to enabling the endpoint.

disable

The tcld account metrics disable command disables the metrics endpoint.

accepted-client-ca

The tcld account metrics accepted-client-ca command manages configuration of ca certificates for the external metrics endpoint.

Alias: ca

add

The tcld account metrics accepted-client-ca add command add a new ca accepted client ca certificate.

Alias: a

--request-id

The request-id to use for the asynchronous operation, if not set the server will assign one (optional)

Alias: r

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

--ca-certificate

The base64 encoded ca certificate

Alias: c

--ca-certificate-file

The path to the ca pem file

Alias: f

remove

The tcld account metrics accepted-client-ca remove command remove existing certificates.

Alias: r

--request-id

The request-id to use for the asynchronous operation, if not set the server will assign one (optional)

Alias: r

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

--ca-certificate

The base64 encoded ca certificate

Alias: c

--ca-certificate-file

The path to the ca pem file

Alias: f

--ca-certificate-fingerprint

The fingerprint of to the ca certificate

Alias: fp

set

The tcld account metrics accepted-client-ca set command set the accepted client ca certificate.

Alias: s

--request-id

The request-id to use for the asynchronous operation, if not set the server will assign one (optional)

Alias: r

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

--ca-certificate

The base64 encoded ca certificate

Alias: c

--ca-certificate-file

The path to the ca pem file

Alias: f

list

The tcld account metrics accepted-client-ca list command list the accepted client ca certificates currently configured for the account metrics endpoint.

Alias: l

audit-log

The tcld account audit-log command audit log commands.

Alias: al

kinesis

The tcld account audit-log kinesis command manage Kinesis audit log sink.

Alias: k

create

The tcld account audit-log kinesis create command create a kinesis audit log sink.

Alias: c

--sink-name

Provide a name for the sink

--role-name

The role name to use to write to the sink

Alias: rn

--destination-uri

The destination URI of the audit log sink

Alias: du

--region

The region to use for the request

Alias: re

validate

The tcld account audit-log kinesis validate command validate kinesis audit log sink.

Alias: v

--sink-name

Provide a name for the sink

--role-name

The role name to use to write to the sink

Alias: rn

--destination-uri

The destination URI of the audit log sink

Alias: du

--region

The region to use for the request

Alias: re

update

The tcld account audit-log kinesis update command update a kinesis audit log sink.

Alias: u

--sink-name

Provide a name for the sink

--enabled

Whether the sink is enabled

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

--role-name

The role name to use to write to the sink

Alias: rn

--destination-uri

The destination URI of the audit log sink

Alias: du

--region

The region to use for the request

Alias: re

get

The tcld account audit-log kinesis get command get audit log sink.

Alias: g

--sink-name

Provide a name for the sink

delete

The tcld account audit-log kinesis delete command delete audit log sink.

Alias: d

--sink-name

Provide a name for the sink

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

list

The tcld account audit-log kinesis list command list audit log sinks.

Alias: l

--page-size

The page size for list operations

--page-token

The page token for list operations

pubsub

The tcld account audit-log pubsub command manage PubSub audit log sink.

Alias: ps

create

The tcld account audit-log pubsub create command create a pubsub audit log sink.

Alias: c

--sink-name

Provide a name for the sink

--service-account-email

The service account email to impersonate to write to the sink

Alias: sae

--topic-name

The topic name to write to the sink

Alias: tn

validate

The tcld account audit-log pubsub validate command validate pubsub audit log sink.

Alias: v

--sink-name

Provide a name for the sink

--service-account-email

The service account email to impersonate to write to the sink

Alias: sae

--topic-name

The topic name to write to the sink

Alias: tn

update

The tcld account audit-log pubsub update command update a pubsub audit log sink.

Alias: u

--sink-name

Provide a name for the sink

--enabled

Whether the sink is enabled

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

--service-account-email

The service account email to impersonate to write to the sink

Alias: sae

--topic-name

The topic name to write to the sink

Alias: tn

get

The tcld account audit-log pubsub get command get audit log sink.

Alias: g

--sink-name

Provide a name for the sink

delete

The tcld account audit-log pubsub delete command delete audit log sink.

Alias: d

--sink-name

Provide a name for the sink

--resource-version

The resource-version (etag) to update from, if not set the cli will use the latest (optional)

Alias: v

list

The tcld account audit-log pubsub list command list audit log sinks.

Alias: l

--page-size

The page size for list operations

--page-token

The page token for list operations