Package software.amazon.awscdk.services.organizations

Class CfnAccount.Builder

java.lang.Object

software.amazon.awscdk.services.organizations.CfnAccount.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccount>

Enclosing class:

CfnAccount

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

A fluent builder for CfnAccount.

Method Summary

Modifier and Type	Method	Description
CfnAccount.Builder	accountName(String accountName)	The account name given to the account when it was created.
CfnAccount	build()
static CfnAccount.Builder	create(software.constructs.Construct scope, String id)
CfnAccount.Builder	email(String email)	The email address associated with the AWS account.
CfnAccount.Builder	parentIds(List<String> parentIds)	The unique identifier (ID) of the root or organizational unit (OU) that you want to create the new account in.
CfnAccount.Builder	roleName(String roleName)	The name of an IAM role that AWS Organizations automatically preconfigures in the new member account.
CfnAccount.Builder	tags(List<? extends CfnTag> tags)	A list of tags that you want to attach to the newly created account.

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 CfnAccount.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 CfnAccount.Builder.

accountName

@Stability(Stable)
public CfnAccount.Builder accountName(String accountName)

The account name given to the account when it was created.

Parameters:

accountName - The account name given to the account when it was created. This parameter is required.

Returns:

this

See Also:

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

email

@Stability(Stable)
public CfnAccount.Builder email(String email)

The email address associated with the AWS account.

The regex pattern for this parameter is a string of characters that represents a standard internet email address.

Parameters:

email - The email address associated with the AWS account. This parameter is required.

Returns:

this

See Also:

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

parentIds

@Stability(Stable)
public CfnAccount.Builder parentIds(List<String> parentIds)

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

If you don't specify this parameter, the ParentId defaults to the root ID.

This parameter only accepts a string array with one string value.

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:

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

Returns:

this

See Also:

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

roleName

@Stability(Stable)
public CfnAccount.Builder roleName(String roleName)

The name of an IAM role that AWS Organizations automatically preconfigures in the new member account.

This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole .

For more information about how to use this role to access the member account, see the following links:

• Creating the OrganizationAccountAccessRole in an invited member account in the AWS Organizations User Guide
• Steps 2 and 3 in IAM Tutorial: Delegate access across AWS accounts using IAM roles in the IAM User Guide

The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

Default: - "OrganizationAccountAccessRole"

Parameters:

roleName - The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This parameter is required.

Returns:

this

See Also:

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

tags

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

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

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 maximum allowed number of tags for an account, then the entire request fails and the account is not created.

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccount build()

Specified by:

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

Returns:

a newly built instance of CfnAccount.