awsutil

Documentation

Index

• Constants
• func GetAWSRegion() string
• func NewSession(meta ECSTaskMeta, userAgentCaller string) (*session.Session, error)
• func ParseTaskID(taskArn string) string
• func UserAgentHandler(caller string) request.NamedHandler
• type ECSTaskMeta
  • func ECSTaskMetadata() (ECSTaskMeta, error)
  • func (e ECSTaskMeta) AccountID() (string, error)
  • func (e ECSTaskMeta) ClusterARN() (string, error)
  • func (e ECSTaskMeta) HasContainerStopped(name string) bool
  • func (e ECSTaskMeta) NodeIP() string
  • func (e ECSTaskMeta) Region() (string, error)
  • func (e ECSTaskMeta) TaskID() string
• type ECSTaskMetaContainer
  • func (c ECSTaskMetaContainer) HasStopped() bool
  • func (c ECSTaskMetaContainer) IsNormalType() bool
• type ECSTaskMetaHealth
• type ECSTaskMetaNetwork

Constants

const (
	ECSMetadataURIEnvVar = "ECS_CONTAINER_METADATA_URI_V4"

	AWSRegionEnvVar = "AWS_REGION"
)

Functions

func GetAWSRegion

func GetAWSRegion() string

func NewSession

func NewSession(meta ECSTaskMeta, userAgentCaller string) (*session.Session, error)

NewSession prepares a client session. The returned session includes a User-Agent handler to enable AWS to track usage. If the AWS SDK fails to find the region, the region is parsed from Task metadata (on EC2 the region is not typically defined in the environment).

func ParseTaskID

func ParseTaskID(taskArn string) string

func UserAgentHandler

func UserAgentHandler(caller string) request.NamedHandler

Types

type ECSTaskMeta

type ECSTaskMeta struct {
	Cluster          string                 `json:"Cluster"`
	TaskARN          string                 `json:"TaskARN"`
	Family           string                 `json:"Family"`
	Containers       []ECSTaskMetaContainer `json:"Containers"`
	AvailabilityZone string                 `json:"AvailabilityZone"`
}

func ECSTaskMetadata

func ECSTaskMetadata() (ECSTaskMeta, error)

func (ECSTaskMeta) AccountID

func (e ECSTaskMeta) AccountID() (string, error)

func (ECSTaskMeta) ClusterARN

func (e ECSTaskMeta) ClusterARN() (string, error)

func (ECSTaskMeta) HasContainerStopped

func (e ECSTaskMeta) HasContainerStopped(name string) bool

func (ECSTaskMeta) NodeIP

func (e ECSTaskMeta) NodeIP() string

NodeIP returns the IP of the node the task is running on.

func (ECSTaskMeta) Region

func (e ECSTaskMeta) Region() (string, error)

func (ECSTaskMeta) TaskID

func (e ECSTaskMeta) TaskID() string

type ECSTaskMetaContainer

type ECSTaskMetaContainer struct {
	Name          string               `json:"Name"`
	Health        ECSTaskMetaHealth    `json:"Health"`
	DesiredStatus string               `json:"DesiredStatus"`
	KnownStatus   string               `json:"KnownStatus"`
	Networks      []ECSTaskMetaNetwork `json:"Networks"`
	Type          string               `json:"Type"`
}

func (ECSTaskMetaContainer) HasStopped

func (c ECSTaskMetaContainer) HasStopped() bool

func (ECSTaskMetaContainer) IsNormalType

func (c ECSTaskMetaContainer) IsNormalType() bool

type ECSTaskMetaHealth

type ECSTaskMetaHealth struct {
	Status      string `json:"status"`
	StatusSince string `json:"statusSince"`
	ExitCode    int    `json:"exitCode"`
}

type ECSTaskMetaNetwork

type ECSTaskMetaNetwork struct {
	IPv4Addresses  []string `json:"IPv4Addresses"`
	PrivateDNSName string   `json:"PrivateDNSName"`
}