volcenginecc.ecs.getCommand

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getCommand

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCommand(args: GetCommandArgs, opts?: InvokeOptions): Promise<GetCommandResult>
function getCommandOutput(args: GetCommandOutputArgs, opts?: InvokeOptions): Output<GetCommandResult>

def get_command(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCommandResult
def get_command_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCommandResult]

func LookupCommand(ctx *Context, args *LookupCommandArgs, opts ...InvokeOption) (*LookupCommandResult, error)
func LookupCommandOutput(ctx *Context, args *LookupCommandOutputArgs, opts ...InvokeOption) LookupCommandResultOutput

> Note: This function is named LookupCommand in the Go SDK.

public static class GetCommand 
{
    public static Task<GetCommandResult> InvokeAsync(GetCommandArgs args, InvokeOptions? opts = null)
    public static Output<GetCommandResult> Invoke(GetCommandInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCommandResult> getCommand(GetCommandArgs args, InvokeOptions options)
public static Output<GetCommandResult> getCommand(GetCommandArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:ecs/getCommand:getCommand
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getCommand Result

The following output properties are available:

CommandContent string: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
CommandId string: Custom command ID.
ContentEncoding string: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
CreatedTime string: Creation time.
Description string: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
EnableParameter bool: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
Id string: Uniquely identifies the resource.
InvocationTimes int: Number of times the command has been invoked.
Name string: Command name. Character length: 1~32. No restriction on special characters.
ParameterDefinitions List<Volcengine.GetCommandParameterDefinition>: Custom parameter definition information.
ProjectName string: Project to which the resource belongs. Each resource can belong to only one project.
ProviderName string: Command provider.
Tags List<Volcengine.GetCommandTag>: Tag key-value pair.
Timeout int: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
Type string: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
UpdatedTime string: Update time.
Username string: Username for executing the command.
WorkingDir string: Directory where the created command runs on ECS instances.

CommandContent string: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
CommandId string: Custom command ID.
ContentEncoding string: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
CreatedTime string: Creation time.
Description string: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
EnableParameter bool: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
Id string: Uniquely identifies the resource.
InvocationTimes int: Number of times the command has been invoked.
Name string: Command name. Character length: 1~32. No restriction on special characters.
ParameterDefinitions []GetCommandParameterDefinition: Custom parameter definition information.
ProjectName string: Project to which the resource belongs. Each resource can belong to only one project.
ProviderName string: Command provider.
Tags []GetCommandTag: Tag key-value pair.
Timeout int: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
Type string: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
UpdatedTime string: Update time.
Username string: Username for executing the command.
WorkingDir string: Directory where the created command runs on ECS instances.

commandContent String: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
commandId String: Custom command ID.
contentEncoding String: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
createdTime String: Creation time.
description String: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
enableParameter Boolean: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
id String: Uniquely identifies the resource.
invocationTimes Integer: Number of times the command has been invoked.
name String: Command name. Character length: 1~32. No restriction on special characters.
parameterDefinitions List<GetCommandParameterDefinition>: Custom parameter definition information.
projectName String: Project to which the resource belongs. Each resource can belong to only one project.
providerName String: Command provider.
tags List<GetCommandTag>: Tag key-value pair.
timeout Integer: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
type String: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
updatedTime String: Update time.
username String: Username for executing the command.
workingDir String: Directory where the created command runs on ECS instances.

commandContent string: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
commandId string: Custom command ID.
contentEncoding string: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
createdTime string: Creation time.
description string: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
enableParameter boolean: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
id string: Uniquely identifies the resource.
invocationTimes number: Number of times the command has been invoked.
name string: Command name. Character length: 1~32. No restriction on special characters.
parameterDefinitions GetCommandParameterDefinition[]: Custom parameter definition information.
projectName string: Project to which the resource belongs. Each resource can belong to only one project.
providerName string: Command provider.
tags GetCommandTag[]: Tag key-value pair.
timeout number: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
type string: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
updatedTime string: Update time.
username string: Username for executing the command.
workingDir string: Directory where the created command runs on ECS instances.

command_content str: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
command_id str: Custom command ID.
content_encoding str: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
created_time str: Creation time.
description str: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
enable_parameter bool: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
id str: Uniquely identifies the resource.
invocation_times int: Number of times the command has been invoked.
name str: Command name. Character length: 1~32. No restriction on special characters.
parameter_definitions Sequence[GetCommandParameterDefinition]: Custom parameter definition information.
project_name str: Project to which the resource belongs. Each resource can belong to only one project.
provider_name str: Command provider.
tags Sequence[GetCommandTag]: Tag key-value pair.
timeout int: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
type str: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
updated_time str: Update time.
username str: Username for executing the command.
working_dir str: Directory where the created command runs on ECS instances.

commandContent String: Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.
commandId String: Custom command ID.
contentEncoding String: Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.
createdTime String: Creation time.
description String: Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.
enableParameter Boolean: Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.
id String: Uniquely identifies the resource.
invocationTimes Number: Number of times the command has been invoked.
name String: Command name. Character length: 1~32. No restriction on special characters.
parameterDefinitions List<Property Map>: Custom parameter definition information.
projectName String: Project to which the resource belongs. Each resource can belong to only one project.
providerName String: Command provider.
tags List<Property Map>: Tag key-value pair.
timeout Number: Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.
type String: Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.
updatedTime String: Update time.
username String: Username for executing the command.
workingDir String: Directory where the created command runs on ECS instances.

Supporting Types

GetCommandParameterDefinition

DecimalPrecision int: Allowed decimal places for custom parameter (number).
DefaultValue string: Default value for custom parameter.
MaxLength int: Maximum length for custom parameter (string).
MaxValue string: Maximum value for custom parameter (number).
MinLength int: Minimum length for custom parameter (string).
MinValue string: Minimum value for custom parameter (number).
Name string: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
Required bool: Whether it is required.
Type string: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

DecimalPrecision int: Allowed decimal places for custom parameter (number).
DefaultValue string: Default value for custom parameter.
MaxLength int: Maximum length for custom parameter (string).
MaxValue string: Maximum value for custom parameter (number).
MinLength int: Minimum length for custom parameter (string).
MinValue string: Minimum value for custom parameter (number).
Name string: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
Required bool: Whether it is required.
Type string: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

decimalPrecision Integer: Allowed decimal places for custom parameter (number).
defaultValue String: Default value for custom parameter.
maxLength Integer: Maximum length for custom parameter (string).
maxValue String: Maximum value for custom parameter (number).
minLength Integer: Minimum length for custom parameter (string).
minValue String: Minimum value for custom parameter (number).
name String: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
required Boolean: Whether it is required.
type String: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

decimalPrecision number: Allowed decimal places for custom parameter (number).
defaultValue string: Default value for custom parameter.
maxLength number: Maximum length for custom parameter (string).
maxValue string: Maximum value for custom parameter (number).
minLength number: Minimum length for custom parameter (string).
minValue string: Minimum value for custom parameter (number).
name string: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
required boolean: Whether it is required.
type string: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

decimal_precision int: Allowed decimal places for custom parameter (number).
default_value str: Default value for custom parameter.
max_length int: Maximum length for custom parameter (string).
max_value str: Maximum value for custom parameter (number).
min_length int: Minimum length for custom parameter (string).
min_value str: Minimum value for custom parameter (number).
name str: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
required bool: Whether it is required.
type str: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

decimalPrecision Number: Allowed decimal places for custom parameter (number).
defaultValue String: Default value for custom parameter.
maxLength Number: Maximum length for custom parameter (string).
maxValue String: Maximum value for custom parameter (number).
minLength Number: Minimum length for custom parameter (string).
minValue String: Minimum value for custom parameter (number).
name String: Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.
required Boolean: Whether it is required.
type String: Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).

GetCommandTag

Key string: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
Value string: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

Key string: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
Value string: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key String: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value String: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key string: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value string: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key str: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value str: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key String: User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value String: User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.