Skip to main content

Pyrae::Policy::PolicyDocument::Signatory Reference

Quick Type Reference​

export interface PyraePolicyPolicyDocumentSignatory {
    Name?: string;
    SignatureTeamUrn: string;
    PolicyDocumentUrn?: string;
    PolicyUrn?: string;
}

PyraePolicyPolicyDocumentSignatory​

A Policy Signature activates a specific Policy for a signing Team and all its sub-Teams. When Observances are produced, a Policy is only evaluated if a Signature exists for the Team that owns the Resource.

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: $.PyraePolicyPolicyDocumentSignatory.Name

Type: export type Name = string;

SignatureTeamUrn​

Description: The URN of the Team that is bound by this Signature, and will have the Policy evaluated against their Resources.

Required: Yes

Location: $.PyraePolicyPolicyDocumentSignatory.SignatureTeamUrn

Type: export type SignatureTeamUrn = string;

PolicyDocumentUrn​

Description: The 'document' concept is in need of substantial refactoring. Please do not use this for the time being.

Required: No

Location: $.PyraePolicyPolicyDocumentSignatory.PolicyDocumentUrn

Type: export type PolicyDocumentUrn = string;

PolicyUrn​

Description: The URN of the Policy that is activated for the specified Team.

Required: No

Location: $.PyraePolicyPolicyDocumentSignatory.PolicyUrn

Type: export type PolicyUrn = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraePolicyPolicyDocumentSignatory",
  "definitions": {
    "PyraePolicyPolicyDocumentSignatory": {
      "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"
        },
        "SignatureTeamUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the Team that is bound by this Signature, and will have the Policy evaluated against their Resources."
        },
        "PolicyDocumentUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The 'document' concept is in need of substantial refactoring. Please do not use this for the time being."
        },
        "PolicyUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the Policy that is activated for the specified Team."
        }
      },
      "required": [
        "SignatureTeamUrn"
      ],
      "additionalProperties": false,
      "description": "A Policy Signature activates a specific Policy for a signing Team and all its sub-Teams. When Observances are produced, a Policy is only evaluated if a Signature exists for the Team that owns the Resource."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}