AwsOrganizations

Service-level AWS Organizations component.

Remarks

Naming:

Root type ${namespace}:aws:AwsOrganizations uses literal capability organizations and logical-only args.identity through buildComponentLogicalName(...): ${env}-${projectHash}-organizations-${sanitised args.identity}. Punctuation-only identities are rejected.
Under parent type ${namespace}:aws:AwsOrganizations, provider children use these readable tuples: Organization [args.identity]; OrganizationalUnit [args.identity, args.organizationalUnits map key]; Account [args.identity, args.accounts map key]; Policy [args.identity, args.policies map key]; PolicyAttachment [args.identity, args.policyAttachments map key]; DelegatedAdministrator [args.identity, args.delegatedAdministrators map key, args.delegatedAdministrators.<key>.servicePrincipals map key]; and ResourcePolicy [args.identity].
AWS Organizations account, organisational-unit, and policy name fields are semantic provider identifiers forwarded unchanged from their capability arguments; AWS owns their validation. Organization, attachment, delegated-administrator, and resource-policy resources have no component-controlled provider name.

Example

CODE

const organizations = new AwsOrganizations({
  identity: 'org-root',
  organization: {},
});

Constructors

`new AwsOrganizations( args: AwsOrganizationsArgs, options?: ComponentResourceOptions, ): AwsOrganizations`

Parameters

args (AwsOrganizationsArgs) — Service-level Organizations capability inputs.
options (ComponentResourceOptions, optional) — Optional settings controlling resource behaviour.

Returns

AwsOrganizations

Hierarchy

ComponentResource
AwsOrganizations

Properties

`accountArns: Record<string, pulumi.Output<string>>`

readonly

Map of account ARNs keyed by capability key.

`accountEmails: Record<string, pulumi.Output<string>>`

readonly

Map of account emails keyed by capability key.

`accountIds: Record<string, pulumi.Output<string>>`

readonly

Map of account IDs keyed by capability key.

`accountNames: Record<string, pulumi.Output<string>>`

readonly

Map of account names keyed by capability key.

`accounts: Record<string, aws.organizations.Account>`

readonly

Created accounts keyed by args.accounts key.

`delegatedAdministratorAccountIds: Record<string, pulumi.Output<string>>`

readonly

Map of delegated administrator account IDs keyed by capability key.

`delegatedAdministrators: Record<string, Record<string, aws.organizations.DelegatedAdministrator>>`

readonly

Created delegated administrators keyed by capability key and then service principal.

`delegatedAdministratorServicePrincipals: Record<string, pulumi.Output<string[]>>`

readonly

Map of delegated administrator service principals keyed by capability key.

`organization: Organization | undefined`

readonly

Optional organization resource.

`organizationalUnitIds: Record<string, pulumi.Output<string>>`

readonly

Map of organisational unit IDs keyed by capability key.

`organizationalUnits: Record<string, aws.organizations.OrganizationalUnit>`

readonly

Created organisational units keyed by args.organizationalUnits key.

`organizationArn: Output<string> | undefined`

readonly

Optional organization ARN.

`organizationId: Output<string> | undefined`

readonly

Optional organization ID.

`organizationMasterAccountArn: Output<string> | undefined`

readonly

Optional management account ARN for the organization.

`organizationMasterAccountEmail: Output<string> | undefined`

readonly

Optional management account email for the organization.

`organizationMasterAccountId: Output<string> | undefined`

readonly

Optional management account ID for the organization.

`organizationMasterAccountName: Output<string> | undefined`

readonly

Optional management account name for the organization.

`organizationRoots: Output<OrganizationRoot[]> | undefined`

readonly

Optional organization root metadata.

`policies: Record<string, aws.organizations.Policy>`

readonly

Created policies keyed by args.policies key.

`policyArns: Record<string, pulumi.Output<string>>`

readonly

Map of policy ARNs keyed by capability key.

`policyAttachmentPolicyIds: Record<string, pulumi.Output<string>>`

readonly

Map of attachment policy IDs keyed by capability key.

`policyAttachments: Record<string, aws.organizations.PolicyAttachment>`

readonly

Created policy attachments keyed by args.policyAttachments key.

`policyAttachmentTargetIds: Record<string, pulumi.Output<string>>`

readonly

Map of attachment target IDs keyed by capability key.

`policyIds: Record<string, pulumi.Output<string>>`

readonly

Map of policy IDs keyed by capability key.

`resourcePolicy: ResourcePolicy | undefined`

readonly

Optional organization resource policy resource.

`resourcePolicyArn: Output<string> | undefined`

readonly

Optional organization resource policy ARN.

`resourcePolicyId: Output<string> | undefined`

readonly

Optional organization resource policy ID.

`urn: Output<string>`

readonly

Inherited from urn

The stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

`getData(): Promise<any>`

protectedasync

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

Promise<any>

`getProvider(moduleMember: string): ProviderResource | undefined`

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

moduleMember (string)

Returns

ProviderResource | undefined

`initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>`

protectedasync

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

args (Inputs)
opts (ComponentResourceOptions, optional)
name (string, optional)
type (string, optional)

Returns

Promise<any>

`registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void`

protected

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

void

Static Methods

`isInstance(obj: any): obj is ComponentResource<any>`

static

Inherited from isInstance

Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

obj (any)

Returns

obj is ComponentResource<any>