Go

How to use the Go AWS SDK with LocalStack.

Overview

The AWS SDK for Go, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the Go SDK with LocalStack.

The Go SDK has two major versions, each with their own way of specifying the LocalStack endpoint:

Examples

Here is an example of how to create an S3 Client from a Session with the endpoint set to LocalStack. Full examples for both SDK versions can be found in our samples repository.

  1. package main
  3. import (
  4.     "github.com/aws/aws-sdk-go/aws"
  5.     "github.com/aws/aws-sdk-go/aws/session"
  6.     "github.com/aws/aws-sdk-go/service/s3"
  7.     "github.com/aws/aws-sdk-go/aws/credentials"
  8. )
  10. func main() {
  11.   // Initialize a session
  12.   sess, _ := session.NewSession(&aws.Config{
  13.     Region:           aws.String("us-east-1"),
  14.     Credentials:      credentials.NewStaticCredentials("test", "test", ""),
  15.     S3ForcePathStyle: aws.Bool(true),
  16.     Endpoint:         aws.String("http://localhost:4566"),
  17.   })
  19.   // Create S3 service client
  20.   client := s3.New(sess)
  22.   // ...
  23. }
  1. package main
  3. import (
  4.   "context"
  5.   "log"
  7.   "github.com/aws/aws-sdk-go-v2/aws"
  8.   "github.com/aws/aws-sdk-go-v2/config"
  9.   "github.com/aws/aws-sdk-go-v2/service/s3"
  10. )
  12. func main() {
  13.   awsEndpoint = "http://localhost:4566"
  14.   awsRegion = "us-east-1"
  16.   customResolver := aws.EndpointResolverFunc(func(service, region string) (aws.Endpoint, error) {
  17.     if awsEndpoint != "" {
  18.       return aws.Endpoint{
  19.         PartitionID:   "aws",
  20.         URL:           awsEndpoint,
  21.         SigningRegion: awsRegion,
  22.       }, nil
  23.     }
  25.     // returning EndpointNotFoundError will allow the service to fallback to its default resolution
  26.     return aws.Endpoint{}, &aws.EndpointNotFoundError{}
  27.   })
  29.   awsCfg, err := config.LoadDefaultConfig(context.TODO(),
  30.     config.WithRegion(awsRegion),
  31.     config.WithEndpointResolver(customResolver),
  32.   )
  33.   if err != nil {
  34.     log.Fatalf("Cannot load the AWS configs: %s", err)
  35.   }
  37.   // Create the resource client
  38.   client = s3.NewFromConfig(awsCfg, func(o *s3.Options) {
  39.     o.UsePathStyle = true
  40.   })
  41.   // ...
  42. }

Resources

Last modified October 11, 2021: minor: rename folder Integrations->integrations (68c86019)