checkS3#

Check AWS S3 buckets and security settings.

  • Existence and accessibility

  • Public access is disabled

Parameters

checkAwsS3: str
Check the given S3 bucket
aliases: CheckS3, checkAWSS3, checkAwsS3, CheckAwsS3
private: bool
Security check the public availability of the bucket
default: True
profile: str (Optional)

An alternative profile name to use for AWS authentication

desc: str (Optional)

The description for the check

substitute: bool (Optional)
Whether to substitute environment variables in check values
default: True
aliases: substitute, env_substitute

The checkAwsS3 check in YAML format.

AWS:
  TemplatesS3Bucket:
    desc: The bucket for cloudformation templates
    checkS3: "myproject-cfn-templates"

The checkAwsS3 check in TOML format.

[AWS.TemplatesS3Bucket]
desc = "The bucket for cloudformation templates"
checkS3 = "myproject-cfn-templates"

The checkAwsS3 check in abbreviated TOML format.

[AWS]
TemplatesS3Bucket = {desc = "The bucket for cloudformation templates", checkS3 = "myproject-cfn-templates"}

New in version 1.0.0.