Categorygithub.com/cockroachdb/cockroachpkgcloudamazon
package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
Versions
3
Dependencies
42
Dependents
14
Files
1.3k SLOC

# Functions

MakeAWSKMS is the factory method which returns a configured, ready-to-use AWS KMS object.
MakeS3Storage returns an instance of S3 ExternalStorage.
S3URI returns the string URI for a given bucket and path.

# Constants

AssumeRoleParam is the query parameter for the chain of AWS Role ARNs to assume.
AWSAccessKeyParam is the query parameter for access_key in an AWS URI.
AWSEndpointParam is the query parameter for the 'endpoint' in an AWS URI.
AWSSecretParam is the query parameter for the 'secret' in an AWS URI.
AWSServerSideEncryptionKMSID is the query parameter in an AWS URI, for the KMS ID to be used for server side encryption.
AWSServerSideEncryptionMode is the query parameter in an AWS URI, for the mode to be used for server side encryption.
AWSTempTokenParam is the query parameter for session_token in an AWS URI.
AWSEndpointParam is the query parameter for UsePathStyle in S3 options.
KMSRegionParam is the query parameter for the 'region' in every KMS URI.
S3RegionParam is the query parameter for the 'endpoint' in an S3 URI.
S3StorageClassParam is the query parameter used in S3 URIs to configure the storage class for written objects.

# Variables

NightlyEnvVarKMSParams maps param keys that get added to a KMS URI to the environment variables hard coded on the VM running the nightly cloud unit tests.
NightlyEnvVarS3Params maps param keys that get added to an S3 URI to the environment variables hard coded on the VM running the nightly cloud unit tests.