Package software.amazon.awscdk.services.organizations

Class CfnOrganizationalUnit.Builder

java.lang.Object

software.amazon.awscdk.services.organizations.CfnOrganizationalUnit.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnOrganizationalUnit>

Enclosing class:

CfnOrganizationalUnit

@Stability(Stable)
public static final class CfnOrganizationalUnit.Builder
extends Object
implements software.amazon.jsii.Builder<CfnOrganizationalUnit>

A fluent builder for CfnOrganizationalUnit.

Method Summary

Modifier and Type	Method	Description
CfnOrganizationalUnit	build()
static CfnOrganizationalUnit.Builder	create(software.constructs.Construct scope, String id)
CfnOrganizationalUnit.Builder	name(String name)	The friendly name of this OU.
CfnOrganizationalUnit.Builder	parentId(String parentId)	The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
CfnOrganizationalUnit.Builder	tags(List<? extends CfnTag> tags)	A list of tags that you want to attach to the newly created OU.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnOrganizationalUnit.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnOrganizationalUnit.Builder.

name

@Stability(Stable)
public CfnOrganizationalUnit.Builder name(String name)

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.

Parameters:

name - The friendly name of this OU. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-name

parentId

@Stability(Stable)
public CfnOrganizationalUnit.Builder parentId(String parentId)

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

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.

Parameters:

parentId - The unique identifier (ID) of the parent root or OU that you want to create the new OU in. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-parentid

tags

@Stability(Stable)
public CfnOrganizationalUnit.Builder tags(List<? extends CfnTag> tags)

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

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.

Parameters:

tags - A list of tags that you want to attach to the newly created OU. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-tags

build

@Stability(Stable)
public CfnOrganizationalUnit build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnOrganizationalUnit>

Returns:

a newly built instance of CfnOrganizationalUnit.