@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
97 lines (96 loc) • 4.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* You can use AWS::Organizations::Account to manage accounts in organization.
*/
export declare class Account extends pulumi.CustomResource {
/**
* Get an existing Account resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Account;
/**
* Returns true if the given object is an instance of Account. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Account;
/**
* If the account was created successfully, the unique identifier (ID) of the new account.
*/
readonly accountId: pulumi.Output<string>;
/**
* The friendly name of the member account.
*/
readonly accountName: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) of the account.
*/
readonly arn: pulumi.Output<string>;
/**
* The email address of the owner to assign to the new member account.
*/
readonly email: pulumi.Output<string>;
/**
* The method by which the account joined the organization.
*/
readonly joinedMethod: pulumi.Output<enums.organizations.AccountJoinedMethod>;
/**
* The date the account became a part of the organization.
*/
readonly joinedTimestamp: pulumi.Output<string>;
/**
* List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
*/
readonly parentIds: pulumi.Output<string[] | undefined>;
/**
* The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
*/
readonly roleName: pulumi.Output<string | undefined>;
/**
* The status of the account in the organization.
*/
readonly status: pulumi.Output<enums.organizations.AccountStatus>;
/**
* 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.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a Account resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Account resource.
*/
export interface AccountArgs {
/**
* The friendly name of the member account.
*/
accountName?: pulumi.Input<string>;
/**
* The email address of the owner to assign to the new member account.
*/
email: pulumi.Input<string>;
/**
* List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
*/
parentIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
*/
roleName?: pulumi.Input<string>;
/**
* 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.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}