@pepperize/cdk-organizations

# API Reference <a name="API Reference" id="api-reference"></a> ## Constructs <a name="Constructs" id="Constructs"></a> ### Account <a name="Account" id="@pepperize/cdk-organizations.Account"></a> - *Implements:* <a href="#@pepperize/cdk-organizations.IAccount">IAccount</a>, <a href="#@pepperize/cdk-organizations.ITaggableResource">ITaggableResource</a> 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 <a name="Initializers" id="@pepperize/cdk-organizations.Account.Initializer"></a> ```typescript import { Account } from '@pepperize/cdk-organizations' new Account(scope: Construct, id: string, props: AccountProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Account.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Account.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Account.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.AccountProps">AccountProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.Account.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.Account.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.Account.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.AccountProps">AccountProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Account.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.Account.attachPolicy">attachPolicy</a></code> | Attach a policy. | | <code><a href="#@pepperize/cdk-organizations.Account.delegateAdministrator">delegateAdministrator</a></code> | Enables trusted access for the AWS service (trusted service) as Delegated Administrator, which performs tasks in your organization and its accounts on your behalf. | | <code><a href="#@pepperize/cdk-organizations.Account.identifier">identifier</a></code> | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.Account.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` <a name="attachPolicy" id="@pepperize/cdk-organizations.Account.attachPolicy"></a> ```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 <a name="policy" id="@pepperize/cdk-organizations.Account.attachPolicy.parameter.policy"></a> - *Type:* <a href="#@pepperize/cdk-organizations.IPolicy">IPolicy</a> --- ##### `delegateAdministrator` <a name="delegateAdministrator" id="@pepperize/cdk-organizations.Account.delegateAdministrator"></a> ```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 <a name="servicePrincipal" id="@pepperize/cdk-organizations.Account.delegateAdministrator.parameter.servicePrincipal"></a> - *Type:* string The supported AWS service that you specify. --- ###### `region`Optional <a name="region" id="@pepperize/cdk-organizations.Account.delegateAdministrator.parameter.region"></a> - *Type:* string The region to delegate in. --- ###### `props`Optional <a name="props" id="@pepperize/cdk-organizations.Account.delegateAdministrator.parameter.props"></a> - *Type:* {[ key: string ]: any} additional DelegatedAdministrator props. --- ##### `identifier` <a name="identifier" id="@pepperize/cdk-organizations.Account.identifier"></a> ```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 <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Account.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.Account.isConstruct"></a> ```typescript import { Account } from '@pepperize/cdk-organizations' Account.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.Account.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Account.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@pepperize/cdk-organizations.Account.property.accountArn">accountArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of the account. | | <code><a href="#@pepperize/cdk-organizations.Account.property.accountId">accountId</a></code> | <code>string</code> | If the account was created successfully, the unique identifier (ID) of the new account. | | <code><a href="#@pepperize/cdk-organizations.Account.property.accountName">accountName</a></code> | <code>string</code> | The friendly name of the account. | | <code><a href="#@pepperize/cdk-organizations.Account.property.email">email</a></code> | <code>string</code> | The email address of the owner to assign to the new member account. | | <code><a href="#@pepperize/cdk-organizations.Account.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | TagManager to set, remove and format tags. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.Account.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `accountArn`Required <a name="accountArn" id="@pepperize/cdk-organizations.Account.property.accountArn"></a> ```typescript public readonly accountArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the account. --- ##### `accountId`Required <a name="accountId" id="@pepperize/cdk-organizations.Account.property.accountId"></a> ```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 <a name="accountName" id="@pepperize/cdk-organizations.Account.property.accountName"></a> ```typescript public readonly accountName: string; ``` - *Type:* string The friendly name of the account. --- ##### `email`Required <a name="email" id="@pepperize/cdk-organizations.Account.property.email"></a> ```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 <a name="tags" id="@pepperize/cdk-organizations.Account.property.tags"></a> ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### DelegatedAdministrator <a name="DelegatedAdministrator" id="@pepperize/cdk-organizations.DelegatedAdministrator"></a> 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 <a name="Initializers" id="@pepperize/cdk-organizations.DelegatedAdministrator.Initializer"></a> ```typescript import { DelegatedAdministrator } from '@pepperize/cdk-organizations' new DelegatedAdministrator(scope: Construct, id: string, props: DelegatedAdministratorProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministratorProps">DelegatedAdministratorProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.DelegatedAdministrator.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.DelegatedAdministratorProps">DelegatedAdministratorProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.toString">toString</a></code> | Returns a string representation of this construct. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.DelegatedAdministrator.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.DelegatedAdministrator.isConstruct"></a> ```typescript import { DelegatedAdministrator } from '@pepperize/cdk-organizations' DelegatedAdministrator.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.DelegatedAdministrator.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.DelegatedAdministrator.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.DelegatedAdministrator.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### EnableAwsServiceAccess <a name="EnableAwsServiceAccess" id="@pepperize/cdk-organizations.EnableAwsServiceAccess"></a> 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 <a name="Initializers" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer"></a> ```typescript import { EnableAwsServiceAccess } from '@pepperize/cdk-organizations' new EnableAwsServiceAccess(scope: Construct, id: string, props: EnableAwsServiceAccessProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccessProps">EnableAwsServiceAccessProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.EnableAwsServiceAccessProps">EnableAwsServiceAccessProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.toString">toString</a></code> | Returns a string representation of this construct. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.isConstruct"></a> ```typescript import { EnableAwsServiceAccess } from '@pepperize/cdk-organizations' EnableAwsServiceAccess.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnableAwsServiceAccess.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.EnableAwsServiceAccess.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### EnablePolicyType <a name="EnablePolicyType" id="@pepperize/cdk-organizations.EnablePolicyType"></a> 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 <a name="Initializers" id="@pepperize/cdk-organizations.EnablePolicyType.Initializer"></a> ```typescript import { EnablePolicyType } from '@pepperize/cdk-organizations' new EnablePolicyType(scope: Construct, id: string, props: EnablePolicyTypeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.EnablePolicyTypeProps">EnablePolicyTypeProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.EnablePolicyType.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.EnablePolicyTypeProps">EnablePolicyTypeProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.toString">toString</a></code> | Returns a string representation of this construct. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.EnablePolicyType.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.EnablePolicyType.isConstruct"></a> ```typescript import { EnablePolicyType } from '@pepperize/cdk-organizations' EnablePolicyType.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.EnablePolicyType.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.EnablePolicyType.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.EnablePolicyType.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### Organization <a name="Organization" id="@pepperize/cdk-organizations.Organization"></a> - *Implements:* <a href="#@pepperize/cdk-organizations.IOrganization">IOrganization</a> #### Initializers <a name="Initializers" id="@pepperize/cdk-organizations.Organization.Initializer"></a> ```typescript import { Organization } from '@pepperize/cdk-organizations' new Organization(scope: Construct, id: string, props?: OrganizationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Organization.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Organization.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Organization.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.OrganizationProps">OrganizationProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.Organization.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.Organization.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Optional <a name="props" id="@pepperize/cdk-organizations.Organization.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.OrganizationProps">OrganizationProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Organization.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.Organization.attachPolicy">attachPolicy</a></code> | Attach a policy. | | <code><a href="#@pepperize/cdk-organizations.Organization.enableAwsServiceAccess">enableAwsServiceAccess</a></code> | Enables trusted access for a supported AWS service (trusted service), which performs tasks in your organization and its accounts on your behalf. | | <code><a href="#@pepperize/cdk-organizations.Organization.enablePolicyType">enablePolicyType</a></code> | Enables policy types in the following two broad categories: Authorization policies and Management policies. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.Organization.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` <a name="attachPolicy" id="@pepperize/cdk-organizations.Organization.attachPolicy"></a> ```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 <a name="policy" id="@pepperize/cdk-organizations.Organization.attachPolicy.parameter.policy"></a> - *Type:* <a href="#@pepperize/cdk-organizations.IPolicy">IPolicy</a> --- ##### `enableAwsServiceAccess` <a name="enableAwsServiceAccess" id="@pepperize/cdk-organizations.Organization.enableAwsServiceAccess"></a> ```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 <a name="servicePrincipal" id="@pepperize/cdk-organizations.Organization.enableAwsServiceAccess.parameter.servicePrincipal"></a> - *Type:* string The supported AWS service that you specify. --- ##### `enablePolicyType` <a name="enablePolicyType" id="@pepperize/cdk-organizations.Organization.enablePolicyType"></a> ```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 <a name="policyType" id="@pepperize/cdk-organizations.Organization.enablePolicyType.parameter.policyType"></a> - *Type:* <a href="#@pepperize/cdk-organizations.PolicyType">PolicyType</a> : the type of the policy that you specify. --- #### Static Functions <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Organization.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | | <code><a href="#@pepperize/cdk-organizations.Organization.of">of</a></code> | Describe the organization that the current account belongs to. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.Organization.isConstruct"></a> ```typescript import { Organization } from '@pepperize/cdk-organizations' Organization.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.Organization.isConstruct.parameter.x"></a> - *Type:* any Any object. --- ##### `of` <a name="of" id="@pepperize/cdk-organizations.Organization.of"></a> ```typescript import { Organization } from '@pepperize/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 <a name="scope" id="@pepperize/cdk-organizations.Organization.of.parameter.scope"></a> - *Type:* constructs.Construct --- ###### `id`Required <a name="id" id="@pepperize/cdk-organizations.Organization.of.parameter.id"></a> - *Type:* string --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Organization.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.featureSet">featureSet</a></code> | <code><a href="#@pepperize/cdk-organizations.FeatureSet">FeatureSet</a></code> | Specifies the functionality that currently is available to the organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.managementAccountArn">managementAccountArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.managementAccountEmail">managementAccountEmail</a></code> | <code>string</code> | The email address that is associated with the AWS account that is designated as the management account for the organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.managementAccountId">managementAccountId</a></code> | <code>string</code> | The unique identifier (ID) of the management account of an organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.organizationArn">organizationArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of an organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.organizationId">organizationId</a></code> | <code>string</code> | The unique identifier (ID) of an organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.principal">principal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | The principal that represents this AWS Organization. | | <code><a href="#@pepperize/cdk-organizations.Organization.property.root">root</a></code> | <code><a href="#@pepperize/cdk-organizations.Root">Root</a></code> | The root of the current organization, which is automatically created. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.Organization.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `featureSet`Required <a name="featureSet" id="@pepperize/cdk-organizations.Organization.property.featureSet"></a> ```typescript public readonly featureSet: FeatureSet; ``` - *Type:* <a href="#@pepperize/cdk-organizations.FeatureSet">FeatureSet</a> 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 <a name="managementAccountArn" id="@pepperize/cdk-organizations.Organization.property.managementAccountArn"></a> ```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 <a name="managementAccountEmail" id="@pepperize/cdk-organizations.Organization.property.managementAccountEmail"></a> ```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 <a name="managementAccountId" id="@pepperize/cdk-organizations.Organization.property.managementAccountId"></a> ```typescript public readonly managementAccountId: string; ``` - *Type:* string The unique identifier (ID) of the management account of an organization. --- ##### `organizationArn`Required <a name="organizationArn" id="@pepperize/cdk-organizations.Organization.property.organizationArn"></a> ```typescript public readonly organizationArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of an organization. --- ##### `organizationId`Required <a name="organizationId" id="@pepperize/cdk-organizations.Organization.property.organizationId"></a> ```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 <a name="principal" id="@pepperize/cdk-organizations.Organization.property.principal"></a> ```typescript public readonly principal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal that represents this AWS Organization. --- ##### `root`Required <a name="root" id="@pepperize/cdk-organizations.Organization.property.root"></a> ```typescript public readonly root: Root; ``` - *Type:* <a href="#@pepperize/cdk-organizations.Root">Root</a> The root of the current organization, which is automatically created. --- ### OrganizationalUnit <a name="OrganizationalUnit" id="@pepperize/cdk-organizations.OrganizationalUnit"></a> - *Implements:* <a href="#@pepperize/cdk-organizations.IOrganizationalUnit">IOrganizationalUnit</a>, <a href="#@pepperize/cdk-organizations.ITaggableResource">ITaggableResource</a> #### Initializers <a name="Initializers" id="@pepperize/cdk-organizations.OrganizationalUnit.Initializer"></a> ```typescript import { OrganizationalUnit } from '@pepperize/cdk-organizations' new OrganizationalUnit(scope: Construct, id: string, props: OrganizationalUnitProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnitProps">OrganizationalUnitProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.OrganizationalUnit.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.OrganizationalUnitProps">OrganizationalUnitProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.attachPolicy">attachPolicy</a></code> | Attach a policy. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.identifier">identifier</a></code> | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.OrganizationalUnit.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `attachPolicy` <a name="attachPolicy" id="@pepperize/cdk-organizations.OrganizationalUnit.attachPolicy"></a> ```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 <a name="policy" id="@pepperize/cdk-organizations.OrganizationalUnit.attachPolicy.parameter.policy"></a> - *Type:* <a href="#@pepperize/cdk-organizations.IPolicy">IPolicy</a> --- ##### `identifier` <a name="identifier" id="@pepperize/cdk-organizations.OrganizationalUnit.identifier"></a> ```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 <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.OrganizationalUnit.isConstruct"></a> ```typescript import { OrganizationalUnit } from '@pepperize/cdk-organizations' OrganizationalUnit.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.OrganizationalUnit.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitArn">organizationalUnitArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of this OU. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitId">organizationalUnitId</a></code> | <code>string</code> | The unique identifier (ID) associated with this OU. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitName">organizationalUnitName</a></code> | <code>string</code> | The friendly name of this OU. | | <code><a href="#@pepperize/cdk-organizations.OrganizationalUnit.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | TagManager to set, remove and format tags. | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.OrganizationalUnit.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `organizationalUnitArn`Required <a name="organizationalUnitArn" id="@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitArn"></a> ```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 <a name="organizationalUnitId" id="@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitId"></a> ```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 <a name="organizationalUnitName" id="@pepperize/cdk-organizations.OrganizationalUnit.property.organizationalUnitName"></a> ```typescript public readonly organizationalUnitName: string; ``` - *Type:* string The friendly name of this OU. --- ##### `tags`Required <a name="tags" id="@pepperize/cdk-organizations.OrganizationalUnit.property.tags"></a> ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager TagManager to set, remove and format tags. --- ### Parent <a name="Parent" id="@pepperize/cdk-organizations.Parent"></a> #### Initializers <a name="Initializers" id="@pepperize/cdk-organizations.Parent.Initializer"></a> ```typescript import { Parent } from '@pepperize/cdk-organizations' new Parent(scope: Construct, id: string, props: ParentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Parent.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Parent.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Parent.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.ParentProps">ParentProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.Parent.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.Parent.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.Parent.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.ParentProps">ParentProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Parent.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.Parent.identifier">identifier</a></code> | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.Parent.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` <a name="identifier" id="@pepperize/cdk-organizations.Parent.identifier"></a> ```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 <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Parent.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | | <code><a href="#@pepperize/cdk-organizations.Parent.fromChildId">fromChildId</a></code> | *No description.* | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.Parent.isConstruct"></a> ```typescript import { Parent } from '@pepperize/cdk-organizations' Parent.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.Parent.isConstruct.parameter.x"></a> - *Type:* any Any object. --- ##### `fromChildId` <a name="fromChildId" id="@pepperize/cdk-organizations.Parent.fromChildId"></a> ```typescript import { Parent } from '@pepperize/cdk-organizations' Parent.fromChildId(scope: Construct, id: string, childId: string) ``` ###### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.Parent.fromChildId.parameter.scope"></a> - *Type:* constructs.Construct --- ###### `id`Required <a name="id" id="@pepperize/cdk-organizations.Parent.fromChildId.parameter.id"></a> - *Type:* string --- ###### `childId`Required <a name="childId" id="@pepperize/cdk-organizations.Parent.fromChildId.parameter.childId"></a> - *Type:* string --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Parent.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@pepperize/cdk-organizations.Parent.property.parentId">parentId</a></code> | <code>string</code> | *No description.* | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.Parent.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `parentId`Required <a name="parentId" id="@pepperize/cdk-organizations.Parent.property.parentId"></a> ```typescript public readonly parentId: string; ``` - *Type:* string --- ### ParentBase <a name="ParentBase" id="@pepperize/cdk-organizations.ParentBase"></a> - *Implements:* <a href="#@pepperize/cdk-organizations.IParent">IParent</a> #### Initializers <a name="Initializers" id="@pepperize/cdk-organizations.ParentBase.Initializer"></a> ```typescript import { ParentBase } from '@pepperize/cdk-organizations' new ParentBase(scope: Construct, id: string, props: ParentBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.ParentBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.ParentBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.ParentBase.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.ParentBaseProps">ParentBaseProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.ParentBase.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.ParentBase.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.ParentBase.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.ParentBaseProps">ParentBaseProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.ParentBase.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.ParentBase.identifier">identifier</a></code> | The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in. | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.ParentBase.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` <a name="identifier" id="@pepperize/cdk-organizations.ParentBase.identifier"></a> ```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 <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.ParentBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-organizations.ParentBase.isConstruct"></a> ```typescript import { ParentBase } from '@pepperize/cdk-organizations' ParentBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@pepperize/cdk-organizations.ParentBase.isConstruct.parameter.x"></a> - *Type:* any Any object. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.ParentBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@pepperize/cdk-organizations.ParentBase.property.parentId">parentId</a></code> | <code>string</code> | *No description.* | --- ##### `node`Required <a name="node" id="@pepperize/cdk-organizations.ParentBase.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `parentId`Required <a name="parentId" id="@pepperize/cdk-organizations.ParentBase.property.parentId"></a> ```typescript public readonly parentId: string; ``` - *Type:* string --- ### Policy <a name="Policy" id="@pepperize/cdk-organizations.Policy"></a> - *Implements:* <a href="#@pepperize/cdk-organizations.IPolicy">IPolicy</a>, <a href="#@pepperize/cdk-organizations.ITaggableResource">ITaggableResource</a> #### Initializers <a name="Initializers" id="@pepperize/cdk-organizations.Policy.Initializer"></a> ```typescript import { Policy } from '@pepperize/cdk-organizations' new Policy(scope: Construct, id: string, props: PolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Policy.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Policy.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@pepperize/cdk-organizations.Policy.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-organizations.PolicyProps">PolicyProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@pepperize/cdk-organizations.Policy.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@pepperize/cdk-organizations.Policy.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Required <a name="props" id="@pepperize/cdk-organizations.Policy.Initializer.parameter.props"></a> - *Type:* <a href="#@pepperize/cdk-organizations.PolicyProps">PolicyProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@pepperize/cdk-organizations.Policy.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@pepperize/cdk-organizations.Policy.identifier">identifier</a></code> | *No description.* | --- ##### `toString` <a name="toString" id="@pepperize/cdk-organizations.Policy.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `identifier` <a name="identifier"