Class DeploymentTargets

Deployment targets configuration. Deployment targets is an accelerator-specific configuration object that can be used for resources provisioned by the accelerator. Deployment targets allow you to specify multiple accounts and/or organizational units (OUs) as targets for resource deployment.

The following example would deploy a resource to all accounts in the organization except the Management account:

Example

deploymentTargets:
  organizationalUnits:
    - Root
  excludedAccounts:
    - Management

Implements

  • IDeploymentTargets

Properties

accounts excludedAccounts excludedRegions organizationalUnits

Properties

Readonlyaccounts

accounts: string[] = []

Use this property to define one or more accounts as a deployment target.

ReadonlyexcludedAccounts

excludedAccounts: string[] = []

Use this property to explicitly define one or more accounts to exclude from deployment.

ReadonlyexcludedRegions

excludedRegions: (
    | "af-south-1"
    | "ap-east-1"
    | "ap-northeast-1"
    | "ap-northeast-2"
    | "ap-northeast-3"
    | "ap-south-1"
    | "ap-south-2"
    | "ap-southeast-1"
    | "ap-southeast-2"
    | "ap-southeast-3"
    | "ap-southeast-4"
    | "ap-southeast-5"
    | "ca-central-1"
    | "ca-west-1"
    | "cn-north-1"
    | "cn-northwest-1"
    | "eu-central-1"
    | "eu-central-2"
    | "eu-north-1"
    | "eu-south-1"
    | "eu-south-2"
    | "eu-west-1"
    | "eu-west-2"
    | "eu-west-3"
    | "eu-isoe-west-1"
    | "il-central-1"
    | "me-central-1"
    | "me-south-1"
    | "sa-east-1"
    | "us-east-1"
    | "us-east-2"
    | "us-gov-west-1"
    | "us-gov-east-1"
    | "us-iso-east-1"
    | "us-isob-east-1"
    | "us-iso-west-1"
    | "us-isof-south-1"
    | "us-isof-east-1"
    | "us-west-1"
    | "us-west-2")[] = []

Use this property to explicitly define one or more regions to exclude from deployment.

Remarks

By default, all regions defined in the enabledRegions property of GlobalConfig are included in deploymentTargets.

ReadonlyorganizationalUnits

organizationalUnits: string[] = []

Use this property to define one or more organizational units (OUs) as a deployment target. Resources are provisioned in each account contained within the OU.

Remarks

Any nested OUs that you would like to deploy resources to must be explicitly defined in this property. Deployment targets will not automatically deploy to nested OUs.

Settings

Member Visibility

On This Page

Properties