forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
19 lines (17 loc) · 1 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package session
import "github.com/Jeffail/benthos/v3/lib/x/docs"
// FieldSpecs returns documentation specs for AWS session fields.
func FieldSpecs() docs.FieldSpecs {
return docs.FieldSpecs{
docs.FieldCommon("region", "The AWS region to target."),
docs.FieldAdvanced("endpoint", "Allows you to specify a custom endpoint for the AWS API."),
docs.FieldAdvanced("credentials", "Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/aws).").WithChildren(
docs.FieldAdvanced("profile", "A profile from `~/.aws/credentials` to use."),
docs.FieldAdvanced("id", "The ID of credentials to use."),
docs.FieldAdvanced("secret", "The secret for the credentials being used."),
docs.FieldAdvanced("token", "The token for the credentials being used, required when using short term credentials."),
docs.FieldAdvanced("role", "A role ARN to assume."),
docs.FieldAdvanced("role_external_id", "An external ID to provide when assuming a role."),
),
}
}