Skip to main content

S3 Protocol

note

This check if S3 compatible endpoints are functioning correctly, to check the contents of a S3 bucket use: S3 Bucket

The S3 check:

  • Lists objects in the bucket to check for Read permissions
  • Puts an object into the bucket for Write permissions
  • Downloads previously uploaded object to check for Get permissions
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: s3-protocol-check
spec:
interval: 30
s3:
- name: s3-check
bucketName: flanksource-public
objectPath: dummy
FieldDescriptionSchemeRequired
bucketBucket name to test againstBucketYes
objectPathPath to create a test object e.g. s3-dummy/stringYes
*All other common fieldsCommon
Connection
connectionPath of existing connection e.g. connection://aws/instance. Mutually exclusive with accessKey and secretKeyConnection
accessKeyMutually exclusive with connectionEnvVarYes
secretKeyMutually exclusive with connectionEnvVarYes
endpointCustom AWS endpointstring
regionAWS regionstring
skipTLSVerifySkip TLS verify when connecting to awsbool