@pepperize/cdk-organizations/lib/organizational-unit.d.ts

Manage AWS organizations, organizational units (OU), accounts and service control policies (SCP).

import { CustomResource, RemovalPolicy, TagManager } from "aws-cdk-lib";
import { Construct, IConstruct } from "constructs";
import { IChild, IParent } from "./parent";
import { IPolicy } from "./policy";
import { IPolicyAttachmentTarget } from "./policy-attachment";
import { ITaggableResource } from "./tag-resource";
export interface OrganizationalUnitProps {
    /**
     * The friendly name to assign to the new OU.
     */
    readonly organizationalUnitName: string;
    /**
     * The parent root or OU that you want to create the new OrganizationalUnit in.
     */
    readonly parent: IParent;
    /**
     * Whether to import, if a duplicate organizational unit with same name exists in the parent exists.
     *
     * @default true
     */
    readonly importOnDuplicate?: boolean;
    /**
     * If set to RemovalPolicy.DESTROY, the organizational unit will be deleted
     *
     * @default RemovalPolicy.Retain
     */
    readonly removalPolicy?: RemovalPolicy;
}
/**
 * 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.
 *
 * <strong>You must first move all accounts out of the OU and any child OUs, and then you can delete the child OUs.</strong>
 */
export interface IOrganizationalUnit extends IPolicyAttachmentTarget, IParent, IChild, IConstruct {
    /**
     * 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.
     */
    readonly organizationalUnitId: 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.
     */
    readonly organizationalUnitArn: string;
    /**
     * The friendly name of this OU.
     */
    readonly organizationalUnitName: string;
}
export declare class OrganizationalUnit extends Construct implements IOrganizationalUnit, ITaggableResource {
    readonly organizationalUnitId: string;
    readonly organizationalUnitArn: string;
    readonly organizationalUnitName: string;
    protected readonly resource: CustomResource;
    private readonly scope;
    readonly tags: TagManager;
    constructor(scope: Construct, id: string, props: OrganizationalUnitProps);
    identifier(): string;
    /**
     * 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.
     *
     * @see https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html
     */
    attachPolicy(policy: IPolicy): void;
}