Skip to main content

Pyrae::Account::Account Reference

Quick Type Reference​

export interface PyraeAccountAccount {
    Name?: string;
    MatchResourcePartition: string;
    MatchResourceAccountId: string;
    OwnerMatchingStrategy: string;
    DefaultOwnerBundleUrn: string;
    MetadataJson?: string;
}

PyraeAccountAccount​

The Account object represents and manages a customer's third-party account, such as with AWS. It handles lifecycle and authentication. After creating an Account resource in Pyrae, additional steps may be required to ensure a complete connection (eg, the AWS account setup workflow).

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

Type: export type Name = string;

MatchResourcePartition​

Description: In arn:aws:sns:us-west-2:012345678901:MyTopic, aws is the partition. See Amazon Resource Names for more details.

Required: Yes

Location: $.PyraeAccountAccount.MatchResourcePartition

Type: export type MatchResourcePartition = string;

MatchResourceAccountId​

Description: In arn:aws:sns:us-west-2:012345678901:MyTopic,012345678901 is the account ID. See Amazon Resource Names for more details.

Required: Yes

Location: $.PyraeAccountAccount.MatchResourceAccountId

Type: export type MatchResourceAccountId = string;

OwnerMatchingStrategy​

Description: Designates the owner identification method for account resources. The valid strategies include:

  • ALL_INTO_ONE_BUNDLE - Consolidates resources into one bundle, specified in defaultOwnerBundleUrn
  • GET_BUNDLE_FROM_TAG - Identifies the owner bundle name or bundle URN from the pyrae:OwnerTag on the AWS resource.
  • EXECUTE_CUSTOM_LAMBDA - Runs a custom Lambda function for owner determination.

Required: Yes

Location: $.PyraeAccountAccount.OwnerMatchingStrategy

Type: export type OwnerMatchingStrategy = string;

DefaultOwnerBundleUrn​

Description: The URN of the bundle owner that resources are assigned to when the OwnerMatchingStrategy fails (e.g. the resource's owner tag is not set).

Required: Yes

Location: $.PyraeAccountAccount.DefaultOwnerBundleUrn

Type: export type DefaultOwnerBundleUrn = string;

MetadataJson​

Description: Account metadata is available to Observers during executions. For AWS accounts, a non-overridable ExternalId attribute is set within this metadata.

Required: No

Location: $.PyraeAccountAccount.MetadataJson

Type: export type MetadataJson = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraeAccountAccount",
  "definitions": {
    "PyraeAccountAccount": {
      "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"
        },
        "MatchResourcePartition": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "In `arn:aws:sns:us-west-2:012345678901:MyTopic`, `aws` is the partition. See [Amazon Resource Names](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) for more details."
        },
        "MatchResourceAccountId": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "In `arn:aws:sns:us-west-2:012345678901:MyTopic`,`012345678901` is the account ID. See [Amazon Resource Names](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) for more details."
        },
        "OwnerMatchingStrategy": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "Designates the owner identification method for account resources. The valid strategies include:\n* `ALL_INTO_ONE_BUNDLE` - Consolidates resources into one bundle, specified in `defaultOwnerBundleUrn`\n* `GET_BUNDLE_FROM_TAG` - Identifies the owner bundle name or bundle URN from the `pyrae:OwnerTag` on the AWS resource.\n* `EXECUTE_CUSTOM_LAMBDA` - Runs a custom Lambda function for owner determination."
        },
        "DefaultOwnerBundleUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the bundle owner that resources are assigned to when the OwnerMatchingStrategy fails (e.g. the resource's owner tag is not set)."
        },
        "MetadataJson": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "Account metadata is available to Observers during executions. For AWS accounts, a non-overridable ExternalId attribute is set within this metadata."
        }
      },
      "required": [
        "MatchResourcePartition",
        "MatchResourceAccountId",
        "OwnerMatchingStrategy",
        "DefaultOwnerBundleUrn"
      ],
      "additionalProperties": false,
      "description": "The Account object represents and manages a customer's third-party account, such as with AWS. It handles lifecycle and authentication. After creating an Account resource in Pyrae, additional steps may be required to ensure a complete connection (eg, the AWS account setup workflow)."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}