aws-cdk-lib.aws_organizations.CfnAccountProps

CfnAccountProps Struct

Properties for defining a CfnAccount.

CfnAccountProps

used as props by

• CfnAccount

Source

Generated code

Type last changed

v2.88.0 · 20 Jul 2023

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 cfnAccountProps: organizations.CfnAccountProps = {
  accountName: 'accountName',
  email: 'email',

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

Properties

accountNamestringaccount_namestraccountNameStringAccountNamestringAccountName*stringrequired#

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

emailstringemailstremailStringEmailstringEmail*stringrequired#

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.

parentIds?optionalstring[]parent_ids?optionaltyping.List[str]parentIds?optionalList<String>ParentIds?optionalstring[]ParentIds?optional*[]*string#

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

notes

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.

roleName?optionalstringrole_name?optionalstrroleName?optionalStringRoleName?optionalstringRoleName?optional*string= "OrganizationAccountAccessRole"#

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

notes

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: =,.@-

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 account.

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