Class CfnAccountProps
Properties for defining a CfnAccount
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Organizations
Assembly: Amazon.CDK.AWS.Organizations.dll
Syntax (csharp)
public class CfnAccountProps : Object, ICfnAccountProps
Syntax (vb)
Public Class CfnAccountProps
Inherits Object
Implements ICfnAccountProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Organizations;
var cfnAccountProps = new CfnAccountProps {
AccountName = "accountName",
Email = "email",
// the properties below are optional
ParentIds = new [] { "parentIds" },
RoleName = "roleName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnAccountProps() |
Properties
AccountName | The account name given to the account when it was created. |
The email address associated with the AWS account. |
|
ParentIds | The unique identifier (ID) of the root or organizational unit (OU) that you want to create the new account in. |
RoleName | The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. |
Tags | A list of tags that you want to attach to the newly created account. |
Constructors
CfnAccountProps()
public CfnAccountProps()
Properties
AccountName
The account name given to the account when it was created.
public string AccountName { get; set; }
Property Value
System.String
Remarks
The email address associated with the AWS account.
public string Email { get; set; }
Property Value
System.String
Remarks
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
ParentIds
The unique identifier (ID) of the root or organizational unit (OU) that you want to create the new account in.
public string[] ParentIds { get; set; }
Property Value
System.String[]
Remarks
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:
RoleName
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account.
public string RoleName { get; set; }
Property Value
System.String
Remarks
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:
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
A list of tags that you want to attach to the newly created account.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
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.