Product logo
DocsBlogPricing

Policy types for @turbot/aws-s3

AWS > S3 > API Enabled

Configure whether the AWS S3 API is enabled.

Note: Disabling the service disables the API for ALL users
and roles, and Guardrails will have no access to the API.

URI
tmod:@turbot/aws-s3#/policy/types/s3ApiEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > S3 > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > S3 > Enabled"
  ],
  "default": "Enabled"
}

AWS > S3 > Account > CMDB

Configure whether to record and synchronize details for the AWS S3 account into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > S3 > Account > Regions policy, the CMDB control will delete the resource from the CMDB.

(Note: Setting CMDB to "Skip" will also pause these changes.)

URI
tmod:@turbot/aws-s3#/policy/types/s3AccountCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

AWS > S3 > Account > Public Access Block

Configure the AWS S3 buckets account level Public Access Block

URI
tmod:@turbot/aws-s3#/policy/types/s3AccountPublicAccessBlock
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Per `Public Access Block  > Settings`",
  "Enforce: Per `Public Access Block  > Settings`"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Per `Public Access Block  > Settings`",
    "Enforce: Per `Public Access Block  > Settings`"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Account > Public Access Block > Settings

Define the Public Access Block that can be used to restrict the bucket access. This policy provides a default for Public Access Block in AWS Account, however you can explicitly override the setting.

Block Public ACLs: Block public access to buckets and objects granted through new access control lists (ACLs).<br/>
Block Public Bucket Policies: Block public access to buckets and objects granted through new public bucket or access point policies.<br/>
Ignore Public ACLs: Block public access to buckets and objects granted through any access control lists (ACLs).<br/>
Restrict Public Bucket Policies: Block public and cross-account access to buckets and objects through any public bucket or access point policies.<br/>

URI
tmod:@turbot/aws-s3#/policy/types/s3AccountPublicAccessBlockSettings
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Block Public ACLs",
      "Block Public Bucket Policies",
      "Ignore Public ACLs",
      "Restrict Public Bucket Policies"
    ]
  },
  "default": []
}

AWS > S3 > Approved Regions [Default]

A list of AWS regions in which AWS S3 resources are approved for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all AWS S3 resources' Approved > Regions policies.

URI
tmod:@turbot/aws-s3#/policy/types/s3ApprovedRegionsDefault
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/approvedRegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > S3 > Bucket > ACL

URI
tmod:@turbot/aws-s3#/policy/types/bucketAcl
Category
Parent
Targets

AWS > S3 > Bucket > ACL > Trusted Access

Manage trusted access for AWS S3 Buckets via Bucket ACLs.

AWS allows S3 Buckets to be shared with other AWS accounts via ACLs. This policy allows you to configure whether such sharing is allowed, and to which principals.

If set to Enforce: Revoke untrusted access, access to non-trusted entities will be removed.

URI
tmod:@turbot/aws-s3#/policy/types/bucketAclTrustedAccess
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Trusted Access",
  "Enforce: Revoke untrusted access"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Trusted Access",
    "Enforce: Revoke untrusted access"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > ACL > Trusted Access > Canonical IDs

List of AWS Canonical User IDs that are trusted for cross-account
access in the AWS S3 Bucket ACL.

The * wildcard allows any Canonical User ID grantee, and is not recommended.

The [] empty array denies any Canonical User ID grantee.

URI
tmod:@turbot/aws-s3#/policy/types/bucketAclTrustedCanonicalIds
Category
Parent
Targets
Schema
{
  "type": "array",
  "default": "*",
  "items": {
    "type": "string",
    "pattern": "^[a-z0-9]{64,}$"
  }
}

AWS > S3 > Bucket > ACL > Trusted Access > Groups

List of predefined AWS Groups that are trusted for cross-account access in the AWS S3 Bucket ACL.

URI
tmod:@turbot/aws-s3#/policy/types/bucketAclTrustedGroups
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "AllUsers",
      "AuthenticatedUsers",
      "LogDelivery"
    ]
  },
  "default": [
    "AllUsers",
    "AuthenticatedUsers",
    "LogDelivery"
  ]
}

AWS > S3 > Bucket > Access Logging

Define the Access Logging settings required for AWS > S3 > Bucket.

AWS > S3 > Bucket provides access logs that capture detailed information
about requests sent to your bucket. Each log contains information such as
the time the request was received, the client's IP address, latencies,
request paths, and server responses. You can use these access logs to
analyze traffic patterns and troubleshoot issues.

URI
tmod:@turbot/aws-s3#/policy/types/bucketAccessLogging
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled",
  "Check: Enabled to Access Logging > Bucket",
  "Enforce: Disabled",
  "Enforce: Enabled to Access Logging > Bucket"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled",
    "Check: Enabled to Access Logging > Bucket",
    "Enforce: Disabled",
    "Enforce: Enabled to Access Logging > Bucket"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Access Logging > Bucket

The name of an S3 Bucket to which the Bucket
access logs will be delivered.

The S3 Bucket must already exist and the S3 service must be allowed write access.
The bucket should reside in same account and same region as of the Bucket.

example:
<br /> testbucket<br /> turbotbucket<br />

URI
tmod:@turbot/aws-s3#/policy/types/bucketAccessLoggingBucket
Category
Parent
Targets
Default Template Input
"{\n  turbotLoggingBucket: policy(uri: \"aws#/policy/types/loggingBucketDefault\")\n}\n"
Default Template
"{% if $.turbotLoggingBucket %}&quot;{{ $.turbotLoggingBucket }}&quot;{% else %}&quot;&quot;{% endif %}"
Schema
{
  "type": "string"
}

