Documentation
¶
Overview ¶
Package awssecretsmanager provides a runtimevar implementation with variables read from AWS Secrets Manager (https://aws.amazon.com/secrets-manager) Use OpenVariable to construct a *runtimevar.Variable.
URLs ¶
For runtimevar.OpenVariable, awssecretsmanager registers for the scheme "awssecretsmanager". The default URL opener will use an AWS session with the default credentials and configuration; see https://docs.aws.amazon.com/sdk-for-go/api/aws/session/ for more details. To customize the URL opener, or for more details on the URL format, see URLOpener. See https://gocloud.dev/concepts/urls/ for background information.
As ¶
awssecretsmanager exposes the following types for As:
- Snapshot: (V1) *secretsmanager.GetSecretValueOutput, *secretsmanager.DescribeSecretOutput, (V2) *secretsmanagerv2.GetSecretValueOutput, *secretsmanagerv2.DescribeSecretOutput
- Error: (V1) awserr.Error, (V2) any error type returned by the service, notably smithy.APIError
Example (OpenVariableFromURL) ¶
package main
import (
"context"
"log"
"gocloud.dev/runtimevar"
)
func main() {
// PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
// PRAGMA: On gocloud.dev, add a blank import: _ "gocloud.dev/runtimevar/awssecretsmanager"
// PRAGMA: On gocloud.dev, hide lines until the next blank line.
ctx := context.Background()
// runtimevar.OpenVariable creates a *runtimevar.Variable from a URL.
// `secret-variable-name` must be a friendly name of the secret, NOT the Amazon Resource Name (ARN).
v, err := runtimevar.OpenVariable(ctx, "awssecretsmanager://secret-variable-name?region=us-east-2&decoder=string")
if err != nil {
log.Fatal(err)
}
defer v.Close()
// Use "awssdk=v1" or "v2" to force a specific AWS SDK version.
vUsingV2, err := runtimevar.OpenVariable(ctx, "awssecretsmanager://secret-variable-name?region=us-east-2&decoder=string&awssdk=v2")
if err != nil {
log.Fatal(err)
}
defer vUsingV2.Close()
}
Index ¶
- Constants
- Variables
- func OpenVariable(sess client.ConfigProvider, name string, decoder *runtimevar.Decoder, ...) (*runtimevar.Variable, error)
- func OpenVariableV2(client *secretsmanagerv2.Client, name string, decoder *runtimevar.Decoder, ...) (*runtimevar.Variable, error)
- type Options
- type URLOpener
Examples ¶
Constants ¶
const Scheme = "awssecretsmanager"
Scheme is the URL scheme awssecretsmanager registers its URLOpener under on runtimevar.DefaultMux.
Variables ¶
Set holds Wire providers for this package.
Functions ¶
func OpenVariable ¶
func OpenVariable(sess client.ConfigProvider, name string, decoder *runtimevar.Decoder, opts *Options) (*runtimevar.Variable, error)
OpenVariable constructs a *runtimevar.Variable backed by the variable name in AWS Secrets Manager. A friendly name of the secret must be specified. You can NOT specify the Amazon Resource Name (ARN). Secrets Manager returns raw bytes; provide a decoder to decode the raw bytes into the appropriate type for runtimevar.Snapshot.Value. See the runtimevar package documentation for examples of decoders.
Example ¶
package main
import (
"log"
"github.com/aws/aws-sdk-go/aws/session"
"gocloud.dev/runtimevar"
"gocloud.dev/runtimevar/awssecretsmanager"
)
func main() {
// PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
// Establish an AWS session.
// See https://docs.aws.amazon.com/sdk-for-go/api/aws/session/ for more info.
sess, err := session.NewSession(nil)
if err != nil {
log.Fatal(err)
}
// Construct a *runtimevar.Variable that watches the variable.
// `secret-variable-name` must be a friendly name of the secret, NOT the Amazon Resource Name (ARN).
v, err := awssecretsmanager.OpenVariable(sess, "secret-variable-name", runtimevar.StringDecoder, nil)
if err != nil {
log.Fatal(err)
}
defer v.Close()
}
func OpenVariableV2 ¶
func OpenVariableV2(client *secretsmanagerv2.Client, name string, decoder *runtimevar.Decoder, opts *Options) (*runtimevar.Variable, error)
OpenVariableV2 constructs a *runtimevar.Variable backed by the variable name in AWS Secrets Manager, using AWS SDK V2. A friendly name of the secret must be specified. You can NOT specify the Amazon Resource Name (ARN). Secrets Manager returns raw bytes; provide a decoder to decode the raw bytes into the appropriate type for runtimevar.Snapshot.Value. See the runtimevar package documentation for examples of decoders.
Example ¶
package main
import (
"context"
"log"
awsv2cfg "github.com/aws/aws-sdk-go-v2/config"
secretsmanagerv2 "github.com/aws/aws-sdk-go-v2/service/secretsmanager"
"gocloud.dev/runtimevar"
"gocloud.dev/runtimevar/awssecretsmanager"
)
func main() {
// PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
// Establish a AWS V2 Config.
// See https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/ for more info.
ctx := context.Background()
cfg, err := awsv2cfg.LoadDefaultConfig(ctx)
if err != nil {
log.Fatal(err)
}
// Construct a *runtimevar.Variable that watches the variable.
// `secret-variable-name` must be a friendly name of the secret, NOT the Amazon Resource Name (ARN).
clientV2 := secretsmanagerv2.NewFromConfig(cfg)
v, err := awssecretsmanager.OpenVariableV2(clientV2, "secret-variable-name", runtimevar.StringDecoder, nil)
if err != nil {
log.Fatal(err)
}
defer v.Close()
}
Types ¶
type Options ¶
type Options struct {
// WaitDuration controls the rate at which AWS Secrets Manager is polled.
// Defaults to 30 seconds.
WaitDuration time.Duration
}
Options sets options.
type URLOpener ¶
type URLOpener struct {
// UseV2 indicates whether the AWS SDK V2 should be used.
UseV2 bool
// ConfigProvider must be set to a non-nil value if UseV2 is false.
ConfigProvider client.ConfigProvider
// Decoder specifies the decoder to use if one is not specified in the URL.
// Defaults to runtimevar.BytesDecoder.
Decoder *runtimevar.Decoder
// Options specifies the options to pass to New.
Options Options
}
URLOpener opens AWS Secrets Manager URLs like "awssecretsmanager://my-secret-var-name". A friendly name of the secret must be specified. You can NOT specify the Amazon Resource Name (ARN).
Use "awssdk=v1" to force using AWS SDK v1, "awssdk=v2" to force using AWS SDK v2, or anything else to accept the default.
For V1, see gocloud.dev/aws/ConfigFromURLParams for supported query parameters for overriding the aws.Session from the URL. For V2, see gocloud.dev/aws/V2ConfigFromURLParams.
In addition, the following URL parameters are supported:
- decoder: The decoder to use. Defaults to URLOpener.Decoder, or runtimevar.BytesDecoder if URLOpener.Decoder is nil. See runtimevar.DecoderByName for supported values.
- wait: The poll interval, in time.ParseDuration formats. Defaults to 30s.
func (*URLOpener) OpenVariableURL ¶
OpenVariableURL opens the variable at the URL's path. See the package doc for more details.
Source Files