Skip to main content

Pyrae::IAM::Bundle Reference

Quick Type Reference​

export interface PyraeIAMBundle {
    Name?: string;
    Owner: {
        TeamUrn?: string;
    } | {
        BundleUrn?: string;
    };
}

PyraeIAMBundle​

Bundles are a unit of ownership and consist of a collection of Resources. If Resources are files, then Bundles are folders. Bundles are owned by Teams or other Bundles and form Bundle trees, with the root of every tree being a Team.

Name​

Description: The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end

Required: No

Location: $.PyraeIAMBundle.Name

Type: export type Name = string;

Owner​

Description: The Owner object requires either a 'TeamUrn' or 'BundleUrn' subfield, dictated by the ownership mode.

Required: Yes

Location: $.PyraeIAMBundle.Owner

Type: 

export type Owner = {
    TeamUrn?: string;
} | {
    BundleUrn?: string;
};

JSON Schema​

{
  "$ref": "#/definitions/PyraeIAMBundle",
  "definitions": {
    "PyraeIAMBundle": {
      "type": "object",
      "properties": {
        "Name": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end"
        },
        "Owner": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "TeamUrn": {
                  "anyOf": [
                    {
                      "type": "string"
                    }
                  ]
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "BundleUrn": {
                  "anyOf": [
                    {
                      "type": "string"
                    }
                  ]
                }
              },
              "additionalProperties": false
            }
          ],
          "description": "The Owner object requires either a 'TeamUrn' or 'BundleUrn' subfield, dictated by the ownership mode."
        }
      },
      "required": [
        "Owner"
      ],
      "additionalProperties": false,
      "description": "Bundles are a unit of ownership and consist of a collection of Resources. If Resources are files, then Bundles are folders. Bundles are owned by Teams or other Bundles and form Bundle trees, with the root of every tree being a Team."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}