aws-native logo
AWS Native v0.49.0, Jan 26 23

aws-native.organizations.Account

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

Create Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            email: Optional[str] = None,
            parent_ids: Optional[Sequence[str]] = None,
            role_name: Optional[str] = None,
            tags: Optional[Sequence[AccountTagArgs]] = None)
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args 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

The Account resource accepts the following input properties:

Email 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.Organizations.Inputs.AccountTagArgs>

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 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 []AccountTagArgs

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 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<AccountTagArgs>

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 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 AccountTagArgs[]

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 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[AccountTagArgs]

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

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

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

AccountTag

Key string

The key identifier, or name, of the tag.

Value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

Key string

The key identifier, or name, of the tag.

Value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key String

The key identifier, or name, of the tag.

value String

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key string

The key identifier, or name, of the tag.

value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key str

The key identifier, or name, of the tag.

value str

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key String

The key identifier, or name, of the tag.

value String

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

Package Details

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