metadata

Documentation

Overview

Package metadata provides clients for Metadata APIs exposed by the ECS agent. There are three versions of these APIs:

• V1: also called introspection endpoint.

• V2: available since ecs-agent 1.17.0 with the EC2 launch type and since platform version 1.1.0 with the Fargate launch type.

• V3: available since ecs-agent 1.21.0 with the EC2 launch type and since platform version 1.3.0 with the Faragate launch type.

Each of these versions sits in its own subpackage.

Index

• func V1() (*v1.Client, error)
• func V2() *v2.Client
• func V3(containerID string) (*v3.Client, error)
• func V3FromCurrentTask() (*v3.Client, error)

Functions

func V1

func V1() (*v1.Client, error)

V1 returns a client for the ECS metadata API v1, also called introspection endpoint, by detecting the endpoint address. Returns an error if it was not possible to detect the endpoint address.

func V2

func V2() *v2.Client

V2 returns a client for the ECS metadata API v2 that uses the default endpoint address.

func V3

func V3(containerID string) (*v3.Client, error)

V3 returns a client for the ECS metadata API v3 by detecting the endpoint address for the specified container. Returns an error if it was not possible to detect the endpoint address.

func V3FromCurrentTask

func V3FromCurrentTask() (*v3.Client, error)

V3FromCurrentTask returns a client for the ECS metadata API v3 by detedting the endpoint address from the task the executable is running in. Returns an error if it was not possible to detect the endpoint address.