Class CfnAccountPropsMixin
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Organizations
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnAccountPropsMixin : Mixin, IMixinSyntax (vb)
Public Class CfnAccountPropsMixin Inherits Mixin Implements IMixinRemarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
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.CfnPropertyMixins.AWS.Organizations;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnAccountPropsMixin = new CfnAccountPropsMixin(new CfnAccountMixinProps {
AccountName = "accountName",
Email = "email",
ParentIds = new [] { "parentIds" },
RoleName = "roleName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});Synopsis
Constructors
| CfnAccountPropsMixin(ICfnAccountMixinProps, ICfnPropertyMixinOptions?) | Create a mixin to apply properties to |
Properties
| CFN_PROPERTY_KEYS | Creates an AWS account that is automatically a member of the organization whose credentials made the request. |
| Props | Creates an AWS account that is automatically a member of the organization whose credentials made the request. |
| Strategy | Creates an AWS account that is automatically a member of the organization whose credentials made the request. |
Methods
| ApplyTo(IConstruct) | Apply the mixin properties to the construct. |
| Supports(IConstruct) | Check if this mixin supports the given construct. |
Constructors
CfnAccountPropsMixin(ICfnAccountMixinProps, ICfnPropertyMixinOptions?)
Create a mixin to apply properties to AWS::Organizations::Account.
public CfnAccountPropsMixin(ICfnAccountMixinProps props, ICfnPropertyMixinOptions? options = null)Parameters
- props ICfnAccountMixinProps
L1 properties to apply.
- options ICfnPropertyMixinOptions
Mixin options.
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
ExampleMetadata: fixture=_generated
Properties
CFN_PROPERTY_KEYS
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
protected static string[] CFN_PROPERTY_KEYS { get; }Property Value
string[]
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
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.CfnPropertyMixins.AWS.Organizations;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnAccountPropsMixin = new CfnAccountPropsMixin(new CfnAccountMixinProps {
AccountName = "accountName",
Email = "email",
ParentIds = new [] { "parentIds" },
RoleName = "roleName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});Props
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
protected virtual ICfnAccountMixinProps Props { get; }Property Value
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
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.CfnPropertyMixins.AWS.Organizations;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnAccountPropsMixin = new CfnAccountPropsMixin(new CfnAccountMixinProps {
AccountName = "accountName",
Email = "email",
ParentIds = new [] { "parentIds" },
RoleName = "roleName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});Strategy
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
protected virtual IMergeStrategy Strategy { get; }Property Value
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
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.CfnPropertyMixins.AWS.Organizations;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnAccountPropsMixin = new CfnAccountPropsMixin(new CfnAccountMixinProps {
AccountName = "accountName",
Email = "email",
ParentIds = new [] { "parentIds" },
RoleName = "roleName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});Methods
ApplyTo(IConstruct)
Apply the mixin properties to the construct.
public override void ApplyTo(IConstruct construct)Parameters
- construct IConstruct
Overrides
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
ExampleMetadata: fixture=_generated
Supports(IConstruct)
Check if this mixin supports the given construct.
public override bool Supports(IConstruct construct)Parameters
- construct IConstruct
Returns
Overrides
Remarks
CloudFormation uses the CreateAccount operation to create accounts. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see AWS Organizations and service-linked roles in the AWS Organizations User Guide .
If the request includes tags, then the requester must have the organizations:TagResource permission.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.
For more information about creating accounts, see Creating a member account in your organization in the AWS Organizations User Guide .
This operation can be called only from the organization's management account.
Deleting Account resources
The default DeletionPolicy for resource AWS::Organizations::Account is Retain . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .
<ul></ul>
If you attempt to update the listed parameters, CloudFormation will attempt the update, but you will receive an error message as those updates are not supported from an Organizations management account or a registered delegated administrator account. Both the update and the update roll-back will fail, so you must skip the account resource update. To update parameters AccountName and Email , you must sign in to the AWS Management Console as the AWS account root user. For more information, see Update the AWS account name, email address, or password for the root user in the Account Management Reference Guide .
CloudformationResource: AWS::Organizations::Account
Mixin: true
ExampleMetadata: fixture=_generated