awsutil

package

v0.8.0 Latest Latest Go to latest Published: Feb 29, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hashicorp/consul-ecs

Links

Open Source Insights

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)
type ECSTaskMetaContainer
- func (c ECSTaskMetaContainer) HasStopped() bool
- func (c ECSTaskMetaContainer) IsNormalType() bool
type ECSTaskMetaHealth
type ECSTaskMetaNetwork

Constants ¶

View Source

const (
	ECSMetadataURIEnvVar = "ECS_CONTAINER_METADATA_URI_V4"

	AWSRegionEnvVar = "AWS_REGION"
)

Variables ¶

This section is empty.

Functions ¶

func GetAWSRegion ¶ added in v0.7.0

func GetAWSRegion() string

func NewSession ¶ added in v0.2.0

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 ¶ added in v0.5.0

func ParseTaskID(taskArn string) string

func UserAgentHandler ¶ added in v0.2.0

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 ¶ added in v0.5.0

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

func (ECSTaskMeta) ClusterARN ¶ added in v0.5.0

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

func (ECSTaskMeta) HasContainerStopped ¶ added in v0.7.0

func (e ECSTaskMeta) HasContainerStopped(name string) bool

func (ECSTaskMeta) NodeIP ¶ added in v0.5.0

func (e ECSTaskMeta) NodeIP() string

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

func (ECSTaskMeta) Region ¶ added in v0.5.0

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

func (ECSTaskMeta) TaskID ¶

func (e ECSTaskMeta) TaskID() string

type ECSTaskMetaContainer ¶ added in v0.2.0

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 ¶ added in v0.7.0

func (c ECSTaskMetaContainer) HasStopped() bool

func (ECSTaskMetaContainer) IsNormalType ¶ added in v0.7.1

func (c ECSTaskMetaContainer) IsNormalType() bool

type ECSTaskMetaHealth ¶ added in v0.2.0

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

type ECSTaskMetaNetwork ¶ added in v0.5.0

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

Source Files ¶

View all Source files

awsutil.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL