Global

Methods

inspect(optionsopt) → {Promise.<ECSTaskInformation>}

provides information about the ec2/ecs instance that a docker image is currently running from
Parameters:
Name Type Attributes Description
options Object <optional>
 additional options
Properties
Name Type Attributes Description
callback InspectHandler <optional>
 optional callback which will be called with the result or an error
Source:
Returns:
information about the current docker process on ecs
Type
Promise.<ECSTaskInformation>

Type Definitions

ECSTaskInformation

Type:
  • Object
Properties:
Name Type Attributes Description
arn string aws arn uniquely identifying the task
cluster string name of the cluster
dockerId string docker id
containerName string name of the container
publicHostname string <optional>
 public dns domain name of the ec2 instance (if available)
publicIpv4 string <optional>
 public ipv4 address of the ec2 instance (if available)
localHostname string <optional>
 private dns domain name of the ec2 instance (if available)
localIpv4 string <optional>
 private ipv4 address of the ec2 instance (if available)
ports Array.<ECSTaskInformationPortInfo> docker to host port mapping
Source:

ECSTaskInformationPortInfo

Type:
  • Object
Properties:
Name Type Description
protocol string protocol used e.g. tcp
container number port on the container side
host number port on the host side
Source:

InspectHandler(error, result)

Parameters:
Name Type Description
error Error | null error that may have occurred
result ECSTaskInformation result of the operation
Source: