From 8ff3c7695b26adc86647674bafe5555cc12e9109 Mon Sep 17 00:00:00 2001 From: Philip O'Toole Date: Sat, 22 Apr 2017 14:44:22 -0700 Subject: [PATCH] GoDoc comments --- aws/metadata.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/aws/metadata.go b/aws/metadata.go index 3c302dae..95ff32f3 100644 --- a/aws/metadata.go +++ b/aws/metadata.go @@ -6,11 +6,13 @@ import ( "net/http" ) +// MetadataClient is a client for fetching AWS EC2 instance metadata. type MetadataClient struct { client *http.Client URL string } +// NewMetadataClient returns an instance of a MetadataClient func NewMetadataClient() *MetadataClient { return &MetadataClient{ client: &http.Client{}, @@ -18,10 +20,12 @@ func NewMetadataClient() *MetadataClient { } } +// LocalIPv4 returns the private IPv4 address of the instance. func (m *MetadataClient) LocalIPv4() (string, error) { return m.get("/latest/meta-data/local-ipv4") } +// LocalIPv4 returns the public IPv4 address of the instance. func (m *MetadataClient) PublicIPv4() (string, error) { return m.get("/latest/meta-data/public-ipv4") }