Skip to main content

velero configure-aws-s3

Configures snapshots to use an AWS S3 Bucket as a storage destination. This command supports auth via IAM User Access Keys and IAM Instance Roles for the velero-plugin-for-aws.

Valid Subcommands:

  • access-key
  • instance-role

Usage

kubectl kots velero configure-aws-s3 [subcommand]
FlagTypeDescription
-h, --helphelp for configure-aws-s3

access-keys

kubectl kots velero configure-aws-s3 access-key [flags]
  • Provide [flags] according to the table below
FlagTypeDescription
-h, --helphelp for access-key
-n, --namespacestringthe namespace of the admin console (required)
--access-key-idstringthe aws access key id to use for accessing the bucket (required)
--bucketstringname of the object storage bucket where backups should be stored (required)
--path stringpath to a subdirectory in the object store bucket
--region stringthe region where the bucket exists (required)
--secret-access-key stringthe aws secret access key to use for accessing the bucket (required)
--skip-validationboolskip the validation of the S3 Bucket (default false)

Example

kubectl kots velero configure-aws-s3 access-key --namespace default --region us-east-1 --bucket kots-snaps --access-key-id XXXXXXXJTJB7M2XZUV7D --secret-access-key <secret access key here>

instance-role

kubectl kots velero configure-aws-s3 instance-role [flags]
  • Provide [flags] according to the table below
FlagTypeDescription
-h, --helphelp for access-key
-n, --namespacestringthe namespace of the admin console (required)
--bucketstringname of the object storage bucket where backups should be stored (required)
--path stringpath to a subdirectory in the object store bucket
--region stringthe region where the bucket exists (required)
--skip-validationboolskip the validation of the S3 Bucket (default false)

Example

kubectl kots velero configure-aws-s3 instance-role --namespace default --region us-east-1 --bucket kots-snaps