1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. organizations
  5. Account

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.organizations.Account

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

You can use AWS::Organizations::Account to manage accounts in organization.

Create Account Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            account_name: Optional[str] = None,
            parent_ids: Optional[Sequence[str]] = None,
            role_name: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)
type: aws-native:organizations:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Account Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Account resource accepts the following input properties:

Email This property is required. string
The email address of the owner to assign to the new member account.
AccountName string
The friendly name of the member account.
ParentIds List<string>
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
RoleName string
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
Tags List<Pulumi.AwsNative.Inputs.Tag>
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.
Email This property is required. string
The email address of the owner to assign to the new member account.
AccountName string
The friendly name of the member account.
ParentIds []string
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
RoleName string
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
Tags TagArgs
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.
email This property is required. String
The email address of the owner to assign to the new member account.
accountName String
The friendly name of the member account.
parentIds List<String>
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
roleName String
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
tags List<Tag>
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.
email This property is required. string
The email address of the owner to assign to the new member account.
accountName string
The friendly name of the member account.
parentIds string[]
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
roleName string
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
tags Tag[]
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.
email This property is required. str
The email address of the owner to assign to the new member account.
account_name str
The friendly name of the member account.
parent_ids Sequence[str]
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
role_name str
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
tags Sequence[TagArgs]
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.
email This property is required. String
The email address of the owner to assign to the new member account.
accountName String
The friendly name of the member account.
parentIds List<String>
List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
roleName String
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
tags List<Property Map>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

AccountId string
If the account was created successfully, the unique identifier (ID) of the new account.
Arn string
The Amazon Resource Name (ARN) of the account.
Id string
The provider-assigned unique ID for this managed resource.
JoinedMethod Pulumi.AwsNative.Organizations.AccountJoinedMethod
The method by which the account joined the organization.
JoinedTimestamp string
The date the account became a part of the organization.
Status Pulumi.AwsNative.Organizations.AccountStatus
The status of the account in the organization.
AccountId string
If the account was created successfully, the unique identifier (ID) of the new account.
Arn string
The Amazon Resource Name (ARN) of the account.
Id string
The provider-assigned unique ID for this managed resource.
JoinedMethod AccountJoinedMethod
The method by which the account joined the organization.
JoinedTimestamp string
The date the account became a part of the organization.
Status AccountStatus
The status of the account in the organization.
accountId String
If the account was created successfully, the unique identifier (ID) of the new account.
arn String
The Amazon Resource Name (ARN) of the account.
id String
The provider-assigned unique ID for this managed resource.
joinedMethod AccountJoinedMethod
The method by which the account joined the organization.
joinedTimestamp String
The date the account became a part of the organization.
status AccountStatus
The status of the account in the organization.
accountId string
If the account was created successfully, the unique identifier (ID) of the new account.
arn string
The Amazon Resource Name (ARN) of the account.
id string
The provider-assigned unique ID for this managed resource.
joinedMethod AccountJoinedMethod
The method by which the account joined the organization.
joinedTimestamp string
The date the account became a part of the organization.
status AccountStatus
The status of the account in the organization.
account_id str
If the account was created successfully, the unique identifier (ID) of the new account.
arn str
The Amazon Resource Name (ARN) of the account.
id str
The provider-assigned unique ID for this managed resource.
joined_method AccountJoinedMethod
The method by which the account joined the organization.
joined_timestamp str
The date the account became a part of the organization.
status AccountStatus
The status of the account in the organization.
accountId String
If the account was created successfully, the unique identifier (ID) of the new account.
arn String
The Amazon Resource Name (ARN) of the account.
id String
The provider-assigned unique ID for this managed resource.
joinedMethod "INVITED" | "CREATED"
The method by which the account joined the organization.
joinedTimestamp String
The date the account became a part of the organization.
status "ACTIVE" | "SUSPENDED" | "PENDING_CLOSURE"
The status of the account in the organization.

Supporting Types

AccountJoinedMethod
, AccountJoinedMethodArgs

Invited
INVITED
Created
CREATED
AccountJoinedMethodInvited
INVITED
AccountJoinedMethodCreated
CREATED
Invited
INVITED
Created
CREATED
Invited
INVITED
Created
CREATED
INVITED
INVITED
CREATED
CREATED
"INVITED"
INVITED
"CREATED"
CREATED

AccountStatus
, AccountStatusArgs

Active
ACTIVE
Suspended
SUSPENDED
PendingClosure
PENDING_CLOSURE
AccountStatusActive
ACTIVE
AccountStatusSuspended
SUSPENDED
AccountStatusPendingClosure
PENDING_CLOSURE
Active
ACTIVE
Suspended
SUSPENDED
PendingClosure
PENDING_CLOSURE
Active
ACTIVE
Suspended
SUSPENDED
PendingClosure
PENDING_CLOSURE
ACTIVE
ACTIVE
SUSPENDED
SUSPENDED
PENDING_CLOSURE
PENDING_CLOSURE
"ACTIVE"
ACTIVE
"SUSPENDED"
SUSPENDED
"PENDING_CLOSURE"
PENDING_CLOSURE

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi