Class: Aws::ECS::Types::ExecuteCommandRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ExecuteCommandRequest data as a hash:

{
  cluster: "String",
  container: "String",
  command: "String", # required
  interactive: false, # required
  task: "String", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)

5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/aws-sdk-ecs/types.rb', line 5010

class ExecuteCommandRequest < Struct.new(
  :cluster,
  :container,
  :command,
  :interactive,
  :task)
  SENSITIVE = []
  include Aws::Structure
end

#commandString

The command to run on the container.

Returns:

  • (String)

5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/aws-sdk-ecs/types.rb', line 5010

class ExecuteCommandRequest < Struct.new(
  :cluster,
  :container,
  :command,
  :interactive,
  :task)
  SENSITIVE = []
  include Aws::Structure
end

#containerString

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

Returns:

  • (String)

5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/aws-sdk-ecs/types.rb', line 5010

class ExecuteCommandRequest < Struct.new(
  :cluster,
  :container,
  :command,
  :interactive,
  :task)
  SENSITIVE = []
  include Aws::Structure
end

#interactiveBoolean

Use this flag to run your command in interactive mode.

Returns:

  • (Boolean)

5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/aws-sdk-ecs/types.rb', line 5010

class ExecuteCommandRequest < Struct.new(
  :cluster,
  :container,
  :command,
  :interactive,
  :task)
  SENSITIVE = []
  include Aws::Structure
end

#taskString

The Amazon Resource Name (ARN) or ID of the task the container is part of.

Returns:

  • (String)

5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/aws-sdk-ecs/types.rb', line 5010

class ExecuteCommandRequest < Struct.new(
  :cluster,
  :container,
  :command,
  :interactive,
  :task)
  SENSITIVE = []
  include Aws::Structure
end