ecs

Documentation

Overview

Package ecs provides a client to retrieve Copilot ECS information.

Index

• type Client
  • func New(sess *session.Session) *Client
  • func (c Client) ClusterARN(app, env string) (string, error)
  • func (c Client) DescribeService(app, env, svc string) (*ServiceDesc, error)
  • func (c Client) ListActiveAppEnvTasks(opts ListActiveAppEnvTasksOpts) ([]*ecs.Task, error)
  • func (c Client) ListActiveDefaultClusterTasks(filter ListTasksFilter) ([]*ecs.Task, error)
  • func (c Client) NetworkConfiguration(app, env, svc string) (*ecs.NetworkConfiguration, error)
  • func (c Client) ServiceARN(app, env, svc string) (*ecs.ServiceArn, error)
  • func (c Client) StopDefaultClusterTasks(familyName string) error
  • func (c Client) StopOneOffTasks(app, env, family string) error
  • func (c Client) StopWorkloadTasks(app, env, workload string) error
  • func (c Client) TaskDefinition(app, env, svc string) (*ecs.TaskDefinition, error)
• type ListActiveAppEnvTasksOpts
• type ListTasksFilter
• type ServiceDesc

Types

type Client

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

Client retrieves Copilot information from ECS endpoint.

func New

func New(sess *session.Session) *Client

New inits a new Client.

func (Client) ClusterARN

func (c Client) ClusterARN(app, env string) (string, error)

ClusterARN returns the ARN of the cluster in an environment.

func (Client) DescribeService

func (c Client) DescribeService(app, env, svc string) (*ServiceDesc, error)

DescribeService returns the description of an ECS service given Copilot service info.

func (Client) ListActiveAppEnvTasks

func (c Client) ListActiveAppEnvTasks(opts ListActiveAppEnvTasksOpts) ([]*ecs.Task, error)

ListActiveAppEnvTasks returns the active Copilot tasks in the environment of an application.

func (Client) ListActiveDefaultClusterTasks

func (c Client) ListActiveDefaultClusterTasks(filter ListTasksFilter) ([]*ecs.Task, error)

ListActiveDefaultClusterTasks returns the active Copilot tasks in the default cluster.

func (Client) NetworkConfiguration

func (c Client) NetworkConfiguration(app, env, svc string) (*ecs.NetworkConfiguration, error)

NetworkConfiguration returns the network configuration of the service.

func (Client) ServiceARN

func (c Client) ServiceARN(app, env, svc string) (*ecs.ServiceArn, error)

ServiceARN returns the ARN of an ECS service created with Copilot.

func (Client) StopDefaultClusterTasks

func (c Client) StopDefaultClusterTasks(familyName string) error

StopDefaultClusterTasks stops all copilot tasks from the given family in the default cluster.

func (Client) StopOneOffTasks

func (c Client) StopOneOffTasks(app, env, family string) error

StopOneOffTasks stops all one-off tasks in the given application and environment with the family name.

func (Client) StopWorkloadTasks

func (c Client) StopWorkloadTasks(app, env, workload string) error

StopWorkloadTasks stops all tasks in the given application, enviornment, and workload.

func (Client) TaskDefinition

func (c Client) TaskDefinition(app, env, svc string) (*ecs.TaskDefinition, error)

TaskDefinition returns the task definition of the service.

type ListActiveAppEnvTasksOpts

type ListActiveAppEnvTasksOpts struct {
	App string
	Env string
	ListTasksFilter
}

ListActiveAppEnvTasksOpts contains the parameters for ListActiveAppEnvTasks.

type ListTasksFilter

type ListTasksFilter struct {
	TaskGroup   string // Returns only tasks with the given TaskGroup name.
	TaskID      string // Returns only tasks with the given ID.
	CopilotOnly bool   // Returns only tasks with the `copilot-task` tag.
}

ListTasksFilter contains the filtering parameters for listing Copilot tasks.

type ServiceDesc

type ServiceDesc struct {
	Name        string
	ClusterName string
	Tasks       []*ecs.Task
}

ServiceDesc contains the description of an ECS service.