AWS > S3 > Bucket > Access Logging > Key Prefix

An optional S3 key prefix to which the AWS > S3 > Bucket access logs will be written.

The file names of the access logs use the following format:
bucket[/prefix]/AWSLogs/aws-account-id/elasticloadbalancing/region/yyyy/mm/dd/aws-account-id_elasticloadbalancing_region_load-balancer-id_end-time_ip-address_random-string.log.gz

URI
tmod:@turbot/aws-s3#/policy/types/bucketAccessLoggingBucketPrefix
Category
Parent
Targets
Schema
{
  "type": "string",
  "pattern": "^.{1,200}$",
  "default": ""
}

AWS > S3 > Bucket > Active

Determine the action to take when an AWS S3 bucket, based on the AWS > S3 > Bucket > Active > * policies.

The control determines whether the resource is in active use, and if not,
has the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > S3 > Bucket > Active > *), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered
Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketActive
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Active",
  "Enforce: Delete inactive with 1 day warning",
  "Enforce: Delete inactive with 3 days warning",
  "Enforce: Delete inactive with 7 days warning",
  "Enforce: Delete inactive with 14 days warning",
  "Enforce: Delete inactive with 30 days warning",
  "Enforce: Delete inactive with 60 days warning",
  "Enforce: Delete inactive with 90 days warning",
  "Enforce: Delete inactive with 180 days warning",
  "Enforce: Delete inactive with 365 days warning"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Active",
    "Enforce: Delete inactive with 1 day warning",
    "Enforce: Delete inactive with 3 days warning",
    "Enforce: Delete inactive with 7 days warning",
    "Enforce: Delete inactive with 14 days warning",
    "Enforce: Delete inactive with 30 days warning",
    "Enforce: Delete inactive with 60 days warning",
    "Enforce: Delete inactive with 90 days warning",
    "Enforce: Delete inactive with 180 days warning",
    "Enforce: Delete inactive with 365 days warning"
  ],
  "example": [
    "Check: Active"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Active > Age

The age after which the AWS S3 bucket
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.

The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > S3 > Bucket > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketActiveAge
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Force inactive if age > 1 day",
  "Force inactive if age > 3 days",
  "Force inactive if age > 7 days",
  "Force inactive if age > 14 days",
  "Force inactive if age > 30 days",
  "Force inactive if age > 60 days",
  "Force inactive if age > 90 days",
  "Force inactive if age > 180 days",
  "Force inactive if age > 365 days"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Force inactive if age > 1 day",
    "Force inactive if age > 3 days",
    "Force inactive if age > 7 days",
    "Force inactive if age > 14 days",
    "Force inactive if age > 30 days",
    "Force inactive if age > 60 days",
    "Force inactive if age > 90 days",
    "Force inactive if age > 180 days",
    "Force inactive if age > 365 days"
  ],
  "example": [
    "Force inactive if age > 90 days"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Active > Budget

The impact of the budget state on the active control. This policy allows you to force
buckets to inactive based on the current budget state, as reflected in
AWS > Account > Budget > State

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > S3 > Bucket > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketActiveBudget
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Force inactive if Budget > State is Over or higher",
  "Force inactive if Budget > State is Critical or higher",
  "Force inactive if Budget > State is Shutdown"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Force inactive if Budget > State is Over or higher",
    "Force inactive if Budget > State is Critical or higher",
    "Force inactive if Budget > State is Shutdown"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Active > Last Modified

The number of days since the AWS S3 bucket
was last modified before it is considered inactive.

The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > S3 > Bucket > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketActiveLastModified
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Active if last modified <= 1 day",
  "Active if last modified <= 3 days",
  "Active if last modified <= 7 days",
  "Active if last modified <= 14 days",
  "Active if last modified <= 30 days",
  "Active if last modified <= 60 days",
  "Active if last modified <= 90 days",
  "Active if last modified <= 180 days",
  "Active if last modified <= 365 days",
  "Force active if last modified <= 1 day",
  "Force active if last modified <= 3 days",
  "Force active if last modified <= 7 days",
  "Force active if last modified <= 14 days",
  "Force active if last modified <= 30 days",
  "Force active if last modified <= 60 days",
  "Force active if last modified <= 90 days",
  "Force active if last modified <= 180 days",
  "Force active if last modified <= 365 days"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Active if last modified <= 1 day",
    "Active if last modified <= 3 days",
    "Active if last modified <= 7 days",
    "Active if last modified <= 14 days",
    "Active if last modified <= 30 days",
    "Active if last modified <= 60 days",
    "Active if last modified <= 90 days",
    "Active if last modified <= 180 days",
    "Active if last modified <= 365 days",
    "Force active if last modified <= 1 day",
    "Force active if last modified <= 3 days",
    "Force active if last modified <= 7 days",
    "Force active if last modified <= 14 days",
    "Force active if last modified <= 30 days",
    "Force active if last modified <= 60 days",
    "Force active if last modified <= 90 days",
    "Force active if last modified <= 180 days",
    "Force active if last modified <= 365 days"
  ],
  "example": [
    "Active if last modified <= 90 days"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Approved

Determine the action to take when an AWS S3 bucket is not approved based on AWS > S3 > Bucket > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Delete unapproved if new and empty"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Delete unapproved if new and empty"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Approved > Budget

The policy allows you to set buckets to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State

This policy will be evaluated by the Approved control. If an AWS S3 bucket is not matched by the approved list, it will be subject to the action specified in the AWS > S3 > Bucket > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketApprovedBudget
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Unapproved if Budget > State is Over or higher",
  "Unapproved if Budget > State is Critical or higher",
  "Unapproved if Budget > State is Shutdown"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Unapproved if Budget > State is Over or higher",
    "Unapproved if Budget > State is Critical or higher",
    "Unapproved if Budget > State is Shutdown"
  ],
  "example": [
    "Unapproved if Budget > State is Shutdown"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Approved > Custom

Determine whether the AWS S3 bucket is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS S3 bucket is not approved, it will be subject to the action specified in the AWS > S3 > Bucket > Approved policy.
See Approved for more information.

Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.

URI
tmod:@turbot/aws-s3#/policy/types/bucketApprovedCustom
Category
Parent
Targets
Schema
{
  "example": [
    "Approved",
    "Not approved",
    "Skip",
    {
      "result": "Approved"
    },
    {
      "title": "string",
      "result": "Not approved"
    },
    {
      "title": "string",
      "result": "Approved",
      "message": "string"
    },
    [
      {
        "title": "string",
        "result": "Approved",
        "message": "string"
      },
      {
        "title": "string",
        "result": "Not approved",
        "message": "string"
      }
    ]
  ],
  "anyOf": [
    {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "pattern": "^[\\W\\w]{1,32}$"
          },
          "message": {
            "type": "string",
            "pattern": "^[\\W\\w]{1,128}$"
          },
          "result": {
            "type": "string",
            "pattern": "^(Approved|Not approved|Skip)$"
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      }
    },
    {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "pattern": "^[\\W\\w]{1,32}$"
        },
        "message": {
          "type": "string",
          "pattern": "^[\\W\\w]{1,128}$"
        },
        "result": {
          "type": "string",
          "pattern": "^(Approved|Not approved|Skip)$"
        }
      },
      "required": [
        "result"
      ],
      "additionalProperties": false
    },
    {
      "type": "string",
      "pattern": "^(Approved|Not approved|Skip)$"
    }
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Approved > Regions

