AccountState class

Input properties used for looking up and filtering Account resources.

Constructors

AccountState({Input<String?>? arn, Input<bool?>? closeOnDeletion, Input<bool?>? createGovcloud, Input<String?>? email, Input<String?>? govcloudId, Input<String?>? iamUserAccessToBilling, Input<String?>? joinedMethod, Input<String?>? joinedTimestamp, Input<String?>? name, Input<String?>? parentId, Input<String?>? roleName, Input<String?>? state, Input<String?>? status, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new AccountState. arn ARN for this account. closeOnDeletion If true, a deletion event will close the account. Otherwise, it will only remove from the organization. This is not supported for GovCloud accounts. createGovcloud Whether to also create a GovCloud account. The GovCloud account is tied to the main (commercial) account this resource creates. If true, the GovCloud account ID is available in the govcloudId attribute. The only way to manage the GovCloud account with the provider is to subsequently import the account using this resource. email Email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. govcloudId ID for a GovCloud account created with the account. iamUserAccessToBilling If set to ALLOW, the new account enables IAM users and roles to access account billing information if they have the required permissions. If set to DENY, then only the root user (and no roles) of the new account can access account billing information. If this is unset, the AWS API will default this to ALLOW. If the resource is created and this option is changed, it will try to recreate the account. joinedMethod Method by which the account joined the organization. joinedTimestamp Date the account became a part of the organization. name Friendly name for the member account. parentId Parent Organizational Unit ID or Root ID for the account. Defaults to the Organization default Root ID. A configuration must be present for this argument to perform drift detection. roleName The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the root account, allowing users in the root account to assume the role, as permitted by the root account administrator. The role has administrator permissions in the new member account. The Organizations API provides no method for reading this information after account creation, so the provider cannot perform drift detection on its value and will always show a difference for a configured value after import unless ignoreChanges is used. state State of the account in the organization. status (Deprecated use state instead) Status of the account in the organization. tags Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
const
AccountState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN for this account.
final
closeOnDeletion → Input<bool?>?
If true, a deletion event will close the account. Otherwise, it will only remove from the organization. This is not supported for GovCloud accounts.
final
createGovcloud → Input<bool?>?
Whether to also create a GovCloud account. The GovCloud account is tied to the main (commercial) account this resource creates. If true, the GovCloud account ID is available in the govcloudId attribute. The only way to manage the GovCloud account with the provider is to subsequently import the account using this resource.
final
email → Input<String?>?
Email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account.
final
govcloudId → Input<String?>?
ID for a GovCloud account created with the account.
final
hashCode → int
The hash code for this object.
no setterinherited
iamUserAccessToBilling → Input<String?>?
If set to ALLOW, the new account enables IAM users and roles to access account billing information if they have the required permissions. If set to DENY, then only the root user (and no roles) of the new account can access account billing information. If this is unset, the AWS API will default this to ALLOW. If the resource is created and this option is changed, it will try to recreate the account.
final
joinedMethod → Input<String?>?
Method by which the account joined the organization.
final
joinedTimestamp → Input<String?>?
Date the account became a part of the organization.
final
name → Input<String?>?
Friendly name for the member account.
final
parentId → Input<String?>?
Parent Organizational Unit ID or Root ID for the account. Defaults to the Organization default Root ID. A configuration must be present for this argument to perform drift detection.
final
roleName → Input<String?>?
The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the root account, allowing users in the root account to assume the role, as permitted by the root account administrator. The role has administrator permissions in the new member account. The Organizations API provides no method for reading this information after account creation, so the provider cannot perform drift detection on its value and will always show a difference for a configured value after import unless ignoreChanges is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
State of the account in the organization.
final
status → Input<String?>?
(Deprecated use state instead) Status of the account in the organization.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited