Package software.amazon.awscdk.services.organizations

Interface CfnAccountProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccountProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:00.670Z")
@Stability(Stable)
public interface CfnAccountProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccount.

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.*;
 CfnAccountProps cfnAccountProps = CfnAccountProps.builder()
         .accountName("accountName")
         .email("email")
         // the properties below are optional
         .parentIds(List.of("parentIds"))
         .roleName("roleName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccountProps.Builder	A builder for CfnAccountProps
static final class	CfnAccountProps.Jsii$Proxy	An implementation for CfnAccountProps

Method Summary

Modifier and Type	Method	Description
static CfnAccountProps.Builder	builder()
String	getAccountName()	The account name given to the account when it was created.
String	getEmail()	The email address associated with the AWS account.
default List<String>	getParentIds()	The unique identifier (ID) of the root or organizational unit (OU) that you want to create the new account in.
default String	getRoleName()	The name of an IAM role that AWS Organizations automatically preconfigures in the new member account.
default List<CfnTag>	getTags()	A list of tags that you want to attach to the newly created account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountName

@Stability(Stable)
@NotNull
String getAccountName()

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

getEmail

@Stability(Stable)
@NotNull
String getEmail()

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.

getParentIds

@Stability(Stable)
@Nullable
default List<String> getParentIds()

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.

getRoleName

@Stability(Stable)
@Nullable
default String getRoleName()

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:

• Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide
• Steps 2 and 3 in 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: =,.@-

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(Stable)
static CfnAccountProps.Builder builder()

Returns:

a CfnAccountProps.Builder of CfnAccountProps