A list of AWS regions in which AWS S3 buckets are approved for use.

The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.

This policy will be evaluated by the Approved control. If an AWS S3 bucket is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > S3 > Bucket > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketApprovedRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policy(uri: \"tmod:@turbot/aws-s3#/policy/types/s3ApprovedRegionsDefault\")\n}\n"
Default Template
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > S3 > Bucket > Approved > Usage

Determine whether the AWS S3 bucket is allowed to exist.

This policy will be evaluated by the Approved control. If an AWS S3 bucket is not approved, it will be subject to the action specified in the AWS > S3 > Bucket > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketApprovedUsage
Category
Parent
Targets
Valid Value
[
  "Not approved",
  "Approved",
  "Approved if AWS > S3 > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > S3 > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > S3 > Enabled"
}

AWS > S3 > Bucket > CMDB

Configure whether to record and synchronize details for the AWS S3 bucket into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > S3 > Bucket > Regions policy, the CMDB control will delete the resource from the CMDB.

(Note: Setting CMDB to "Skip" will also pause these changes.)

URI
tmod:@turbot/aws-s3#/policy/types/bucketCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

AWS > S3 > Bucket > Configured

Determine how to configure this resource.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it.

URI
tmod:@turbot/aws-s3#/policy/types/bucketConfigured
Category
Parent
Targets
Valid Value
[
  "Skip (unless claimed by a stack)",
  "Check: Per Configured > Source (unless claimed by a stack)",
  "Enforce: Per Configured > Source (unless claimed by a stack)"
]
Schema
{
  "enum": [
    "Skip (unless claimed by a stack)",
    "Check: Per Configured > Source (unless claimed by a stack)",
    "Enforce: Per Configured > Source (unless claimed by a stack)"
  ],
  "default": "Skip (unless claimed by a stack)"
}

AWS > S3 > Bucket > Configured > Claim Precedence

An ordered list of who is allowed to claim a resource.
A stack cannot claim a resource if it is already claimed by another
stack at a higher level of precedence.

URI
tmod:@turbot/aws-s3#/policy/types/bucketConfiguredPrecedence
Category
Parent
Targets
Default Template Input
"{\n  defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"
Default Template
"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- &#39;{{ item }}&#39;{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > S3 > Bucket > Configured > Source

A HCL or JSON format Terraform configuration source used to configure this resource.

URI
tmod:@turbot/aws-s3#/policy/types/bucketConfiguredSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > S3 > Bucket > Encryption at Rest

Define the Encryption at Rest settings required for AWS > S3 > Bucket.

Encryption at Rest refers specifically to the encryption of data when written
to an underlying storage system. This control determines whether the resource
is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > S3 > Bucket > Encryption at Rest > *), raises an alarm, and takes the defined enforcement action.

Note: The below policy values are deprecated and will be removed in the next major mod version because they are no longer supported by AWS.

| Deprecated Values |
|-------------------------------------|
| Check: None |
| Check: None or higher |
| Enforce: None |
| Enforce: None or higher |

