# API Reference ## Constructs ### Account - *Implements:* IAccount, ITaggableResource Creates or imports an AWS account that is automatically a member of the organization whose credentials made the request. AWS Organizations automatically copies the information from the management account to the new member account #### Initializers ```typescript import { Account } from '@rocketleap/cdk-organizations' new Account(scope: Construct, id: string, props: AccountProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AccountProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AccountProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | attachPolicy | Attach a policy. | | delegateAdministrator | Enables trusted access for the AWS service (trusted service) as Delegated Administrator, which performs tasks in your organization and its accounts on your behalf. | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` ```typescript public attachPolicy(policy: IPolicy): void ``` Attach a policy. Before you can attach the policy, you must enable that policy type for use. You can use policies when you have all features enabled. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html) ###### `policy`Required - *Type:* IPolicy --- ##### `delegateAdministrator` ```typescript public delegateAdministrator(servicePrincipal: string, region?: string, props?: {[ key: string ]: any}): void ``` Enables trusted access for the AWS service (trusted service) as Delegated Administrator, which performs tasks in your organization and its accounts on your behalf. ###### `servicePrincipal`Required - *Type:* string The supported AWS service that you specify. --- ###### `region`Optional - *Type:* string The region to delegate in. --- ###### `props`Optional - *Type:* {[ key: string ]: any} additional DelegatedAdministrator props. --- ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Account } from '@rocketleap/cdk-organizations' Account.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | accountArn | string | The Amazon Resource Name (ARN) of the account. | | accountId | string | If the account was created successfully, the unique identifier (ID) of the new account. | | accountName | string | The friendly name of the account. | | email | string | The email address of the owner to assign to the new member account. | | tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `accountArn`Required ```typescript public readonly accountArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the account. --- ##### `accountId`Required ```typescript public readonly accountId: string; ``` - *Type:* string If the account was created successfully, the unique identifier (ID) of the new account. Exactly 12 digits. --- ##### `accountName`Required ```typescript public readonly accountName: string; ``` - *Type:* string The friendly name of the account. --- ##### `email`Required ```typescript public readonly email: string; ``` - *Type:* string The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### DelegatedAdministrator Enables the specified member account to administer the Organizations features of the specified AWS service. It grants read-only access to AWS Organizations service data. The account still requires IAM permissions to access and administer the AWS service. You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at AWS Services that you can use with AWS Organizations in the [AWS Organizations User Guide](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html). > [https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-delegated-admin.html](https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-delegated-admin.html) #### Initializers ```typescript import { DelegatedAdministrator } from '@rocketleap/cdk-organizations' new DelegatedAdministrator(scope: Construct, id: string, props: DelegatedAdministratorProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DelegatedAdministratorProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* DelegatedAdministratorProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DelegatedAdministrator } from '@rocketleap/cdk-organizations' DelegatedAdministrator.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### EnableAwsServiceAccess Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts. This operation can be called only from the organization's management account and only if the organization has enabled all features. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_trusted_access_perms](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_trusted_access_perms) #### Initializers ```typescript import { EnableAwsServiceAccess } from '@rocketleap/cdk-organizations' new EnableAwsServiceAccess(scope: Construct, id: string, props: EnableAwsServiceAccessProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | EnableAwsServiceAccessProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* EnableAwsServiceAccessProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { EnableAwsServiceAccess } from '@rocketleap/cdk-organizations' EnableAwsServiceAccess.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### EnablePolicyType Enables and disables Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html) #### Initializers ```typescript import { EnablePolicyType } from '@rocketleap/cdk-organizations' new EnablePolicyType(scope: Construct, id: string, props: EnablePolicyTypeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | EnablePolicyTypeProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* EnablePolicyTypeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { EnablePolicyType } from '@rocketleap/cdk-organizations' EnablePolicyType.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### Organization - *Implements:* IOrganization #### Initializers ```typescript import { Organization } from '@rocketleap/cdk-organizations' new Organization(scope: Construct, id: string, props?: OrganizationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | OrganizationProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Optional - *Type:* OrganizationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | attachPolicy | Attach a policy. | | enableAwsServiceAccess | Enables trusted access for a supported AWS service (trusted service), which performs tasks in your organization and its accounts on your behalf. | | enablePolicyType | Enables policy types in the following two broad categories: Authorization policies and Management policies. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` ```typescript public attachPolicy(policy: IPolicy): void ``` Attach a policy. Before you can attach the policy, you must enable that policy type for use. You can use policies when you have all features enabled. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html) ###### `policy`Required - *Type:* IPolicy --- ##### `enableAwsServiceAccess` ```typescript public enableAwsServiceAccess(servicePrincipal: string): void ``` Enables trusted access for a supported AWS service (trusted service), which performs tasks in your organization and its accounts on your behalf. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) ###### `servicePrincipal`Required - *Type:* string The supported AWS service that you specify. --- ##### `enablePolicyType` ```typescript public enablePolicyType(policyType: PolicyType): void ``` Enables policy types in the following two broad categories: Authorization policies and Management policies. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#orgs-policy-types](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#orgs-policy-types) ###### `policyType`Required - *Type:* PolicyType : the type of the policy that you specify. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | of | Describe the organization that the current account belongs to. | --- ##### `isConstruct` ```typescript import { Organization } from '@rocketleap/cdk-organizations' Organization.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- ##### `of` ```typescript import { Organization } from '@rocketleap/cdk-organizations' Organization.of(scope: Construct, id: string) ``` Describe the organization that the current account belongs to. > [https://docs.aws.amazon.com/organizations/latest/APIReference/API_DescribeOrganization.html](https://docs.aws.amazon.com/organizations/latest/APIReference/API_DescribeOrganization.html) ###### `scope`Required - *Type:* constructs.Construct --- ###### `id`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | featureSet | FeatureSet | Specifies the functionality that currently is available to the organization. | | managementAccountArn | string | The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. | | managementAccountEmail | string | The email address that is associated with the AWS account that is designated as the management account for the organization. | | managementAccountId | string | The unique identifier (ID) of the management account of an organization. | | organizationArn | string | The Amazon Resource Name (ARN) of an organization. | | organizationId | string | The unique identifier (ID) of an organization. | | principal | aws-cdk-lib.aws_iam.IPrincipal | The principal that represents this AWS Organization. | | root | Root | The root of the current organization, which is automatically created. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `featureSet`Required ```typescript public readonly featureSet: FeatureSet; ``` - *Type:* FeatureSet Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. --- ##### `managementAccountArn`Required ```typescript public readonly managementAccountArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. --- ##### `managementAccountEmail`Required ```typescript public readonly managementAccountEmail: string; ``` - *Type:* string The email address that is associated with the AWS account that is designated as the management account for the organization. --- ##### `managementAccountId`Required ```typescript public readonly managementAccountId: string; ``` - *Type:* string The unique identifier (ID) of the management account of an organization. --- ##### `organizationArn`Required ```typescript public readonly organizationArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of an organization. --- ##### `organizationId`Required ```typescript public readonly organizationId: string; ``` - *Type:* string The unique identifier (ID) of an organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. --- ##### `principal`Required ```typescript public readonly principal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal that represents this AWS Organization. --- ##### `root`Required ```typescript public readonly root: Root; ``` - *Type:* Root The root of the current organization, which is automatically created. --- ### OrganizationalUnit - *Implements:* IOrganizationalUnit, ITaggableResource #### Initializers ```typescript import { OrganizationalUnit } from '@rocketleap/cdk-organizations' new OrganizationalUnit(scope: Construct, id: string, props: OrganizationalUnitProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | OrganizationalUnitProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* OrganizationalUnitProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | attachPolicy | Attach a policy. | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` ```typescript public attachPolicy(policy: IPolicy): void ``` Attach a policy. Before you can attach the policy, you must enable that policy type for use. You can use policies when you have all features enabled. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html) ###### `policy`Required - *Type:* IPolicy --- ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { OrganizationalUnit } from '@rocketleap/cdk-organizations' OrganizationalUnit.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | organizationalUnitArn | string | The Amazon Resource Name (ARN) of this OU. | | organizationalUnitId | string | The unique identifier (ID) associated with this OU. | | organizationalUnitName | string | The friendly name of this OU. | | tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `organizationalUnitArn`Required ```typescript public readonly organizationalUnitArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of this OU. For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) in the AWS Service Authorization Reference. --- ##### `organizationalUnitId`Required ```typescript public readonly organizationalUnitId: string; ``` - *Type:* string The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. --- ##### `organizationalUnitName`Required ```typescript public readonly organizationalUnitName: string; ``` - *Type:* string The friendly name of this OU. --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### Parent #### Initializers ```typescript import { Parent } from '@rocketleap/cdk-organizations' new Parent(scope: Construct, id: string, props: ParentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ParentProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ParentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromChildId | *No description.* | --- ##### `isConstruct` ```typescript import { Parent } from '@rocketleap/cdk-organizations' Parent.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- ##### `fromChildId` ```typescript import { Parent } from '@rocketleap/cdk-organizations' Parent.fromChildId(scope: Construct, id: string, childId: string) ``` ###### `scope`Required - *Type:* constructs.Construct --- ###### `id`Required - *Type:* string --- ###### `childId`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | parentId | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `parentId`Required ```typescript public readonly parentId: string; ``` - *Type:* string --- ### ParentBase - *Implements:* IParent #### Initializers ```typescript import { ParentBase } from '@rocketleap/cdk-organizations' new ParentBase(scope: Construct, id: string, props: ParentBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ParentBaseProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ParentBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ParentBase } from '@rocketleap/cdk-organizations' ParentBase.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | parentId | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `parentId`Required ```typescript public readonly parentId: string; ``` - *Type:* string --- ### Policy - *Implements:* IPolicy, ITaggableResource #### Initializers ```typescript import { Policy } from '@rocketleap/cdk-organizations' new Policy(scope: Construct, id: string, props: PolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PolicyProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* PolicyProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | identifier | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` ```typescript public identifier(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Policy } from '@rocketleap/cdk-organizations' Policy.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | policyId | string | The unique identifier (ID) of the policy. | | tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `policyId`Required ```typescript public readonly policyId: string; ``` - *Type:* string The unique identifier (ID) of the policy. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### PolicyAttachment Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the AWS Organizations User Guide for information about each policy type: #### Initializers ```typescript import { PolicyAttachment } from '@rocketleap/cdk-organizations' new PolicyAttachment(scope: Construct, id: string, props: PolicyAttachmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PolicyAttachmentProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* PolicyAttachmentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { PolicyAttachment } from '@rocketleap/cdk-organizations' PolicyAttachment.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### Root - *Implements:* IParent, IPolicyAttachmentTarget, ITaggableResource The parent container for all the accounts for your organization. If you apply a policy to the root, it applies to all organizational units (OUs) and accounts in the organization. Currently, you can have only one root. AWS Organizations automatically creates it for you when you create an organization. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html) #### Initializers ```typescript import { Root } from '@rocketleap/cdk-organizations' new Root(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | attachPolicy | Attach a policy. | | enablePolicyType | Enables and disables Enables a policy type. | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` ```typescript public attachPolicy(policy: IPolicy): void ``` Attach a policy. Before you can attach the policy, you must enable that policy type for use. You can use policies when you have all features enabled. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html) ###### `policy`Required - *Type:* IPolicy --- ##### `enablePolicyType` ```typescript public enablePolicyType(policyType: PolicyType): void ``` Enables and disables Enables a policy type. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html) ###### `policyType`Required - *Type:* PolicyType --- ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Root } from '@rocketleap/cdk-organizations' Root.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | rootId | string | The unique identifier (ID) for the root. | | tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `rootId`Required ```typescript public readonly rootId: string; ``` - *Type:* string The unique identifier (ID) for the root. The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits. --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### TagResource Add tags to an AWS Organizations resource to make it easier to identify, organize, and search. > [https://docs.aws.amazon.com/ARG/latest/APIReference/API_Tag.html](https://docs.aws.amazon.com/ARG/latest/APIReference/API_Tag.html) #### Initializers ```typescript import { TagResource } from '@rocketleap/cdk-organizations' new TagResource(scope: Construct, id: string, props: TagResourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | TagResourceProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* TagResourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { TagResource } from '@rocketleap/cdk-organizations' TagResource.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ## Structs ### AccountProps #### Initializer ```typescript import { AccountProps } from '@rocketleap/cdk-organizations' const accountProps: AccountProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accountName | string | The friendly name of the member account. | | email | string | The email address of the owner to assign to the new member account. | | iamUserAccessToBilling | IamUserAccessToBilling | If set to ALLOW , the new account enables IAM users to access account billing information if they have the required permissions. | | importOnDuplicate | boolean | Whether to import, if a duplicate account with same name and email already exists. | | parent | IParent | The parent root or OU that you want to create the new Account in. | | removalPolicy | aws-cdk-lib.RemovalPolicy | If set to RemovalPolicy.DESTROY, the account will be moved to the root. | | roleName | string | The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. | --- ##### `accountName`Required ```typescript public readonly accountName: string; ``` - *Type:* string The friendly name of the member account. --- ##### `email`Required ```typescript public readonly email: string; ``` - *Type:* string The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. --- ##### `iamUserAccessToBilling`Optional ```typescript public readonly iamUserAccessToBilling: IamUserAccessToBilling; ``` - *Type:* IamUserAccessToBilling - *Default:* ALLOW If set to ALLOW , the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY , only the root user of the new account can access account billing information. --- ##### `importOnDuplicate`Optional ```typescript public readonly importOnDuplicate: boolean; ``` - *Type:* boolean - *Default:* true Whether to import, if a duplicate account with same name and email already exists. --- ##### `parent`Optional ```typescript public readonly parent: IParent; ``` - *Type:* IParent The parent root or OU that you want to create the new Account in. --- ##### `removalPolicy`Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.Retain If set to RemovalPolicy.DESTROY, the account will be moved to the root. --- ##### `roleName`Optional ```typescript public readonly roleName: string; ``` - *Type:* string The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole. --- ### DelegatedAdministratorProps #### Initializer ```typescript import { DelegatedAdministratorProps } from '@rocketleap/cdk-organizations' const delegatedAdministratorProps: DelegatedAdministratorProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | IAccount | The member account in the organization to register as a delegated administrator. | | servicePrincipal | string | The service principal of the AWS service for which you want to make the member account a delegated administrator. | | region | string | The region to delegate the administrator in. | | removalPolicy | aws-cdk-lib.RemovalPolicy | If set to RemovalPolicy.RETAIN, the delegation will not be removed. | --- ##### `account`Required ```typescript public readonly account: IAccount; ``` - *Type:* IAccount The member account in the organization to register as a delegated administrator. --- ##### `servicePrincipal`Required ```typescript public readonly servicePrincipal: string; ``` - *Type:* string The service principal of the AWS service for which you want to make the member account a delegated administrator. --- ##### `region`Optional ```typescript public readonly region: string; ``` - *Type:* string The region to delegate the administrator in. --- ##### `removalPolicy`Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.DESTROY If set to RemovalPolicy.RETAIN, the delegation will not be removed. --- ### EnableAwsServiceAccessProps #### Initializer ```typescript import { EnableAwsServiceAccessProps } from '@rocketleap/cdk-organizations' const enableAwsServiceAccessProps: EnableAwsServiceAccessProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | servicePrincipal | string | The service principal name of the AWS service for which you want to enable integration with your organization. | --- ##### `servicePrincipal`Required ```typescript public readonly servicePrincipal: string; ``` - *Type:* string The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. --- ### EnablePolicyTypeProps #### Initializer ```typescript import { EnablePolicyTypeProps } from '@rocketleap/cdk-organizations' const enablePolicyTypeProps: EnablePolicyTypeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | policyType | PolicyType | *No description.* | | root | Root | *No description.* | --- ##### `policyType`Required ```typescript public readonly policyType: PolicyType; ``` - *Type:* PolicyType --- ##### `root`Required ```typescript public readonly root: Root; ``` - *Type:* Root --- ### OrganizationalUnitProps #### Initializer ```typescript import { OrganizationalUnitProps } from '@rocketleap/cdk-organizations' const organizationalUnitProps: OrganizationalUnitProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | organizationalUnitName | string | The friendly name to assign to the new OU. | | parent | IParent | The parent root or OU that you want to create the new OrganizationalUnit in. | | importOnDuplicate | boolean | Whether to import, if a duplicate organizational unit with same name exists in the parent exists. | | removalPolicy | aws-cdk-lib.RemovalPolicy | If set to RemovalPolicy.DESTROY, the organizational unit will be deleted. | --- ##### `organizationalUnitName`Required ```typescript public readonly organizationalUnitName: string; ``` - *Type:* string The friendly name to assign to the new OU. --- ##### `parent`Required ```typescript public readonly parent: IParent; ``` - *Type:* IParent The parent root or OU that you want to create the new OrganizationalUnit in. --- ##### `importOnDuplicate`Optional ```typescript public readonly importOnDuplicate: boolean; ``` - *Type:* boolean - *Default:* true Whether to import, if a duplicate organizational unit with same name exists in the parent exists. --- ##### `removalPolicy`Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.Retain If set to RemovalPolicy.DESTROY, the organizational unit will be deleted. --- ### OrganizationProps #### Initializer ```typescript import { OrganizationProps } from '@rocketleap/cdk-organizations' const organizationProps: OrganizationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | featureSet | FeatureSet | Enabling features in your organization. | --- ##### `featureSet`Optional ```typescript public readonly featureSet: FeatureSet; ``` - *Type:* FeatureSet - *Default:* ALL Enabling features in your organization. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) --- ### ParentBaseProps #### Initializer ```typescript import { ParentBaseProps } from '@rocketleap/cdk-organizations' const parentBaseProps: ParentBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | childId | string | *No description.* | --- ##### `childId`Required ```typescript public readonly childId: string; ``` - *Type:* string --- ### ParentProps #### Initializer ```typescript import { ParentProps } from '@rocketleap/cdk-organizations' const parentProps: ParentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | child | IChild | *No description.* | --- ##### `child`Required ```typescript public readonly child: IChild; ``` - *Type:* IChild --- ### PolicyAttachmentProps #### Initializer ```typescript import { PolicyAttachmentProps } from '@rocketleap/cdk-organizations' const policyAttachmentProps: PolicyAttachmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | policy | IPolicy | The policy that you want to attach to the target. | | target | IPolicyAttachmentTarget | The root, OU, or account that you want to attach the policy to. | --- ##### `policy`Required ```typescript public readonly policy: IPolicy; ``` - *Type:* IPolicy The policy that you want to attach to the target. --- ##### `target`Required ```typescript public readonly target: IPolicyAttachmentTarget; ``` - *Type:* IPolicyAttachmentTarget The root, OU, or account that you want to attach the policy to. --- ### PolicyProps #### Initializer ```typescript import { PolicyProps } from '@rocketleap/cdk-organizations' const policyProps: PolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | content | string | The policy text content to add to the new policy. | | policyName | string | The friendly name to assign to the policy. | | policyType | PolicyType | The type of policy to create. | | description | string | An optional description to assign to the policy. | --- ##### `content`Required ```typescript public readonly content: string; ``` - *Type:* string The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter. --- ##### `policyName`Required ```typescript public readonly policyName: string; ``` - *Type:* string The friendly name to assign to the policy. --- ##### `policyType`Required ```typescript public readonly policyType: PolicyType; ``` - *Type:* PolicyType The type of policy to create. You can specify one of the following values: --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string An optional description to assign to the policy. --- ### TagResourceProps #### Initializer ```typescript import { TagResourceProps } from '@rocketleap/cdk-organizations' const tagResourceProps: TagResourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resourceId | string | *No description.* | | tags | aws-cdk-lib.IResolvable | *No description.* | --- ##### `resourceId`Required ```typescript public readonly resourceId: string; ``` - *Type:* string --- ##### `tags`Required ```typescript public readonly tags: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable --- ## Classes ### DependencyChain - *Implements:* aws-cdk-lib.IAspect Aspect to create dependency chain of organization resource that needs to be deployed sequentially. #### Initializers ```typescript import { DependencyChain } from '@rocketleap/cdk-organizations' new DependencyChain() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | visit | All aspects can visit an IConstruct. | --- ##### `visit` ```typescript public visit(current: IConstruct): void ``` All aspects can visit an IConstruct. ###### `current`Required - *Type:* constructs.IConstruct --- ### Validators #### Initializers ```typescript import { Validators } from '@rocketleap/cdk-organizations' new Validators() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | accountId | *No description.* | | accountName | *No description.* | | email | *No description.* | | organizationalUnitName | *No description.* | | policyContent | *No description.* | | servicePrincipal | *No description.* | --- ##### `accountId` ```typescript public accountId(id: string): boolean ``` ###### `id`Required - *Type:* string --- ##### `accountName` ```typescript public accountName(name: string): boolean ``` ###### `name`Required - *Type:* string --- ##### `email` ```typescript public email(email: string): boolean ``` ###### `email`Required - *Type:* string --- ##### `organizationalUnitName` ```typescript public organizationalUnitName(name: string): boolean ``` ###### `name`Required - *Type:* string --- ##### `policyContent` ```typescript public policyContent(content: string): boolean ``` ###### `content`Required - *Type:* string --- ##### `servicePrincipal` ```typescript public servicePrincipal(servicePrincipal: string): boolean ``` ###### `servicePrincipal`Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { Validators } from '@rocketleap/cdk-organizations' Validators.of() ``` ## Protocols ### IAccount - *Extends:* IPolicyAttachmentTarget, IChild, constructs.IConstruct, IResource - *Implemented By:* Account, IAccount #### Methods | **Name** | **Description** | | --- | --- | | delegateAdministrator | Enables trusted access for the AWS service (trusted service) as Delegated Administrator, which performs tasks in your organization and its accounts on your behalf. | --- ##### `delegateAdministrator` ```typescript public delegateAdministrator(servicePrincipal: string, region?: string, props?: {[ key: string ]: any}): void ``` Enables trusted access for the AWS service (trusted service) as Delegated Administrator, which performs tasks in your organization and its accounts on your behalf. ###### `servicePrincipal`Required - *Type:* string The supported AWS service that you specify. --- ###### `region`Optional - *Type:* string The region to delegate in. --- ###### `props`Optional - *Type:* {[ key: string ]: any} additional DelegatedAdministrator props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | accountArn | string | The Amazon Resource Name (ARN) of the account. | | accountId | string | If the account was created successfully, the unique identifier (ID) of the new account. | | accountName | string | The friendly name of the account. | | email | string | The email address of the owner to assign to the new member account. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `accountArn`Required ```typescript public readonly accountArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the account. --- ##### `accountId`Required ```typescript public readonly accountId: string; ``` - *Type:* string If the account was created successfully, the unique identifier (ID) of the new account. Exactly 12 digits. --- ##### `accountName`Required ```typescript public readonly accountName: string; ``` - *Type:* string The friendly name of the account. --- ##### `email`Required ```typescript public readonly email: string; ``` - *Type:* string The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. --- ### IChild - *Extends:* constructs.IConstruct, IResource - *Implemented By:* Account, OrganizationalUnit, IAccount, IChild, IOrganizationalUnit #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### IOrganization - *Extends:* constructs.IConstruct - *Implemented By:* Organization, IOrganization Creates an organization to consolidate your AWS accounts so that you can administer them as a single unit. An organization has one management account along with zero or more member accounts. You can organize the accounts in a hierarchical, tree-like structure with a root at the top and organizational units nested under the root. Each account can be directly in the root, or placed in one of the OUs in the hierarchy. An organization has the functionality that is determined by the feature set that you enable. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization. For deletion of an organization you must previously remove all the member accounts, OUs, and policies from the organization! > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_create.html#create-org](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_create.html#create-org) #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | featureSet | FeatureSet | Specifies the functionality that currently is available to the organization. | | managementAccountArn | string | The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. | | managementAccountEmail | string | The email address that is associated with the AWS account that is designated as the management account for the organization. | | managementAccountId | string | The unique identifier (ID) of the management account of an organization. | | organizationArn | string | The Amazon Resource Name (ARN) of an organization. | | organizationId | string | The unique identifier (ID) of an organization. | | principal | aws-cdk-lib.aws_iam.IPrincipal | The principal that represents this AWS Organization. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `featureSet`Required ```typescript public readonly featureSet: FeatureSet; ``` - *Type:* FeatureSet Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. --- ##### `managementAccountArn`Required ```typescript public readonly managementAccountArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. --- ##### `managementAccountEmail`Required ```typescript public readonly managementAccountEmail: string; ``` - *Type:* string The email address that is associated with the AWS account that is designated as the management account for the organization. --- ##### `managementAccountId`Required ```typescript public readonly managementAccountId: string; ``` - *Type:* string The unique identifier (ID) of the management account of an organization. --- ##### `organizationArn`Required ```typescript public readonly organizationArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of an organization. --- ##### `organizationId`Required ```typescript public readonly organizationId: string; ``` - *Type:* string The unique identifier (ID) of an organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. --- ##### `principal`Required ```typescript public readonly principal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal that represents this AWS Organization. --- ### IOrganizationalUnit - *Extends:* IPolicyAttachmentTarget, IParent, IChild, constructs.IConstruct - *Implemented By:* OrganizationalUnit, IOrganizationalUnit A container for accounts within a root. An OU also can contain other OUs, enabling you to create a hierarchy that resembles an upside-down tree, with a root at the top and branches of OUs that reach down, ending in accounts that are the leaves of the tree. When you attach a policy to one of the nodes in the hierarchy, it flows down and affects all the branches (OUs) and leaves (accounts) beneath it. An OU can have exactly one parent, and currently each account can be a member of exactly one OU. You must first move all accounts out of the OU and any child OUs, and then you can delete the child OUs. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | organizationalUnitArn | string | The Amazon Resource Name (ARN) of this OU. | | organizationalUnitId | string | The unique identifier (ID) associated with this OU. | | organizationalUnitName | string | The friendly name of this OU. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `organizationalUnitArn`Required ```typescript public readonly organizationalUnitArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of this OU. For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) in the AWS Service Authorization Reference. --- ##### `organizationalUnitId`Required ```typescript public readonly organizationalUnitId: string; ``` - *Type:* string The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. --- ##### `organizationalUnitName`Required ```typescript public readonly organizationalUnitName: string; ``` - *Type:* string The friendly name of this OU. --- ### IParent - *Extends:* constructs.IConstruct, IResource - *Implemented By:* OrganizationalUnit, Parent, ParentBase, Root, IOrganizationalUnit, IParent #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### IPolicy - *Extends:* constructs.IConstruct - *Implemented By:* Policy, IPolicy Policies in AWS Organizations enable you to apply additional types of management to the AWS accounts in your organization. You can use policies when all features are enabled in your organization. Before you can create and attach a policy to your organization, you must enable that policy type for use. > [FeatureSet](FeatureSet) #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | policyId | string | The unique identifier (ID) of the policy. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `policyId`Required ```typescript public readonly policyId: string; ``` - *Type:* string The unique identifier (ID) of the policy. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_). --- ### IPolicyAttachmentTarget - *Extends:* constructs.IDependable, IResource - *Implemented By:* Account, OrganizationalUnit, Root, IAccount, IOrganizationalUnit, IPolicyAttachmentTarget ### IResource - *Implemented By:* Account, OrganizationalUnit, Parent, ParentBase, Root, IAccount, IChild, IOrganizationalUnit, IParent, IPolicyAttachmentTarget, IResource Interface for an AWS Organizations resource. #### Methods | **Name** | **Description** | | --- | --- | | identifier | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `identifier` ```typescript public identifier(): string ``` The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. ### ITaggableResource - *Extends:* aws-cdk-lib.ITaggable - *Implemented By:* Account, OrganizationalUnit, Policy, Root, ITaggableResource #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. | --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ## Enums ### FeatureSet Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set) #### Members | **Name** | **Description** | | --- | --- | | CONSOLIDATED_BILLING | All member accounts have their bills consolidated to and paid by the management account. | | ALL | In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. | --- ##### `CONSOLIDATED_BILLING` All member accounts have their bills consolidated to and paid by the management account. For more information, see [Consolidated billing](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only) in the AWS Organizations User Guide. The consolidated billing feature subset isn’t available for organizations in the AWS GovCloud (US) Region. --- ##### `ALL` In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see [All features](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all) in the AWS Organizations User Guide. --- ### IamUserAccessToBilling > [https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/control-access-billing.html#ControllingAccessWebsite-Activate](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/control-access-billing.html#ControllingAccessWebsite-Activate) #### Members | **Name** | **Description** | | --- | --- | | ALLOW | If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. | | DENY | If set to DENY, only the root user of the new account can access account billing information. | --- ##### `ALLOW` If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. --- ##### `DENY` If set to DENY, only the root user of the new account can access account billing information. --- ### PolicyType Organizations offers policy types in the following two broad categories:
  1. Authorization policies help you to centrally manage the security of the AWS accounts in your organization.
  2. Management policies enable you to centrally configure and manage AWS services and their features.
