Update v2 SDKs example and documentation (#86)

Updates the SDK's examples and documentation to use the v2 configuration pattern. Fix #85
aws · Jan 9, 2018 · 14d1593 · 14d1593
1 parent 493e3ce
commit 14d1593
Show file tree

Hide file tree

Showing 20 changed files with 176 additions and 508 deletions.
diff --git a/aws/config.go b/aws/config.go
@@ -69,11 +69,10 @@ type Config struct {
 	// for empty directory names in s3 requests.
 	//
 	// Example:
-	//    sess := session.Must(session.NewSession(&aws.Config{
-	//         DisableRestProtocolURICleaning: aws.Bool(true),
-	//    }))
+	//    cfg, err := external.LoadDefaultAWSConfig()
+	//    cfg.DisableRestProtocolURICleaning = true
 	//
-	//    svc := s3.New(sess)
+	//    svc := s3.New(cfg)
 	//    out, err := svc.GetObject(&s3.GetObjectInput {
 	//    	Bucket: aws.String("bucketname"),
 	//    	Key: aws.String("//foo//bar//moo"),

diff --git a/aws/defaults/defaults.go b/aws/defaults/defaults.go
@@ -1,12 +1,10 @@
 // Package defaults is a collection of helpers to retrieve the SDK's default
 // configuration and handlers.
 //
-// Generally this package shouldn't be used directly, but session.Session
+// Generally this package shouldn't be used directly, but external.Config
 // instead. This package is useful when you need to reset the defaults
-// of a session or service client to the SDK defaults before setting
+// of a service client to the SDK defaults before setting
 // additional parameters.
-//
-// TODO rename to "default"
 package defaults
 
 import (
@@ -43,7 +41,7 @@ func (l defaultLogger) Log(args ...interface{}) {
 //
 // Generally you shouldn't need to use this method directly, but
 // is available if you need to reset the configuration of an
-// existing service client or session.
+// existing service client.
 func Config() aws.Config {
 	return aws.Config{
 		EndpointResolver: endpoints.NewDefaultResolver(),
@@ -74,7 +72,7 @@ func HTTPClient() *http.Client {
 //
 // Generally you shouldn't need to use this method directly, but
 // is available if you need to reset the request handlers of an
-// existing service client or session.
+// existing service client.
 func Handlers() aws.Handlers {
 	var handlers aws.Handlers
 

diff --git a/aws/ec2metadata/service.go b/aws/ec2metadata/service.go
@@ -20,11 +20,11 @@ type EC2Metadata struct {
 	*aws.Client
 }
 
-// New creates a new instance of the EC2Metadata client with a session.
+// New creates a new instance of the EC2Metadata client with a Config.
 // This client is safe to use across multiple goroutines.
 //
 // Example:
-//     // Create a EC2Metadata client from just a session.
+//     // Create a EC2Metadata client from just a config.
 //     svc := ec2metadata.New(cfg)
 func New(config aws.Config) *EC2Metadata {
 	svc := &EC2Metadata{

diff --git a/aws/endpoints/doc.go b/aws/endpoints/doc.go
@@ -41,7 +41,7 @@
 // If a type implements the Resolver interface it can be used to resolve
 // endpoints. To use this with the SDK's Session and Config set the value
 // of the type to the EndpointsResolver field of aws.Config when initializing
-// the session, or service client.
+// the service client.
 //
 // In addition the ResolverFunc is a wrapper for a func matching the signature
 // of Resolver.ResolveEndpoint, converting it to a type that satisfies the

diff --git a/aws/external/env_config.go b/aws/external/env_config.go
@@ -130,7 +130,7 @@ type EnvConfig struct {
 	//
 	// Setting a custom HTTPClient in the aws.Config options will override this setting.
 	// To use this option and custom HTTP client, the HTTP client needs to be provided
-	// when creating the session. Not the service client.
+	// when creating the config. Not the service client.
 	//
 	//  AWS_CA_BUNDLE=$HOME/my_custom_ca_bundle
 	CustomCABundle string

diff --git a/aws/stscreds/provider.go b/aws/stscreds/provider.go
@@ -7,7 +7,7 @@ future AWS service API operation calls.
 The SDK will ensure that per instance of credentials.Credentials all requests
 to refresh the credentials will be synchronized. But, the SDK is unable to
 ensure synchronous usage of the AssumeRoleProvider if the value is shared
-between multiple Credentials, Sessions or service clients.
+between multiple Credentials or service clients.
 
 Assume Role
 
@@ -17,15 +17,18 @@ with the SDKs's stscreds package.
 	// Initial credentials loaded from SDK's default credential chain. Such as
 	// the environment, shared credentials (~/.aws/credentials), or EC2 Instance
 	// Role. These credentials will be used to to make the STS Assume Role API.
-	sess := session.Must(session.NewSession())
+	cfg, err := external.LoadDefaultAWSConfig()
 
 	// Create the credentials from AssumeRoleProvider to assume the role
 	// referenced by the "myRoleARN" ARN.
-	creds := stscreds.NewCredentials(sess, "myRoleArn")
+	stsSvc := sts.New(cfg)
+	stsCredProvider := stscreds.NewAssumeRoleProvider(stsSvc, "myRoleArn")
+
+	cfg.Credentials = aws.NewCredentials(stsCredProvider)
 
 	// Create service client value configured for credentials
 	// from assumed role.
-	svc := s3.New(sess, &aws.Config{Credentials: creds})
+	svc := s3.New(cfg)
 
 Assume Role with static MFA Token