URI
tmod:@turbot/aws-s3#/policy/types/bucketEncryptionAtRest
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: None",
  "Check: None or higher",
  "Check: AWS SSE",
  "Check: AWS SSE or higher",
  "Check: AWS managed key",
  "Check: AWS managed key or higher",
  "Check: Customer managed key",
  "Check: Encryption at Rest > Customer Managed Key",
  "Enforce: None",
  "Enforce: None or higher",
  "Enforce: AWS SSE",
  "Enforce: AWS SSE or higher",
  "Enforce: AWS managed key",
  "Enforce: AWS managed key or higher",
  "Enforce: Customer managed key",
  "Enforce: Encryption at Rest > Customer Managed Key"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: None",
    "Check: None or higher",
    "Check: AWS SSE",
    "Check: AWS SSE or higher",
    "Check: AWS managed key",
    "Check: AWS managed key or higher",
    "Check: Customer managed key",
    "Check: Encryption at Rest > Customer Managed Key",
    "Enforce: None",
    "Enforce: None or higher",
    "Enforce: AWS SSE",
    "Enforce: AWS SSE or higher",
    "Enforce: AWS managed key",
    "Enforce: AWS managed key or higher",
    "Enforce: Customer managed key",
    "Enforce: Encryption at Rest > Customer Managed Key"
  ],
  "example": [
    "Check: None or higher"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Encryption at Rest > Customer Managed Key

Define the KMS key ID for encryption at rest.

Encryption at Rest refers specifically to the encryption of data when written
to an underlying storage system. This control determines whether the resource
is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > S3 > Bucket > Encryption at Rest > *), raises an alarm, and takes the defined enforcement action

Please make sure the key defined in the template has required permissions.

<br />example:<br /> alias/aws/ebs<br /> ddc06e04-ce5f-4995-c758-c2b6c510e8fd<br /> arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd<br />

URI
tmod:@turbot/aws-s3#/policy/types/bucketEncryptionAtRestCustomerManagedKey
Category
Parent
Targets
Default Template Input
"{\n  defaultKey: policy(uri: \"aws-kms#/policy/types/keyDefaultCustomerManagedKey\")\n}\n"
Default Template
"{{ $.defaultKey }}"
Schema
{
  "anyOf": [
    {
      "type": "string",
      "pattern": "^alias/[a-zA-Z0-9:/_-]{1,249}$"
    },
    {
      "type": "string",
      "pattern": "^[-a-z0-9-]{1,255}$"
    },
    {
      "type": "string",
      "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:key/[-a-z0-9-]{1,255}$"
    }
  ],
  "tests": [
    {
      "description": "valid - if keyArn",
      "input": "arn:aws:kms:us-east-1:039305405804:key/ddc06e04-ce5f-4995-b758-c2b6c510e8fd"
    },
    {
      "description": "valid - if aliasName",
      "input": "alias/aws/ebs"
    },
    {
      "description": "valid - if keyId",
      "input": "ddc06e04-ce5f-4995-b758-c2b6c510e8fd"
    }
  ]
}

AWS > S3 > Bucket > Encryption in Transit

Define the Encryption in Transit settings required for AWS > S3 > Bucket.

The Encryption in Transit control compares the Encryption in Transit settings against the Encryption in Transit policies for the resource
(AWS > S3 > Bucket > Encryption in Transit), raises an alarm, and takes the defined enforcement action.

The Encryption in Transit control examines the bucket's policy to find a match for the below statement. An exact match across all statement fields is required for encryption in transit to be considered enabled.
<br />{<br /> Sid: &quot;MustBeEncryptedInTransit&quot;,<br /> Effect: &quot;Deny&quot;,<br /> Principal: &quot;*&quot;,<br /> Action: &quot;s3:*&quot;,<br /> Resource: [&#39;arn:${partition}:s3:::${bucketName}&#39;, &#39;arn:${partition}:s3:::${bucketName}/*&#39;],<br /> Condition: {<br /> Bool: {<br /> &quot;aws:SecureTransport&quot;: &quot;false&quot;<br /> }<br /> }<br />}<br />

URI
tmod:@turbot/aws-s3#/policy/types/encryptionInTransit
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled",
  "Enforce: Disabled",
  "Enforce: Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled",
    "Enforce: Disabled",
    "Enforce: Enabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Policy

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicy
Category
Parent
Targets

AWS > S3 > Bucket > Policy > Trusted Access

Take an action when AWS S3 bucket policy is not trusted based on the
AWS > S3 > Bucket > Policy > Trusted Access > * policies.

The Trusted Access control evaluates the bucket policy against the list of allowed
members in each of the Trusted Access sub-policies (Trusted Access > Accounts,
Trusted Access > Services etc.), this control raises an alarm and takes the
defined enforcement action.

The account that owns the bucket will always be trusted, even if its account ID is
not included in the Trusted Accounts policy.

If set to Enforce: Revoke untrusted access, access to non-trusted
members will be removed.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedAccess
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Trusted Access",
  "Enforce: Revoke untrusted access"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Trusted Access",
    "Enforce: Revoke untrusted access"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Policy > Trusted Access > Accounts

List of AWS Account IDs that are trusted for cross-account access in the
AWS S3 bucket policy.

Note that Trusted Access > Accounts and Trusted Access &gt;<br />Organizations are evaluated independently. To have access, an AWS
principal must be allowed in Trusted Access > Accounts AND be a
member of an Organization that is allowed in Trusted Access &gt;<br />Organizations.

<br />example:<br /> - &quot;123456789012&quot;<br />
Note: Setting the policy to an Empty array will remove all accounts.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedAccounts
Category
Parent
Targets
Default Template Input
"{\n  accounts: policy(uri: \"tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedAccounts\")\n}\n"
Default Template
"{% if $.accounts | length == 0 %}[]{% endif %}{% for item in $.accounts %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\d{12}$|^\\*$)"
  }
}

AWS > S3 > Bucket > Policy > Trusted Access > CloudFront Origin Access Identities

List of CloudFront Origin Access Identities (OAIs) that are trusted for cross-account access in the AWS S3 bucket policy.

The expected format is an array of CloudFront OAI ARNs or OAI IDs.