. > [https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#orgs-policy-types](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#orgs-policy-types) #### Members | **Name** | **Description** | | --- | --- | | SERVICE_CONTROL_POLICY | Service control policies (SCPs) offer central control over the maximum available permissions for all of the accounts in your organization. | | TAG_POLICY | Tag policies help you standardize the tags attached to the AWS resources in your organization's accounts. | | BACKUP_POLICY | Backup policies help you centrally manage and apply backup plans to the AWS resources across your organization's accounts. | | AISERVICES_OPT_OUT_POLICY | Artificial Intelligence (AI) services opt-out policies enable you to control data collection for AWS AI services for all of your organization's accounts. | | RESOURCE_CONTROL_POLICY | Resource control policies offer central control over the resource policies applied to all resources in your organization. | --- ##### `SERVICE_CONTROL_POLICY` Service control policies (SCPs) offer central control over the maximum available permissions for all of the accounts in your organization. --- ##### `TAG_POLICY` Tag policies help you standardize the tags attached to the AWS resources in your organization's accounts. --- ##### `BACKUP_POLICY` Backup policies help you centrally manage and apply backup plans to the AWS resources across your organization's accounts. --- ##### `AISERVICES_OPT_OUT_POLICY` Artificial Intelligence (AI) services opt-out policies enable you to control data collection for AWS AI services for all of your organization's accounts. --- ##### `RESOURCE_CONTROL_POLICY` Resource control policies offer central control over the resource policies applied to all resources in your organization. ---