Amazon IAM Access Analyzer · JSON Structure

Iam Access Analyzer Trail Structure

Contains details about the CloudTrail trail being analyzed to generate a policy.

Type: object Properties: 3 Required: 1
Access ControlComplianceIAMPolicy ManagementSecurity

Trail is a JSON Structure definition published by Amazon IAM Access Analyzer, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cloudTrailArn regions allRegions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-access-analyzer/refs/heads/main/json-structure/iam-access-analyzer-trail-structure.json",
  "name": "Trail",
  "description": "Contains details about the CloudTrail trail being analyzed to generate a policy.",
  "type": "object",
  "properties": {
    "cloudTrailArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CloudTrailArn"
        },
        {
          "description": "Specifies the ARN of the trail. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>."
        }
      ]
    },
    "regions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RegionList"
        },
        {
          "description": "A list of regions to get CloudTrail data from and analyze to generate a policy."
        }
      ]
    },
    "allRegions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Possible values are <code>true</code> or <code>false</code>. If set to <code>true</code>, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy."
        }
      ]
    }
  },
  "required": [
    "cloudTrailArn"
  ]
}