ecs

Documentation

Overview

Package ecs provides a client to make API requests to Amazon Elastic Container Service.

Index

• type ECS
  • func New(s *session.Session) *ECS
  • func (e *ECS) Service(clusterName, serviceName string) (*Service, error)
  • func (e *ECS) ServiceTasks(clusterName, serviceName string) ([]*Task, error)
  • func (e *ECS) TaskDefinition(taskDefName string) (*TaskDefinition, error)
• type Image
• type Service
  • func (s *Service) ServiceStatus() ServiceStatus
• type ServiceArn
  • func (s *ServiceArn) ClusterName() (string, error)
  • func (s *ServiceArn) ServiceName() (string, error)
• type ServiceStatus
• type Task
  • func (t *Task) TaskStatus() (*TaskStatus, error)
• type TaskDefinition
  • func (t *TaskDefinition) EnvironmentVariables() map[string]string
• type TaskStatus
  • func (t TaskStatus) HumanString() string

Types

type ECS

type ECS struct {
	// contains filtered or unexported fields
}

ECS wraps an AWS ECS client.

func New

func New(s *session.Session) *ECS

New returns a Service configured against the input session.

func (*ECS) Service

func (e *ECS) Service(clusterName, serviceName string) (*Service, error)

Service calls ECS API and returns the specified service running in the cluster.

func (*ECS) ServiceTasks

func (e *ECS) ServiceTasks(clusterName, serviceName string) ([]*Task, error)

ServiceTasks calls ECS API and returns ECS tasks running in the cluster.

func (*ECS) TaskDefinition

func (e *ECS) TaskDefinition(taskDefName string) (*TaskDefinition, error)

TaskDefinition calls ECS API and returns the task definition.

type Image

type Image struct {
	ID     string
	Digest string
}

Image contains very basic info of a container image.

type Service

type Service ecs.Service

Service wraps up ECS Service struct.

func (*Service) ServiceStatus

func (s *Service) ServiceStatus() ServiceStatus

ServiceStatus returns the status of the running service.

type ServiceArn

type ServiceArn string

ServiceArn is the arn of an ECS service.

func (*ServiceArn) ClusterName

func (s *ServiceArn) ClusterName() (string, error)

ClusterName returns the cluster name. For example: arn:aws:ecs:us-west-2:1234567890:service/my-project-test-Cluster-9F7Y0RLP60R7/my-project-test-my-app-Service-JSOH5GYBFAIB will return my-project-test-Cluster-9F7Y0RLP60R7

func (*ServiceArn) ServiceName

func (s *ServiceArn) ServiceName() (string, error)

ServiceName returns the service name. For example: arn:aws:ecs:us-west-2:1234567890:service/my-project-test-Cluster-9F7Y0RLP60R7/my-project-test-my-app-Service-JSOH5GYBFAIB will return my-project-test-my-app-Service-JSOH5GYBFAIB

type ServiceStatus

type ServiceStatus struct {
	DesiredCount     int64  `json:"desiredCount"`
	RunningCount     int64  `json:"runningCount"`
	Status           string `json:"status"`
	LastDeploymentAt int64  `json:"lastDeploymentAt"`
	TaskDefinition   string `json:"taskDefinition"`
}

ServiceStatus contains the status info of a service.

type Task

type Task ecs.Task

Task wraps up ECS Task struct.

func (*Task) TaskStatus

func (t *Task) TaskStatus() (*TaskStatus, error)

TaskStatus returns the status of the running task.

type TaskDefinition

type TaskDefinition ecs.TaskDefinition

TaskDefinition wraps up ECS TaskDefinition struct.

func (*TaskDefinition) EnvironmentVariables

func (t *TaskDefinition) EnvironmentVariables() map[string]string

EnvironmentVariables returns environment variables of the task definition.

type TaskStatus

type TaskStatus struct {
	Health        string  `json:"health"`
	ID            string  `json:"id"`
	Images        []Image `json:"images"`
	LastStatus    string  `json:"lastStatus"`
	StartedAt     int64   `json:"startedAt"`
	StoppedAt     int64   `json:"stoppedAt"`
	StoppedReason string  `json:"stoppedReason"`
}

TaskStatus contains the status info of a task.

func (TaskStatus) HumanString

func (t TaskStatus) HumanString() string

HumanString returns the stringified TaskStatus struct with human readable format. Example output:

6ca7a60d          f884127d            RUNNING             UNKNOWN             19 hours ago        -