Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. TatCommand
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.TatCommand

Explore with Pulumi AI

tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

Provides a resource to create a TAT command

Example Usage

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

const example = new tencentcloud.TatCommand("example", {
    commandName: "tf-example",
    commandType: "SHELL",
    content: `#!/bin/bash
if [ "(id -u)" != "0" ]; then
    echo "Please run this script as the root user." >&2
    exit 1
fi
ps aux

`,
    description: "Terraform demo.",
    tags: [{
        key: "createBy",
        value: "Terraform",
    }],
    timeout: 50,
    username: "root",
    workingDirectory: "/root",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.TatCommand("example",
    command_name="tf-example",
    command_type="SHELL",
    content="""#!/bin/bash
if [ "$(id -u)" != "0" ]; then
    echo "Please run this script as the root user." >&2
    exit 1
fi
ps aux

""",
    description="Terraform demo.",
    tags=[{
        "key": "createBy",
        "value": "Terraform",
    }],
    timeout=50,
    username="root",
    working_directory="/root")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewTatCommand(ctx, "example", &tencentcloud.TatCommandArgs{
			CommandName: pulumi.String("tf-example"),
			CommandType: pulumi.String("SHELL"),
			Content: pulumi.String(`#!/bin/bash
if [ "$(id -u)" != "0" ]; then
    echo "Please run this script as the root user." >&2
    exit 1
fi
ps aux

`),
			Description: pulumi.String("Terraform demo."),
			Tags: tencentcloud.TatCommandTagArray{
				&tencentcloud.TatCommandTagArgs{
					Key:   pulumi.String("createBy"),
					Value: pulumi.String("Terraform"),
				},
			},
			Timeout:          pulumi.Float64(50),
			Username:         pulumi.String("root"),
			WorkingDirectory: pulumi.String("/root"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.TatCommand("example", new()
    {
        CommandName = "tf-example",
        CommandType = "SHELL",
        Content = @"#!/bin/bash
if [ ""$(id -u)"" != ""0"" ]; then
    echo ""Please run this script as the root user."" >&2
    exit 1
fi
ps aux

",
        Description = "Terraform demo.",
        Tags = new[]
        {
            new Tencentcloud.Inputs.TatCommandTagArgs
            {
                Key = "createBy",
                Value = "Terraform",
            },
        },
        Timeout = 50,
        Username = "root",
        WorkingDirectory = "/root",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TatCommand;
import com.pulumi.tencentcloud.TatCommandArgs;
import com.pulumi.tencentcloud.inputs.TatCommandTagArgs;
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 TatCommand("example", TatCommandArgs.builder()
            .commandName("tf-example")
            .commandType("SHELL")
            .content("""
#!/bin/bash
if [ "$(id -u)" != "0" ]; then
    echo "Please run this script as the root user." >&2
    exit 1
fi
ps aux

            """)
            .description("Terraform demo.")
            .tags(TatCommandTagArgs.builder()
                .key("createBy")
                .value("Terraform")
                .build())
            .timeout(50)
            .username("root")
            .workingDirectory("/root")
            .build());

    }
}
Copy
resources:
  example:
    type: tencentcloud:TatCommand
    properties:
      commandName: tf-example
      commandType: SHELL
      content: |+
        #!/bin/bash
        if [ "$(id -u)" != "0" ]; then
            echo "Please run this script as the root user." >&2
            exit 1
        fi
        ps aux        

      description: Terraform demo.
      tags:
        - key: createBy
          value: Terraform
      timeout: 50
      username: root
      workingDirectory: /root
Copy

Create TatCommand Resource

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

Constructor syntax

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

@overload
def TatCommand(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               content: Optional[str] = None,
               command_name: Optional[str] = None,
               output_cos_bucket_url: Optional[str] = None,
               default_parameters: Optional[str] = None,
               description: Optional[str] = None,
               enable_parameter: Optional[bool] = None,
               command_type: Optional[str] = None,
               output_cos_key_prefix: Optional[str] = None,
               tags: Optional[Sequence[TatCommandTagArgs]] = None,
               tat_command_id: Optional[str] = None,
               timeout: Optional[float] = None,
               username: Optional[str] = None,
               working_directory: Optional[str] = None)
func NewTatCommand(ctx *Context, name string, args TatCommandArgs, opts ...ResourceOption) (*TatCommand, error)
public TatCommand(string name, TatCommandArgs args, CustomResourceOptions? opts = null)
public TatCommand(String name, TatCommandArgs args)
public TatCommand(String name, TatCommandArgs args, CustomResourceOptions options)

type: tencentcloud:TatCommand
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. TatCommandArgs
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. TatCommandArgs
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. TatCommandArgs
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. TatCommandArgs
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. TatCommandArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TatCommand 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 TatCommand resource accepts the following input properties:

CommandName This property is required. string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
Content This property is required. string
Command content. The maximum length is 64 KB.
CommandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
DefaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
Description string
Command description. The maximum length is 120 characters.
EnableParameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
OutputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
OutputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
Tags List<TatCommandTag>
Tags bound to the command. At most 10 tags are allowed.
TatCommandId string
ID of the resource.
Timeout double
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
Username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
WorkingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
CommandName This property is required. string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
Content This property is required. string
Command content. The maximum length is 64 KB.
CommandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
DefaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
Description string
Command description. The maximum length is 120 characters.
EnableParameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
OutputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
OutputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
Tags []TatCommandTagArgs
Tags bound to the command. At most 10 tags are allowed.
TatCommandId string
ID of the resource.
Timeout float64
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
Username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
WorkingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName This property is required. String
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
content This property is required. String
Command content. The maximum length is 64 KB.
commandType String
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
defaultParameters String
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description String
Command description. The maximum length is 120 characters.
enableParameter Boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
outputCosBucketUrl String
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix String
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags List<TatCommandTag>
Tags bound to the command. At most 10 tags are allowed.
tatCommandId String
ID of the resource.
timeout Double
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
username String
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory String
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName This property is required. string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
content This property is required. string
Command content. The maximum length is 64 KB.
commandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
defaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description string
Command description. The maximum length is 120 characters.
enableParameter boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
outputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags TatCommandTag[]
Tags bound to the command. At most 10 tags are allowed.
tatCommandId string
ID of the resource.
timeout number
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
command_name This property is required. str
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
content This property is required. str
Command content. The maximum length is 64 KB.
command_type str
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
default_parameters str
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description str
Command description. The maximum length is 120 characters.
enable_parameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
output_cos_bucket_url str
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
output_cos_key_prefix str
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags Sequence[TatCommandTagArgs]
Tags bound to the command. At most 10 tags are allowed.
tat_command_id str
ID of the resource.
timeout float
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
username str
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
working_directory str
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName This property is required. String
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
content This property is required. String
Command content. The maximum length is 64 KB.
commandType String
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
defaultParameters String
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description String
Command description. The maximum length is 120 characters.
enableParameter Boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
outputCosBucketUrl String
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix String
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags List<Property Map>
Tags bound to the command. At most 10 tags are allowed.
tatCommandId String
ID of the resource.
timeout Number
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
username String
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory String
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.

Outputs

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

CreatedBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
CreatedTime string
Command creation time.
FormattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedTime string
Command update time.
CreatedBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
CreatedTime string
Command creation time.
FormattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedTime string
Command update time.
createdBy String
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime String
Command creation time.
formattedDescription String
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
id String
The provider-assigned unique ID for this managed resource.
updatedTime String
Command update time.
createdBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime string
Command creation time.
formattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
id string
The provider-assigned unique ID for this managed resource.
updatedTime string
Command update time.
created_by str
Command creator. TAT indicates a public command and USER indicates a personal command.
created_time str
Command creation time.
formatted_description str
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
id str
The provider-assigned unique ID for this managed resource.
updated_time str
Command update time.
createdBy String
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime String
Command creation time.
formattedDescription String
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
id String
The provider-assigned unique ID for this managed resource.
updatedTime String
Command update time.

Look up Existing TatCommand Resource

Get an existing TatCommand 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?: TatCommandState, opts?: CustomResourceOptions): TatCommand
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        command_name: Optional[str] = None,
        command_type: Optional[str] = None,
        content: Optional[str] = None,
        created_by: Optional[str] = None,
        created_time: Optional[str] = None,
        default_parameters: Optional[str] = None,
        description: Optional[str] = None,
        enable_parameter: Optional[bool] = None,
        formatted_description: Optional[str] = None,
        output_cos_bucket_url: Optional[str] = None,
        output_cos_key_prefix: Optional[str] = None,
        tags: Optional[Sequence[TatCommandTagArgs]] = None,
        tat_command_id: Optional[str] = None,
        timeout: Optional[float] = None,
        updated_time: Optional[str] = None,
        username: Optional[str] = None,
        working_directory: Optional[str] = None) -> TatCommand
func GetTatCommand(ctx *Context, name string, id IDInput, state *TatCommandState, opts ...ResourceOption) (*TatCommand, error)
public static TatCommand Get(string name, Input<string> id, TatCommandState? state, CustomResourceOptions? opts = null)
public static TatCommand get(String name, Output<String> id, TatCommandState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:TatCommand    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:
CommandName string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
CommandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
Content string
Command content. The maximum length is 64 KB.
CreatedBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
CreatedTime string
Command creation time.
DefaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
Description string
Command description. The maximum length is 120 characters.
EnableParameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
FormattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
OutputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
OutputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
Tags List<TatCommandTag>
Tags bound to the command. At most 10 tags are allowed.
TatCommandId string
ID of the resource.
Timeout double
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
UpdatedTime string
Command update time.
Username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
WorkingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
CommandName string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
CommandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
Content string
Command content. The maximum length is 64 KB.
CreatedBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
CreatedTime string
Command creation time.
DefaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
Description string
Command description. The maximum length is 120 characters.
EnableParameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
FormattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
OutputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
OutputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
Tags []TatCommandTagArgs
Tags bound to the command. At most 10 tags are allowed.
TatCommandId string
ID of the resource.
Timeout float64
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
UpdatedTime string
Command update time.
Username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
WorkingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName String
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
commandType String
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
content String
Command content. The maximum length is 64 KB.
createdBy String
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime String
Command creation time.
defaultParameters String
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description String
Command description. The maximum length is 120 characters.
enableParameter Boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
formattedDescription String
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
outputCosBucketUrl String
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix String
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags List<TatCommandTag>
Tags bound to the command. At most 10 tags are allowed.
tatCommandId String
ID of the resource.
timeout Double
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
updatedTime String
Command update time.
username String
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory String
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName string
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
commandType string
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
content string
Command content. The maximum length is 64 KB.
createdBy string
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime string
Command creation time.
defaultParameters string
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description string
Command description. The maximum length is 120 characters.
enableParameter boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
formattedDescription string
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
outputCosBucketUrl string
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix string
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags TatCommandTag[]
Tags bound to the command. At most 10 tags are allowed.
tatCommandId string
ID of the resource.
timeout number
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
updatedTime string
Command update time.
username string
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory string
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
command_name str
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
command_type str
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
content str
Command content. The maximum length is 64 KB.
created_by str
Command creator. TAT indicates a public command and USER indicates a personal command.
created_time str
Command creation time.
default_parameters str
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description str
Command description. The maximum length is 120 characters.
enable_parameter bool
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
formatted_description str
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
output_cos_bucket_url str
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
output_cos_key_prefix str
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags Sequence[TatCommandTagArgs]
Tags bound to the command. At most 10 tags are allowed.
tat_command_id str
ID of the resource.
timeout float
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
updated_time str
Command update time.
username str
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
working_directory str
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.
commandName String
Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
commandType String
Command type. SHELL, POWERSHELL and BAT are supported. The default value is SHELL.
content String
Command content. The maximum length is 64 KB.
createdBy String
Command creator. TAT indicates a public command and USER indicates a personal command.
createdTime String
Command creation time.
defaultParameters String
The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided in the InvokeCommand API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
description String
Command description. The maximum length is 120 characters.
enableParameter Boolean
Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false.
formattedDescription String
Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
outputCosBucketUrl String
The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
outputCosKeyPrefix String
The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
tags List<Property Map>
Tags bound to the command. At most 10 tags are allowed.
tatCommandId String
ID of the resource.
timeout Number
Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
updatedTime String
Command update time.
username String
The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
workingDirectory String
Command execution path. The default value is /root for SHELL commands and C:/Program Files/qcloudtat_agent/workdir for POWERSHELL commands.

Supporting Types

TatCommandTag
, TatCommandTagArgs

Key This property is required. string
Tag key.
Value This property is required. string
Tag value.
Key This property is required. string
Tag key.
Value This property is required. string
Tag value.
key This property is required. String
Tag key.
value This property is required. String
Tag value.
key This property is required. string
Tag key.
value This property is required. string
Tag value.
key This property is required. str
Tag key.
value This property is required. str
Tag value.
key This property is required. String
Tag key.
value This property is required. String
Tag value.

Import

tat command can be imported using the id, e.g.

$ pulumi import tencentcloud:index/tatCommand:TatCommand example cmd-6fydo27j
Copy

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

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud