Package software.amazon.awscdk.services.organizations

Class CfnOrganizationalUnit

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.organizations.CfnOrganizationalUnit
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.221Z") @Stability(Stable) public class CfnOrganizationalUnit extends CfnResource implements IInspectable, ITaggable
Creates an organizational unit (OU) within a root or parent OU.

An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.

For more information about OUs, see Managing organizational units (OUs) in the AWS Organizations User Guide .

If the request includes tags, then the requester must have the organizations:TagResource permission.

This operation can be called only from the organization's management account.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.organizations.*;
 CfnOrganizationalUnit cfnOrganizationalUnit = CfnOrganizationalUnit.Builder.create(this, "MyCfnOrganizationalUnit")
         .name("name")
         .parentId("parentId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOrganizationalUnit

      protected CfnOrganizationalUnit(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOrganizationalUnit

      protected CfnOrganizationalUnit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOrganizationalUnit

      @Stability(Stable) public CfnOrganizationalUnit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOrganizationalUnitProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of this OU.

      For example: arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier (ID) associated with this OU.

      For example: ou-examplerootid111-exampleouid111 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The friendly name of this OU.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The friendly name of this OU.

    • getParentId

      @Stability(Stable) @NotNull public String getParentId()
      The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

    • setParentId

      @Stability(Stable) public void setParentId(@NotNull String value)
      The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tags that you want to attach to the newly created OU.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tags that you want to attach to the newly created OU.