Interface IGlobalConfig

Accelerator Metadata Configuration Creates a bucket in the logging account to enable accelerator metadata collection

Example

acceleratorMetadata:
  enable: true
  account: Logging
Copy

Accelerator Settings Configuration Allows setting additional properties for accelerator

Example

acceleratorSettings:
 maxConcurrentStacks: 250
Copy

Backup Vaults Configuration

To generate vaults, you need to provide below value for this parameter.

Example

backup:
  vaults:
    - name: MyBackUpVault
      deploymentTargets:
        organizationalUnits:
          - Root
Copy

AWS CDK options configuration. This lets you customize the operation of the CDK within LZA, specifically:

centralizeBuckets: Enabling this option modifies the CDK bootstrap process to utilize a single S3 bucket per region located in the management account for CDK assets generated by LZA. Otherwise, CDK will create a new S3 bucket in every account and every region supported by LZA. useManagementAccessRole: Enabling this option modifies CDK operations to use the IAM role specified in the managementAccountAccessRole option in global-config.yaml rather than the default roles created by CDK. Default CDK roles will still be created, but will remain unused. Any stacks previously deployed by LZA will retain their associated execution role. For more information on these roles, please see here.

Example

cdkOptions:
  centralizeBuckets: true
  useManagementAccessRole: true
Copy

Deprecated

NOTICE: The configuration of CDK buckets is being moved to cdkOptions in the Global Config. This block is deprecated and will be removed in a future release

See

cdkOptionsConfig

To indicate workload accounts should utilize the cdk-assets S3 buckets in the management account, you need to provide below value for this parameter.

Example

centralizeCdkBuckets:
  enable: true
Copy

Configuration for centralized root user management.

Example

centralRootUserManagement:
  enable: true
  capabilities:
    rootCredentialsManagement: true
    allowRootSessions: true
Copy

Global CloudWatch Logs retention in days configuration.

Remarks

This retention setting will be applied to all CloudWatch log groups created by the accelerator. Additionally, this retention setting will be applied to any CloudWatch log groups that already exist in the target environment if the log group's retention setting is LOWER than this configured value.

Scenario 1: If you have a cloudwatchLogRetentionInDays setting of 365 days, and create a new CloudWatch Log Group with a 545-day retention setting, the LZA solution will update the CloudWatch Log Group to 365 days.

Scenario 2: The global cloudwatchLogRetentionInDays is set to 365 days and has an existing CloudWatch Log Group that has a retention of 545 days. When the LZA solution runs, the CloudWatch Log Group in question will be evaluated and skipped given that the retention setting (545 days in this example) is higher than the global cloudwatchLogRetentionInDays setting.

Scenario 3: The global cloudwatchLogRetentionInDays is set to 365 days and has an existing CloudWatch Log Group that has a retention of 30 days. When the LZA solution runs, the CloudWatch Log Group in question will be evaluated and updated given that the retention setting (30 days in this example) is lower than the global cloudwatchLogRetentionInDays setting.

AWS Control Tower Landing Zone configuration

To indicate environment has control tower enabled, you need to provide below value for this parameter.

Example

controlTower:
  enable: true
Copy

Configuration for the Default Event Bus

End-users provide a custom policy, via the policy property, LZA will apply the custom policy to the default event bus policy.

Example

defaultEventBus:
  policy: path-to-my-policy.json
  deploymentTargets:
    accounts:
      - Management
}
Copy

List of AWS Region names where accelerator will be deployed. Home region must be part of this list.

To add us-west-2 along with home region for accelerator deployment, you need to provide below value for this parameter.

Example

enabledRegions:
  - *HOME_REGION
  - us-west-2
Copy

Whether to automatically enable opt-in regions configured for all LZA managed accounts.

ExternalLandingZoneResourcesConfig.

centralizeBuckets: Enabling this option modifies the CDK bootstrap process to utilize a single S3 bucket per region located in the management account for CDK assets generated by LZA. Otherwise, CDK will create a new S3 bucket in every account and every region supported by LZA.

Example

externalLandingZoneResources:
  importExternalLandingZoneResources: false
Copy

Accelerator home region name. The region where accelerator pipeline deployed.

To use us-east-1 as home region for the accelerator, you need to provide below value for this parameter. Note: Variable HOME_REGION created for future usage of home region in the file

Example

homeRegion: &HOME_REGION us-east-1
Copy

AWS Lambda Function environment variables encryption configuration options.

Remarks

You can decide to use AWS KMS CMK or AWS managed key for Lambda function environment variables encryption. When this property is undefined, the solution will deploy AWS KMS CMK to encrypt function environment variables. You can use deploymentTargets to control target accounts and regions for the given useCMK configuration.

For more information please see here

Example

lambda:
  encryption:
   useCMK: true
   deploymentTargets:
     organizationalUnits:
       - Root
Copy

AWS Service Quota - Limit configuration

To enable limits within service quota, you need to provide below value for this parameter.

Remarks

Service quotas define the maximum number of service resources or operations for your AWS account. Service quota increases are processed asynchronously and may require approval. Some quotas require AWS Support cases for increases beyond certain thresholds. Quotas are account-specific and region-specific (where applicable). You can find service and quota codes in the AWS Service Quotas console.