<br />example:<br /> - &quot;arn:aws:iam::cloudfront:user/CloudFront Origin Access Identity EH1HDMB1FH2TC&quot;<br /> - &quot;EH1HDMB1FH2TC&quot;<br />
Note: Setting the policy to an Empty array will remove all CloudFront OAIs.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedCloudFrontOriginAccessIdentities
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\*$|^[A-Z0-9]+$|^arn:aws(-us-gov|-cn)?:iam::cloudfront:user/CloudFront Origin Access Identity [A-Z0-9]+$)"
  },
  "default": [
    "*"
  ]
}

AWS > S3 > Bucket > Policy > Trusted Access > Identity Providers

List of Identity Providers that are trusted for cross-account access in the
AWS S3 bucket policy.

<br />example:<br /> - www.google.com<br /> - www.facebook.com<br />
Note: Setting the policy to an Empty array will remove all identity providers.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedIdentityProviders
Category
Parent
Targets
Default Template Input
"{\n  identityProviders: policy(uri: \"tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedIdentityProviders\")\n}\n"
Default Template
"{% if $.identityProviders | length == 0 %}[]{% endif %}{% for item in $.identityProviders %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > S3 > Bucket > Policy > Trusted Access > Organization Path Restrictions

List of AWS Organization Paths that are trusted for cross-account access in
the AWS S3 bucket policy, or '' to skip the Organization Path Restriction.

Note that Trusted Access > Accounts and Trusted Access &gt;<br />Organization Paths are evaluated independently. To have access, an AWS
principal must be allowed in Trusted Access > Accounts AND be a
member of the Organization Path that is allowed in Trusted Access &gt;<br />Organization Paths.

Note: Trusted Access > Organization Path Restrictions are ONLY
applied to AWS principals. Services and Federated principals do
NOT contain the aws:PrincipalOrgPaths condition key, and thus
cannot be validated against the Organization Path.
Also, please note that this policy will validate organization paths against ForAnyValue:StringLike conditional operator for a given bucket policy condition.

```
example:
- "o-333333333/r-wxnb/ou-wxnb-dasdtpaq/ou-"
- "o-444444444/r-wxnb/ou-wxnb-dfadtpaq/*"
```

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedOrganizationPaths
Category
Parent
Targets
Schema
{
  "default": [
    "*"
  ],
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > S3 > Bucket > Policy > Trusted Access > Organization Restrictions

List of AWS Organization IDs that are trusted for cross-account access in
the AWS S3 bucket policy, or '*' to skip the Organization Restriction.

Note that Trusted Access > Accounts and Trusted Access &gt;<br />Organizations are evaluated independently. To have access, an AWS
principal must be allowed in Trusted Access > Accounts AND be a
member of an Organization that is allowed in Trusted Access &gt;<br />Organizations.

Note: Trusted Access > Organization Restrictions are ONLY
applied to AWS principals. Services and Federated principals do
NOT contain the aws:PrincipalOrgId condition key, and thus
cannot be validated against the Organization.

<br />example:<br /> - &quot;o-333333333&quot;<br /> - &quot;o-c3a5y4wd52&quot;<br />

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedOrganizations
Category
Parent
Targets
Default Template Input
"{\n  organizations: policy(uri: \"tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedOrganizations\")\n}\n"
Default Template
"{% if $.organizations | length == 0 %}[]{% endif %}{% for item in $.organizations %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)"
  }
}

AWS > S3 > Bucket > Policy > Trusted Access > Services

List of AWS Services that are trusted for access in the AWS S3 bucket policy.

<br />example:<br /> - sns.amazonaws.com<br /> - ec2.amazonaws.com<br />

Note: Setting the policy to an Empty array will remove all services.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyTrustedServices
Category
Parent
Targets
Default Template Input
"{\n  services: policy(uri: \"tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedServices\")\n}\n"
Default Template
"{% if $.services | length == 0 %}[]{% endif %}{% for item in $.services %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)"
  }
}

AWS > S3 > Bucket > Policy Statements

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatements
Category
Parent
Targets

AWS > S3 > Bucket > Policy Statements > Approved

Configure Bucket Policy Statements checking. This policy defines whether
to verify the bucket policy statements are approved, as well as the
subsequent action to take on unapproved statements. Rules for all Approved
policies will be compiled in Approved > Compiled Rules and then
evaluated.

If set to Enforce: Delete unapproved, any unapproved principal will be
revoked from the bucket policy.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Delete unapproved"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Delete unapproved"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Policy Statements > Approved > Encryption at Rest

Determine whether bucket policy statements generated by the
AWS > S3 > Bucket > Encryption at Rest are approved.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedEncryptionAtRest
Category
Parent
Targets
Valid Value
[
  "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption at Rest`"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption at Rest`"
  ],
  "default": "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption at Rest`"
}

AWS > S3 > Bucket > Policy Statements > Approved > Encryption in Transit

