aws-cdk-lib.aws_organizations.CfnOrganizationalUnitProps

CfnOrganizationalUnitProps Struct

Properties for defining a CfnOrganizationalUnit.

CfnOrganizationalUnitProps

used as props by

• CfnOrganizationalUnit

Source

Generated code

Type last changed

v2.54.0 · 7 Dec 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_organizations as organizations } from 'aws-cdk-lib';
const cfnOrganizationalUnitProps: organizations.CfnOrganizationalUnitProps = {
  name: 'name',
  parentId: 'parentId',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

namestringnamestrnameStringNamestringName*stringrequired#

The friendly name of this OU.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

parentIdstringparent_idstrparentIdStringParentIdstringParentId*stringrequired#

The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

notes

To update the ParentId parameter value, you must first remove all accounts attached to the organizational unit (OU). OUs can't be moved within the organization with accounts still attached.

The regex pattern for a parent ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

A list of tags that you want to attach to the newly created OU.

notes

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.