For more information, see:

• AWS Service Quotas User Guide
• Requesting a quota increase

Example

limits:
  # Increase Lambda concurrent executions
  - serviceCode: lambda
    quotaCode: L-B99A9384
    desiredValue: 1000
    deploymentTargets:
      organizationalUnits:
        - Root
    regions:
      - us-west-2

  # Increase IAM roles per account (global quota - no regions needed)
  - serviceCode: iam
    quotaCode: L-4019AD8B
    desiredValue: 15
    deploymentTargets:
      accounts:
        - SharedServices

  # Increase VPCs per region
  - serviceCode: vpc
    quotaCode: L-F678F1CE
    desiredValue: 20
    deploymentTargets:
      organizationalUnits:
        - Security
        - Infrastructure
    regions:
      - us-east-1
      - us-west-2

  # Increase Route 53 Resolver rules per region
  - serviceCode: route53resolver
    quotaCode: L-4A669CC0
    desiredValue: 10
    deploymentTargets:
      organizationalUnits:
        - Infrastructure
Copy

Accelerator logging configuration

To enable organization trail and session manager logs sending to S3, you need to provide below value for this parameter.

Example

logging:
  account: LogArchive
  cloudtrail:
    enable: false
    organizationTrail: false
    cloudtrailInsights:
      apiErrorRateInsight: true
      apiCallRateInsight: true
  sessionManager:
    sendToCloudWatchLogs: false
    sendToS3: true
  cloudwatchLogs:
    dynamicPartitioning: logging/dynamic-partition.json
Copy

This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

Examples:

• AWSControlTowerExecution
• OrganizationAccountAccessRole

Report configuration

To enable budget report along with cost and usage report, you need to provide below value for this parameter.

Example

reports:
  costAndUsageReport:
    compression: Parquet
    format: Parquet
    reportName: accelerator-cur
    s3Prefix: cur
    timeUnit: DAILY
    refreshClosedReports: true
    reportVersioning: CREATE_NEW_REPORT
  budgets:
    - name: accel-budget
      timeUnit: MONTHLY
      type: COST
      amount: 2000
      includeUpfront: true
      includeTax: true
      includeSupport: true
      includeSubscription: true
      includeRecurring: true
      includeOtherSubscription: true
      includeDiscount: true
      includeCredit: false
      includeRefund: false
      useBlended: false
      useAmortized: false
      unit: USD
      notifications:
      - type: ACTUAL
        thresholdType: PERCENTAGE
        threshold: 90
        comparisonOperator: GREATER_THAN
        subscriptionType: EMAIL
        address: myemail+pa-budg@example.com
Copy

AWS S3 global configuration options.

Remarks

You can decide to create AWS KMS CMK for AWS S3 server side encryption. When this property is undefined, the solution will deploy AWS KMS CMK to encrypt AWS S3 bucket. You can use deploymentTargets to control target accounts and regions for the given createCMK configuration. This configuration is not applicable to LogArchive's central logging region, because the solution deployed CentralLogs bucket always encrypted with AWS KMS CMK. This configuration is not applicable to the Management account Asset bucket in the home region. This bucket will always have a key generated and applied to the bucket if it is created. This configuration is not applicable to the assets S3 bucket if the bucket is created. This bucket will always have a key generated and applied.

For more information please see here

Example

s3:
  createCMK: true
  deploymentTargets:
    organizationalUnits:
      - Root
Copy

SNS Topics Configuration

To send CloudWatch Alarms and SecurityHub notifications you will need to configure at least one SNS Topic For SecurityHub notification you will need to set the deployment target to Root in order to receive notifications from all accounts

Example

snsTopics:
  deploymentTargets:
    organizationalUnits:
      - Root
  topics:
    - name: Security
      emailAddresses:
        - SecurityNotifications@example.com
Copy

SQS Queue configuration settings.

See

ISqsConfig for more information.

SSM Inventory Configuration

EC2 prerequisites Connectivity prerequisites

Example

ssmInventory:
  enable: true
  deploymentTargets:
    organizationalUnits:
      - Infrastructure
Copy

SSM parameter configurations

Create SSM parameters through the LZA. Parameters can be deployed to Organizational Units or Accounts using deploymentTargets

Example

ssmParameters:
  - deploymentTargets:
      organizationalUnits:
        - Workloads
    parameters:
      - name: WorkloadParameter
        path: /my/custom/path/variable
        value: 'MySSMParameterValue'
Copy

Configuration for stack policies. Resource types will be protected for Update:Replace and Update:Delete. Protected types need to be AWS:: resource types e.g. AWS::EC2::InternetGateway.

Example

stackPolicy:
  enable: true
  protectedTypes: ['AWS::EC2::InternetGateway']
Copy

Custom Tags for all resources created by Landing Zone Accelerator that can be tagged.

Example

tags:
  - key: Environment
    value: Dev
  - key: ResourceOwner
    value: AcmeApp
  - key: CostCenter
    value: '123'
Copy

Whether to enable termination protection for this stack.

Enable V2 stacks. When enabled, Accelerator will place newly defined resources into separate CloudFormation stacks while preserving existing resources in their original stacks. This prevents exceeding the 500-resource limit per CloudFormation stack.

Default

false
Copy