Determine whether bucket policy statements generated by the
AWS > S3 > Bucket > Encryption in Transit are approved.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedEncryptionInTransit
Category
Parent
Targets
Valid Value
[
  "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption in Transit`"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption in Transit`"
  ],
  "default": "Enabled: Approve statements from `AWS > S3 > Bucket > Encryption in Transit`"
}

AWS > S3 > Bucket > Policy Statements > Approved > Rules

An Object Control List (OCL) with a list of filter rules
to approve or reject bucket policy statements.
Note that the Approved control does not operate directly from this policy,
but from the Approved > Compiled Rules. The rules are processed in order,
and any built-in Guardrails rules will appear first in the list of compiled
rules.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedRules
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "# Approve unmatched rules\nAPPROVE *",
  "x-schema-form": {
    "type": "textarea"
  }
}

AWS > S3 > Bucket > Policy Statements > Approved > Rules > Compiled Rules

A read-only Object Control List (OCL) to approved or reject bucket policy statements
for a bucket.
This policy is generated by Guardrails.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsCompiledRules
Category
Parent
Targets
Schema
{
  "type": "string"
}

AWS > S3 > Bucket > Policy Statements > Approved > Trusted Accounts [Deprecated]

Defines the AWS Accounts that can be allowed to access any bucket.
Examples:
- arn:aws:iam::560741234067:root
- 492552618977
- 123456789012

Note: This policy has been deprecated in v5.6.0 and will be removed in v6.0.0. It has been replaced by the AWS > S3 > Bucket > Policy > Trusted Access policy.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedTrustedAwsAccounts
Category
Parent
Targets
Default Template Input
"{\n  account {\n    Id\n  }\n}\n"
Default Template
"- {{ $.account.Id }}"
Schema
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "type": "string",
        "pattern": "^arn:aws(-us-gov|-cn)?:iam::[0-9]{1,12}:[A-Za-z0-9_+=,.@-]{1,64}$"
      },
      {
        "type": "string",
        "pattern": "^cloudfront$"
      },
      {
        "type": "integer"
      },
      {
        "type": "string",
        "pattern": "^[0-9]{12}$",
        "tests": [
          {
            "description": "valid int - 123456789012",
            "input": 123456789012
          },
          {
            "description": "valid string - 123456789012",
            "input": "123456789012"
          },
          {
            "description": "valid - leading zeros",
            "input": "001234567890"
          },
          {
            "description": "invalid - contains char",
            "input": "a123456789012",
            "expected": false
          },
          {
            "description": "invalid - too short",
            "input": 12345678901,
            "expected": false
          },
          {
            "description": "invalid - too long",
            "input": 1234567890123,
            "expected": false
          }
        ],
        ".turbot": {
          "uri": "tmod:@turbot/aws#/definitions/accountId",
          "modUri": "tmod:@turbot/aws"
        }
      }
    ]
  }
}

AWS > S3 > Bucket > Policy Statements > Approved > Trusted Identity Providers [Deprecated]

Defines the Identity Providers that can be allowed to access any bucket.
Examples:
- www.amazon.com
- arn:aws:iam::013122550996:saml-provider/idp1

Note: This policy has been deprecated in v5.6.0 and will be removed in v6.0.0. It has been replaced by the AWS > S3 > Bucket > Policy > Trusted Access policy.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedTrustedIdentityProvider
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "default": []
}

AWS > S3 > Bucket > Policy Statements > Approved > Trusted Services [Deprecated]

Defines the AWS Services that can be allowed to access any bucket.
Examples:
- cloudtrail.amazonaws.com
- cloudwatch.amazonaws.com

Note: This policy has been deprecated in v5.6.0 and will be removed in v6.0.0. It has been replaced by the AWS > S3 > Bucket > Policy > Trusted Access policy.

URI
tmod:@turbot/aws-s3#/policy/types/bucketPolicyStatementsApprovedTrustedAwsServices
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(^\\S+\\.amazonaws\\.com$)"
  },
  "default": []
}

AWS > S3 > Bucket > Public Access Block

Configure the AWS S3 buckets Bucket Level Public Access Block

URI
tmod:@turbot/aws-s3#/policy/types/s3BucketPublicAccessBlock
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Per `Public Access Block  > Settings`",
  "Enforce: Per `Public Access Block  > Settings`"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Per `Public Access Block  > Settings`",
    "Enforce: Per `Public Access Block  > Settings`"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Public Access Block > Settings

Define the Public Access Block that can be used to restrict the bucket access. This policy provides a default for Public Access Block in AWS S3 Bucket, however you can explicitly override the setting.

Block Public ACLs: Block public access to buckets and objects granted through new access control lists (ACLs).<br/>
Block Public Bucket Policies: Block public access to buckets and objects granted through new public bucket or access point policies.<br/>
Ignore Public ACLs: Block public access to buckets and objects granted through any access control lists (ACLs).<br/>
Restrict Public Bucket Policies: Block public and cross-account access to buckets and objects through any public bucket or access point policies.<br/>

URI
tmod:@turbot/aws-s3#/policy/types/s3BucketPublicAccessBlockSettings
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Block Public ACLs",
      "Block Public Bucket Policies",
      "Ignore Public ACLs",
      "Restrict Public Bucket Policies"
    ]
  },
  "default": []
}

AWS > S3 > Bucket > Regions

A list of AWS regions in which AWS S3 buckets are supported for use.

Any buckets in a region not listed here will not be recorded in CMDB.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

URI
tmod:@turbot/aws-s3#/policy/types/bucketRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-s3#/policy/types/s3RegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > S3 > Bucket > Tags

Determine the action to take when an AWS S3 bucket tags are not updated based on the AWS > S3 > Bucket > Tags > * policies.

The control ensure AWS S3 bucket tags include tags defined in AWS > S3 > Bucket > Tags > Template.

Tags not defined in Bucket Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketTags
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Tags are correct",
  "Enforce: Set tags"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Tags are correct",
    "Enforce: Set tags"
  ],
  "example": [
    "Check: Tags are correct"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Tags > Template

The template is used to generate the keys and values for AWS S3 bucket.

Tags not defined in Bucket Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-s3#/policy/types/bucketTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-s3#/policy/types/s3TagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\n    value\n  }\n}\n"
]
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Schema

AWS > S3 > Bucket > Usage

Configure the number of AWS S3 buckets that can be used for this account and the current consumption against the limit.

You can configure the behavior of the control with this AWS > S3 > Bucket > Usage policy.

URI
tmod:@turbot/aws-s3#/policy/types/bucketUsage
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Usage <= 85% of Limit",
  "Check: Usage <= 100% of Limit"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Usage <= 85% of Limit",
    "Check: Usage <= 100% of Limit"
  ],
  "example": [
    "Check: Usage <= 85% of Limit"
  ],
  "default": "Skip"
}

AWS > S3 > Bucket > Usage > Limit

Maximum number of items that can be created for this account.

URI
tmod:@turbot/aws-s3#/policy/types/bucketUsageLimit
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "default": 100
}

AWS > S3 > Bucket > Versioning

Check if the AWS S3 bucket Versioning configuration is set correctly.

URI
tmod:@turbot/aws-s3#/policy/types/bucketVersioning
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled",
  "Enforce: Disabled",
  "Enforce: Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled",
    "Enforce: Disabled",
    "Enforce: Enabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > S3 > Enabled

Configure whether the AWS S3 service is enabled for users.

Note: Disabling the service in this policy does NOT disable the
API for Guardrails or SuperUsers

URI
tmod:@turbot/aws-s3#/policy/types/s3Enabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > S3 > Permissions

Configure whether permissions policies are in effect for AWS S3.
This setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)

Note: The behavior of this policy depends on the value of AWS > Permissions.

URI
tmod:@turbot/aws-s3#/policy/types/s3Permissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > S3 > Enabled & AWS > S3 > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > S3 > Enabled & AWS > S3 > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > S3 > Enabled & AWS > S3 > API Enabled"
}

AWS > S3 > Permissions > Levels

Define the permissions levels that can be used to grant access to an AWS account.
Permissions levels defined will appear in the UI to assign access to Guardrails users.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevels
Category
Parent
Targets
Default Template Input
[
  "{\n  item: account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/aws-iam#/policy/types/permissionsLevelsDefault'\") {\n    items {\n      value\n    }\n  }\n}\n"
]
Default Template
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > S3 > Permissions > Levels > ACL Administration

Determines which Guardrails permissions level can manage ACL Administration.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevelsAclAdministration
Category
Parent
Targets
Valid Value
[
  "None",
  "Admin"
]
Schema
{
  "type": "string",
  "enum": [
    "None",
    "Admin"
  ],
  "example": [
    "None"
  ],
  "default": "None"
}

AWS > S3 > Permissions > Levels > Access Logging Administration

Determines which Guardrails permissions level can manage Access Logging Administration.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevelsAccessLoggingAdministration
Category
Parent
Targets
Valid Value
[
  "None",
  "Admin"
]
Schema
{
  "type": "string",
  "enum": [
    "None",
    "Admin"
  ],
  "example": [
    "None"
  ],
  "default": "None"
}

AWS > S3 > Permissions > Levels > CORS Administration

Determines which Guardrails permissions level can manage CORS Administration.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevelsCorsAdministration
Category
Parent
Targets
Valid Value
[
  "None",
  "Admin"
]
Schema
{
  "type": "string",
  "enum": [
    "None",
    "Admin"
  ],
  "example": [
    "None"
  ],
  "default": "None"
}

AWS > S3 > Permissions > Levels > Cross Replication Administration

Determines which Guardrails permissions level can manage Cross Replication Administration.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevelsCrossReplicationAdministration
Category
Parent
Targets
Valid Value
[
  "None",
  "Admin"
]
Schema
{
  "type": "string",
  "enum": [
    "None",
    "Admin"
  ],
  "example": [
    "None"
  ],
  "default": "None"
}

AWS > S3 > Permissions > Levels > Modifiers

A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.
You can add, remove or redefine the mapping of AWS API operations to Guardrails permissions levels here.

Note: Modifiers are cumulative - if you add a permission to the Metadata level, it is also
added to ReadOnly, Operator and Admin. Modifier policies set here apply ONLY to the AWS level"

<br />example:<br /> - &quot;glacier:createvault&quot;: admin<br /> - &quot;glacier:ListVaults&quot;: metadata<br /> - &quot;s3:DeleteBucket&quot;: none<br />

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > S3 > Permissions > Lockdown

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLockdown
Category
Parent
Targets

AWS > S3 > Permissions > Lockdown > API Boundary

Configure whether the AWS S3 API is enabled for all users and roles
in turbot-managed boundary policies.

Note: Disabling the service disables the API for ALL users
and roles, and Guardrails will have no access to the API.

URI
tmod:@turbot/aws-s3#/policy/types/s3PermissionsLockdownApiBoundary
Category
Parent
Targets
Valid Value
[
  "Enabled if AWS > S3 > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled if AWS > S3 > API Enabled"
  ],
  "example": [
    "Enabled if AWS > S3 > API Enabled"
  ],
  "default": "Enabled if AWS > S3 > API Enabled"
}

AWS > S3 > Regions

A list of AWS regions in which AWS S3 resources are supported for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all AWS S3 resources' Regions policies.

URI
tmod:@turbot/aws-s3#/policy/types/s3RegionsDefault
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/regionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > S3 > Tags Template [Default]

A template used to generate the keys and values for AWS S3 resources.

By default, all S3 resource Tags > Template policies will use this value.

URI
tmod:@turbot/aws-s3#/policy/types/s3TagsTemplate
Category
Parent
Targets
Default Template Input
"{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws#/policy/types/defaultTagsTemplate\") {\n    value\n  }\n}\n"
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Schema

AWS > S3 > Trusted Accounts [Default]

List of AWS Accounts that are trusted for access in the AWS S3 policy.

This policy is used by the Trusted Access
control to determine which members of type "account" are allowed
to be granted access. You may use the '*' and '?' wildcard characters.

<br />example:<br /> - &quot;013122550996&quot;<br /> - &quot;560741234067&quot;<br />

Note: Setting the policy to Empty array will remove all accounts.

URI
tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedAccounts
Category
Parent
Targets
Default Template Input
"{\n  trustedAccounts: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedAccounts\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedAccounts.value | length == 0 %}[]{% else %}{% for item in $.trustedAccounts.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^[0-9]{12}|^\\*$"
  }
}

AWS > S3 > Trusted Identity Providers [Default]

List of AWS Identity Providers that are trusted for access in the AWS S3 policy.

This policy is used by the Trusted Access
control to determine which members of type "identity provider" are allowed
to be granted access. You may use the '*' and '?' wildcard characters.

<br />example:<br /> - &quot;www.amazon.com&quot;<br /> - &quot;graph.facebook.com&quot;<br />

Note: Setting the policy to Empty array will remove all identity providers.

URI
tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedIdentityProviders
Category
Parent
Targets
Default Template Input
"{\n  trustedIdentityProviders: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedIdentityProviders\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedIdentityProviders.value | length == 0 %}[]{% else %}{% for item in $.trustedIdentityProviders.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > S3 > Trusted Organizations [Default]

List of AWS Organizations that are trusted for access in the AWS S3 policy.

This policy is used by the Trusted Access
control to determine which members of type "organization" are allowed
to be granted access. You may use the '*' and '?' wildcard characters.

<br />example:<br /> - &quot;o-333333333&quot;<br /> - &quot;o-c3a5y4wd52&quot;<br />

Note: Trusted Access > Organization Restrictions are ONLY
applied to AWS principals. Services and Federated principals do
NOT contain the aws:PrincipalOrgId condition key, and thus
cannot be validated against the Organization.

Setting the policy to Empty array will remove all organizations.

URI
tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedOrganizations
Category
Parent
Targets
Default Template Input
"{\n  trustedOrganizations: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedOrganizations\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedOrganizations.value | length == 0 %}[]{% else %}{% for item in $.trustedOrganizations.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)"
  }
}

AWS > S3 > Trusted Services [Default]

List of AWS Services that are trusted for access in the AWS S3 policy.

This policy is used by the Trusted Access
control to determine which members of type "service" are allowed
to be granted access. You may use the '*' and '?' wildcard characters.

<br />example:<br /> - &quot;sns.amazonaws.com&quot;<br /> - &quot;ec2.amazonaws.com&quot;<br />

Note: Setting the policy to Empty array will remove all services.

URI
tmod:@turbot/aws-s3#/policy/types/s3PolicyTrustedServices
Category
Parent
Targets
Default Template Input
"{\n  trustedServices: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedServices\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedServices.value | length == 0 %}[]{% else %}{% for item in $.trustedServices.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)"
  }
}

AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-s3

The CloudWatch Events event pattern used by the AWS S3 module to specify
which events to forward to the Guardrails Event Handlers.

URI
tmod:@turbot/aws-s3#/policy/types/s3CustomEventPatterns
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "type": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          }
        }
      },
      "value": {
        "type": "object",
        "properties": {
          "source": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "detail-type": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "detail": {
            "type": "object",
            "property": {
              "eventName": {
                "type": "array"
              }
            },
            "required": [
              "eventName"
            ]
          }
        },
        "required": [
          "source"
        ]
      }
    },
    "required": [
      "type"
    ]
  },
  "default": [
    {
      "type": {
        "title": "S3",
        "name": "s3"
      },
      "value": {
        "source": [
          "aws.s3"
        ],
        "detail-type": [
          "AWS API Call via CloudTrail"
        ],
        "detail": {
          "eventName": [
            "CreateBucket",
            "DeleteBucket",
            "DeleteBucketCors",
            "DeleteBucketEncryption",
            "DeleteBucketLifecycle",
            "DeleteBucketPolicy",
            "DeleteBucketReplication",
            "DeleteBucketTagging",
            "DeleteBucketWebsite",
            "DeletePublicAccessBlock",
            "PutAccountPublicAccessBlock",
            "PutBucketAcl",
            "PutBucketCors",
            "PutBucketEncryption",
            "PutBucketIntelligentTieringConfiguration",
            "PutBucketLifecycle",
            "PutBucketLogging",
            "PutBucketNotification",
            "PutBucketObjectLockConfiguration",
            "PutBucketPolicy",
            "PutBucketPublicAccessBlock",
            "PutBucketReplication",
            "PutBucketRequestPayment",
            "PutBucketTagging",
            "PutBucketVersioning",
            "PutBucketWebsite",
            "PutPublicAccessBlock"
          ]
        }
      }
    }
  ]
}

AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-s3

A read-only policy generated by Guardrails that lists the APIs that
should be added to the turbot-managed (hard) boundary policy,
thereby enabling them to be assigned to users and roles.

This value will change depending on the value of the value of the
AWS > S3 > Permissions > Lockdown > API Boundary policy

URI
tmod:@turbot/aws-s3#/policy/types/awsCompiledApiBoundary
Category
Parent
Targets
Schema
{
  "type": "array"
}

AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-s3

A calculated policy that Guardrails uses to create a compiled list
of ALL permissions for AWS S3 that is used as input to the
stack that manages the Guardrails IAM permissions objects.

URI
tmod:@turbot/aws-s3#/policy/types/awsLevelsCompiled
Category
Parent
Targets
Schema

AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-s3

A calculated policy that Guardrails uses to create a compiled
list of ALL permissions for AWS S3 that is used as input
to the control that manages the IAM stack.

URI
tmod:@turbot/aws-s3#/policy/types/awsCompiledServicePermissions
Category
Parent
Targets
Schema