Landing Zone Accelerator on AWS - Network Config
Used to manage and implement network resources to establish a WAN/LAN architecture to support cloud operations and application workloads in AWS
| Type | INetworkConfig |
|---|---|
| File match |
network-config.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/landing-zone-accelerator-on-aws-network-config/latest.json |
| Source | https://raw.githubusercontent.com/awslabs/landing-zone-accelerator-on-aws/main/source/packages/@aws-accelerator/config/lib/schemas/network-config.json |
Validate with Lintel
npx @lintel/lintel check
Definitions
Allow/Deny Type
Represents permission states for access control and policy configurations. Used throughout the Landing Zone Accelerator for defining access permissions.
Values
- allow: Grant permission or enable access
- deny: Deny permission or block access
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Application Load Balancer attributes config.
Enable or disable deletion protection.
Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
Indicates whether HTTP headers with invalid header fields are removed by the load balancer ( true ) or routed to targets ( false ). The default is false.
Indicates whether the two headers ( x-amzn-tls-version and x-amzn-tls-cipher-suite ), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false . The default is false.
Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false . The default is false.
Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false.
Application Load Balancer listener config. Currently only action type of forward, redirect and fixed-response is allowed.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Port of the application load balancer listener
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Application load balancer listener fixed response config
It returns a custom HTTP response.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is fixed-response.
3 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Application Load balancer listener forward config. Used to define forward action.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is forward.
1 nested properties
Application Load balancer listener forward config target group stickiness config
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is forward.
2 nested properties
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
Indicates whether target group stickiness is enabled.
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first
Application Load balancer listener redirect config. Used to define redirect action.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is redirect.
6 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Application load balancer listener fixed response config
It returns a custom HTTP response.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is fixed-response.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Application Load balancer listener forward config. Used to define forward action.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is forward.
Application Load balancer listener forward config target group stickiness config
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is forward.
2 nested properties
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
Indicates whether target group stickiness is enabled.
Application Load balancer listener redirect config. Used to define redirect action.
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is redirect.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Application Load balancer listener forward config target group stickiness config
Applicable only when type under {@link ApplicationLoadBalancerListenerConfig listener} is forward.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
Indicates whether target group stickiness is enabled.
Used to define Application Load Balancer configurations for the accelerator.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Security Groups to attach to the Application Load Balancer.
Subnets to launch the Application Load Balancer in.
Application Load Balancer attributes config.
9 nested properties
Enable or disable deletion protection.
Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
Indicates whether HTTP headers with invalid header fields are removed by the load balancer ( true ) or routed to targets ( false ). The default is false.
Indicates whether the two headers ( x-amzn-tls-version and x-amzn-tls-cipher-suite ), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false . The default is false.
Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false . The default is false.
Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false.
Listeners for Application Load Balancer.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
Central network services configuration. Use this configuration to define centralized networking services for your environment. Central network services enables you to easily designate a central account that owns your core network infrastructure. These network resources can be shared with other accounts in your organization so that workload accounts can consume them.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of Gateway Load Balancer configurations.
An array of IPAM configurations.
Use this configuration to define Network Firewalls in your environment. AWS Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for your virtual private cloud (VPC) that you create in Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect.
The following example creates a simple Network Firewall rule group, policy,
and firewall. The policy and rule group are shared with the entire organization.
The firewall endpoints are created in subnets named Subnet-A and Subnet-B
in the VPC named Network-Inspection.
3 nested properties
An array of Network Firewall firewall configurations.
An array of Network Firewall policy configurations.
An array of Network Firewall rule group configurations.
Use this configuration to define several features of Route 53 resolver, including resolver endpoints, DNS firewall rule groups, and DNS query logs. Amazon Route 53 Resolver responds recursively to DNS queries from AWS resources for public records, Amazon VPC-specific DNS names, and Amazon Route 53 private hosted zones, and is available by default in all VPCs.
4 nested properties
(OPTIONAL) An array of Route 53 resolver endpoint configurations.
(OPTIONAL) An array of Route 53 DNS firewall rule group configurations.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
4 nested properties
An array of destination services used to store the logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
(OPTIONAL) An array of Route 53 resolver rules.
Amazon Certificate Manager (ACM) Configuration
{@link https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html Import certificate} or {@link https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html Request certificate} from ACM
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Deployment Targets Interface
Defines where AWS resources should be deployed within your AWS organization. This interface provides flexible targeting options for resource deployment across accounts, organizational units, and regions.
Key Features
- Account-level targeting: Deploy to specific AWS accounts
- OU-level targeting: Deploy to all accounts within organizational units
- Regional exclusions: Skip specific AWS regions for compliance or cost optimization
- Account exclusions: Exclude specific accounts from broader deployments
Example
yaml deploymentTargets: organizationalUnits: - Production - Development excludedAccounts: - Management excludedRegions: - us-west-1
4 nested properties
Target Accounts (Optional)
List of specific account names where resources should be deployed. Use for precise account-level targeting.
Excluded Accounts (Optional)
List of account names to exclude from deployment. Takes precedence over organizational unit and account inclusions.
Excluded Regions (Optional)
List of AWS regions to exclude from deployment. Useful for compliance requirements or cost optimization.
Organizational Units (Optional)
List of organizational unit names where resources should be deployed. When specified, resources will be created in all accounts within these OUs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.
Use this configuration to define Customer Gateways and site-to-site VPN connections. A customer gateway device is a physical or software appliance that you own or manage in your on-premises network (on your side of a Site-to-Site VPN connection). A VPN connection refers to the connection between your VPC and your own on-premises network.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Define the ASN used for the Customer Gateway
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The AWS region to provision the customer gateway in
Define tags for the Customer Gateway
Define the optional VPN Connection configuration
Use this configuration to delete default VPCs in your environment.
Enable to delete default VPCs.
(OPTIONAL) Include an array of friendly account names to exclude from default VPC deletion.
(OPTIONAL) Include an array of AWS regions to exclude from default VPC deletion.
Deployment Targets Interface
Defines where AWS resources should be deployed within your AWS organization. This interface provides flexible targeting options for resource deployment across accounts, organizational units, and regions.
Key Features
- Account-level targeting: Deploy to specific AWS accounts
- OU-level targeting: Deploy to all accounts within organizational units
- Regional exclusions: Skip specific AWS regions for compliance or cost optimization
- Account exclusions: Exclude specific accounts from broader deployments
Example
yaml deploymentTargets: organizationalUnits: - Production - Development excludedAccounts: - Management excludedRegions: - us-west-1
Target Accounts (Optional)
List of specific account names where resources should be deployed. Use for precise account-level targeting.
Excluded Accounts (Optional)
List of account names to exclude from deployment. Takes precedence over organizational unit and account inclusions.
Excluded Regions (Optional)
List of AWS regions to exclude from deployment. Useful for compliance requirements or cost optimization.
Organizational Units (Optional)
List of organizational unit names where resources should be deployed. When specified, resources will be created in all accounts within these OUs.
Use this configuration to define custom DHCP options sets for your VPCs. Custom DHCP option sets give you control over the DNS servers, domain names, or Network Time Protocol (NTP) servers used by the devices in your VPC.
The following example creates a DHCP option set named accelerator-dhcp-opts
in the Network account in the us-east-1 region. The options set assigns
a domain name of example.com to hosts in the VPC and configures the DNS
server to 1.1.1.1.
An array of friendly account names to deploy the options set.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of regions to deploy the options set.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of IP addresses for domain name servers.
(OPTIONAL An array of IP addresses for NetBIOS servers.
(OPTIONAL) An array of IP addresses for NTP servers.
(OPTIONAL) An array of tags for the options set.
Use this configuration to define a group of rules for your DNS firewall. Rule groups contain one to many rules that can be associated with VPCs in your environment. These rules allow you to define the behavior of your DNS firewall.
The following example creates a rule group that contains one rule entry. The rule blocks a list of custom domains contained in a file in the accelerator configuration repository. The rule group is shared to the entire organization.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The regions to deploy the rule group to.
An array of DNS firewall rule configurations.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
An array of tags for the rule group.
Use this configuration to define individual rules for your DNS firewall. This allows you to define the DNS firewall behavior for your VPCs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The priority of the DNS firewall rule.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Configure a time-to-live (TTL) for the override domain. This is the recommended amount of time for the DNS resolver or web browser to cache the override record and use it in response to this query, if it is received again. By default, this is zero, and the record isn't cached.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
An array of destination services used to store the logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
A DXGW is a globally-available resource than can be used to connect your VPCs to your on-premise infrastructure.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
A Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of transit gateway association configurations. Creates transit gateway attachments for this DX gateway.
(OPTIONAL) An array of virtual interface configurations. Creates virtual interfaces on the DX gateway.
Use this configuration to define transit gateway attachments for a DX gateway.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of CIDR prefixes that are allowed to advertise over this transit gateway association.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) The friendly name of TGW route table(s) to associate with this attachment.
(OPTIONAL) The friendly name of TGW route table(s) to propagate routes from this attachment.
Use this configuration to create a virtual interface to a DX Gateway. Virtual interfaces enable access to your AWS services from your on-premises environment.
The following example creates a transit VIF called Accelerator-VIF in the Network account on a DX connection with resource ID dxcon-example:
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
A Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the customer side of the connection.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The region of the virtual interface.
The virtual local area network (VLAN) tag to use for this virtual interface.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Enable SiteLink for this virtual interface.
Default - false
(OPTIONAL) Enable jumbo frames for the virtual interface.
Default - standard 1500 MTU frame size
(OPTIONAL) An array of tags to apply to the virtual interface.
An optional ELB root account ID
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define VPC endpoint policies for your VPC gateway and interface endpoints. The endpoint policy is a JSON policy document that controls which AWS principals can use the VPC endpoint to access the endpoint service.
The following example defines an endpoint policy named Default and references a path
where a JSON policy document is stored:
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An optional Firewall Manager Service Config
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An optional Firewall Manager Service Config
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The FMS Notification Channel Configuration
Use this configuration to define gateway endpoints for your VPC. A gateway endpoint targets specific IP routes in an Amazon VPC route table, in the form of a prefix-list, used for traffic destined to Amazon DynamoDB or Amazon Simple Storage Service (Amazon S3).
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of endpoints to create.
Use this configuration to define the service and endpoint policy for gateway endpoints.
(OPTIONAL) Specify whether or not a policy is applied to the endpoint. By default, if no policy is specified in the policy property, a default policy is applied. Specifying this option as false will ensure no policy is applied to the endpoint. This property defaults to true if not specified.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use to define Gateway Load Balancer configurations for the accelerator. Gateway Load Balancers enable you to deploy, scale, and manage virtual appliances, such as firewalls, intrusion detection and prevention systems, and deep packet inspection systems. It combines a transparent network gateway (that is, a single entry and exit point for all traffic) and distributes traffic while scaling your virtual appliances with the demand.
An array of Gateway Load Balancer endpoint configurations.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of friendly names of subnets to deploy the Gateway Load Balancer to.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Whether to enable cross-zone load balancing.
(OPTIONAL) Whether to enable deletion protection.
(OPTIONAL) An array of CloudFormation tag objects.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define endpoints for your Gateway Load Balancer. Gateway Load Balancers use Gateway Load Balancer endpoints to securely exchange traffic across VPC boundaries. A Gateway Load Balancer endpoint is a VPC endpoint that provides private connectivity between virtual appliances in the service provider VPC and application servers in the service consumer VPC.
The following example creates two Gateway Load Balancer endpoints,
Endpoint-A and Endpoint-B. The endpoints are created in subnets named
Network-Inspection-A and Network-Inspection-B, respectively, in the VPC named
Network-Inspection.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define ICMP rules for your network ACLs.
The following example allows inbound ICMP traffic for Mobile Host Redirect
The ICMP code number. A value of -1 indicates all types.
The ICMP type number. A value of -1 indicates all types.
Use this configuration to define interface endpoints for your VPC. Interface endpoints powered by AWS PrivateLink to connect your VPC to AWS services as if they were in your VPC, without the use of an internet gateway.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of VPC interface endpoint services to be deployed.
An array of the friendly names of VPC subnets for the endpoints to be deployed.
(OPTIONAL) An array of source CIDRs allowed to communicate with the endpoints.
(OPTIONAL) Enable to define interface endpoints as centralized endpoints.
(OPTIONAL) An array of tag objects for the private hosted zones associated with the VPC Interface endpoints.
Use this configuration to define the service and endpoint policy for gateway endpoints.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Specify whether or not a policy is applied to the endpoint. By default, if no policy is specified in the policy property, a default policy is applied. Specifying this option as false will ensure no policy is applied to the endpoint. This property defaults to true if not specified.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to dynamically assign a VPC or subnet CIDR from an IPAM pool.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The subnet mask length to request.
Use this configuration to define an AWS-managed VPC IPAM. IPAM is a feature that makes it easier for you to plan, track, and monitor IP addresses for your AWS workloads.
The following example defines an IPAM that is capable of operating in the us-east-1 and us-west-2 regions:
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The region to deploy the IPAM.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of regions that the IPAM will manage.
An optional array of IPAM pool configurations to create under the IPAM.
(OPTIONAL) An array of IPAM scope configurations to create under the IPAM.
(OPTIONAL) An array of tag objects for the IPAM.
Use this configuration to define custom IPAM pools for your VPCs. A pool is a collection of contiguous IP address ranges. IPAM pools enable you to organize your IP addresses according to your routing and security needs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) The default netmask length of IPAM allocations for this pool.
(OPTIONAL) The maximum netmask length of IPAM allocations for this pool.
(OPTIONAL) The minimum netmask length of IPAM allocations for this pool.
(OPTIONAL) An array of tags that are required for resources that use CIDRs from this IPAM pool.
(OPTIONAL) If set to true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) The AWS Region where you want to make an IPAM pool available for allocations.
An array of CIDR ranges to provision for the IPAM pool.
(OPTIONAL) Determines if a pool is publicly advertisable.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the IPAM pool.
Use this configuration to define custom private IPAM scopes for your VPCs. An IPAM scope is the highest-level container for an IPAM. Within scopes, pools can be created. Custom IPAM scopes can be used to create pools and manage resources that use the same IP space.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the IPAM scope.
S3 Bucket Lifecycle Rule Configuration
Defines lifecycle management rules for S3 buckets to automatically transition objects between storage classes and manage object expiration. Lifecycle rules help optimize storage costs and manage data retention policies.
Key Features
- Cost Optimization: Automatically transition objects to cheaper storage classes
- Data Management: Set expiration policies for automatic cleanup
- Version Control: Manage current and non-current object versions separately
- Prefix Filtering: Apply rules to specific object prefixes or entire buckets
Usage Example
- enabled: true id: ArchiveLifecycle expiredObjectDeleteMarker: true noncurrentVersionExpiration: 90 transitions: - storageClass: DEEP_ARCHIVE transitionAfter: 180 ```
Abort Incomplete Multipart Uploads (Optional)
Number of days after which incomplete multipart uploads are automatically aborted and cleaned up. This helps prevent storage costs from abandoned multipart uploads.
Benefits
- Cost Control: Prevents charges for incomplete upload parts
- Storage Cleanup: Automatically removes orphaned multipart data
- Operational Hygiene: Maintains clean bucket state
Considerations
- Set based on your typical upload patterns and file sizes
- Consider network reliability and upload duration requirements
- Balance between cost control and operational flexibility
Rule Enabled (Optional)
Controls whether this lifecycle rule is active and enforced. Allows you to temporarily disable rules without removing them from the configuration.
Object Expiration (Optional)
Number of days after object creation when objects are permanently deleted from the bucket. This implements automatic data retention policies and helps manage storage costs for time-sensitive data.
Use Cases
- Log Retention: Automatically delete old log files
- Compliance: Enforce data retention policies
- Cost Management: Remove data that's no longer needed
- Regulatory Requirements: Meet data disposal requirements
Important Considerations
- Irreversible: Expired objects are permanently deleted
- Compliance: Ensure retention periods meet regulatory requirements
- Business Needs: Consider future data access requirements
- Backup Strategy: Ensure critical data is backed up before expiration
Expired Object Delete Marker Cleanup (Optional)
Controls whether S3 automatically removes delete markers that have no non-current versions. This helps clean up versioned buckets and reduce storage costs from orphaned delete markers.
Benefits When Enabled
- Cost Reduction: Eliminates charges for orphaned delete markers
- Storage Optimization: Keeps bucket metadata clean
- Operational Efficiency: Reduces clutter in versioned buckets
Rule Identifier (Optional)
Unique, human-readable name for the lifecycle rule within the bucket. Used for rule identification, management, and troubleshooting.
Non-Current Version Expiration (Optional)
Number of days after an object version becomes non-current when it should be permanently deleted. This manages storage costs for versioned buckets by cleaning up old object versions.
Considerations
- Recovery Needs: Balance cost vs. ability to recover old versions
- Compliance: Some regulations require version retention
- Storage Costs: Non-current versions incur full storage charges
- Access Patterns: Consider how often old versions are accessed
Non-Current Version Transitions (Optional)
Array of transition rules that specify when non-current object versions should move to different storage classes. This optimizes costs for versioned buckets by moving old versions to cheaper storage.
Storage Class Optimization
Non-current versions are typically accessed less frequently than current versions, making them ideal candidates for cheaper storage classes.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Current Version Transitions (Optional)
Array of transition rules that specify when current objects should move to different storage classes. This implements cost optimization strategies based on data access patterns and age.
Cost Optimization Strategy
Design transitions based on your data access patterns:
- Frequently Accessed: Keep in Standard storage
- Infrequently Accessed: Transition to Standard-IA
- Archive Data: Move to Glacier or Deep Archive
- Long-term Retention: Use Deep Archive for lowest cost
Use this configuration to define Application Load Balancers (ALBs) or Network Load Balancers (NLBs) to be deployed in the specified VPC subnets.
(OPTIONAL) An array of Application Load Balancer (ALB) configurations. Use this property to define ALBs to be deployed in the specified VPC subnets.
(OPTIONAL) An array of Network Load Balancer (NLB) configurations. Use this property to define NLBs to be deployed in the specified VPC subnets.
Use this configuration to reference existing local gateways for your Outposts. The local gateway for your Outpost rack enables connectivity from your Outpost subnets to all AWS services that are available in the parent Region, in the same way that you access them from an Availability Zone subnet.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The route tables for the Local Gateway
Use this configuration to reference route tables for your Outposts local gateway. Outpost subnet route tables on a rack can include a route to your on-premises network. The local gateway routes this traffic for low latency routing to the on-premises network.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define AWS-managed NAT Gateways for your VPC. You can use a NAT gateway so that instances in a private subnet can connect to services outside your VPCs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Set true to define a NAT gateway with private connectivity type
(OPTIONAL) An array of tag objects for the NAT Gateway.
Use this configuration to define custom network ACLs for your VPC. A network ACL allows or denies specific inbound or outbound traffic at the subnet level. Network ACLs are stateless, which means that responses to allowed inbound traffic are subject to the rules for outbound traffic (and vice versa).
The following example shows an inbound and outbound rule that would allow inbound SSH traffic from the CIDR range 10.0.0.0/16.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
A list of subnets to associate with the Network ACL
(OPTIONAL) A list of inbound rules to define for the Network ACL
(OPTIONAL) A list of outbound rules to define for the Network ACL
(OPTIONAL) A list of tags to attach to the Network ACL
Use this configuration to define inbound rules for your network ACLs. An inbound rule allows or denies specific inbound traffic at the subnet level.
The following example allows inbound SSH traffic from source CIDR 10.0.0.0/16:
Allow/Deny Type
Represents permission states for access control and policy configurations. Used throughout the Landing Zone Accelerator for defining access permissions.
Values
- allow: Grant permission or enable access
- deny: Deny permission or block access
The {@link https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IANA protocol number } for the network ACL rule. You may also specify -1 for all protocols.
The rule ID number for the rule.
The source of the network ACL rule.
The port to start from in the network ACL rule.
(OPTIONAL) The Internet Control Message Protocol (ICMP) code and type. Required if specifying 1 (ICMP) for the protocol parameter.
The port to end with in the network ACL rule.
Use this configuration to define outbound rules for your network ACLs. An outbound rule allows or denies specific outbound traffic at the subnet level.
The following example allows outbound TCP traffic in the ephemeral port ranges to destination CIDR 10.0.0.0/16:
Allow/Deny Type
Represents permission states for access control and policy configurations. Used throughout the Landing Zone Accelerator for defining access permissions.
Values
- allow: Grant permission or enable access
- deny: Deny permission or block access
The destination of the network ACL rule.
The {@link https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IANA protocol number } for the network ACL rule. You may also specify -1 for all protocols.
The rule ID number for the rule.
The port to start from in the network ACL rule.
(OPTIONAL) The Internet Control Message Protocol (ICMP) code and type. Required if specifying 1 (ICMP) for the protocol parameter.
The port to end with in the network ACL rule.
Network ACL subnet selection configuration. Use this configuration to dynamically reference a subnet as a source/destination for a network ACL.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Indicates whether to target the IPv6 CIDR associated with a subnet.
(OPTIONAL) The region that the subnet is located in.
Network Configuration. Used to define a network configuration for the accelerator.
Use this configuration to delete default VPCs in your environment.
3 nested properties
Enable to delete default VPCs.
(OPTIONAL) Include an array of friendly account names to exclude from default VPC deletion.
(OPTIONAL) Include an array of AWS regions to exclude from default VPC deletion.
A list of VPC configurations. An array of VPC endpoint policies.
An array of Transit Gateway configurations.
An array of VPC configurations.
A map between account Id and all the VPC Endpoint IDs in the account.
Currently, the dynamic values will only be loaded in FinalizeStack for SCP finalization. Only the account VPC Endpoints referred by ACCEL_LOOKUP in SCPs will be loaded.
A map between account Id and all the VPC IDs in the account.
Currently, the dynamic values will only be loaded in FinalizeStack for SCP finalization. Only the account VPCs referred in SCPs by ACCEL_LOOKUP will be loaded.
Central network services configuration. Use this configuration to define centralized networking services for your environment. Central network services enables you to easily designate a central account that owns your core network infrastructure. These network resources can be shared with other accounts in your organization so that workload accounts can consume them.
5 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of Gateway Load Balancer configurations.
An array of IPAM configurations.
Use this configuration to define Network Firewalls in your environment. AWS Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for your virtual private cloud (VPC) that you create in Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect.
The following example creates a simple Network Firewall rule group, policy,
and firewall. The policy and rule group are shared with the entire organization.
The firewall endpoints are created in subnets named Subnet-A and Subnet-B
in the VPC named Network-Inspection.
3 nested properties
An array of Network Firewall firewall configurations.
An array of Network Firewall policy configurations.
An array of Network Firewall rule group configurations.
Use this configuration to define several features of Route 53 resolver, including resolver endpoints, DNS firewall rule groups, and DNS query logs. Amazon Route 53 Resolver responds recursively to DNS queries from AWS resources for public records, Amazon VPC-specific DNS names, and Amazon Route 53 private hosted zones, and is available by default in all VPCs.
4 nested properties
(OPTIONAL) An array of Route 53 resolver endpoint configurations.
(OPTIONAL) An array of Route 53 DNS firewall rule group configurations.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
(OPTIONAL) An array of Route 53 resolver rules.
Certificate manager configuration
An array of Customer Gateway configurations.
An optional list of DHCP options set configurations.
An optional array of Direct Connect Gateway configurations.
An optional ELB root account ID
An optional Firewall Manager Service Config
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The FMS Notification Channel Configuration
Accelerator home region name.
An optional list of prefix list set configurations.
An array of Transit Gateway Connect configurations.
Transit Gateway peering configuration.
VPC Flow Logs Configuration Interface
Interface for AWS VPC Flow Logs configuration, which captures information about IP traffic flowing to and from network interfaces in your VPCs. Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all network traffic in your VPCs
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about VPC Flow Logs.
6 nested properties
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where VPC flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination.
VPC Flow Logs Traffic Type
Defines which types of network traffic should be captured in VPC Flow Logs. This determines the scope of network visibility and the volume of log data generated.
Values
- ALL: Capture all network traffic (both accepted and rejected)
- ACCEPT: Capture only traffic that was allowed by security groups/NACLs
- REJECT: Capture only traffic that was blocked by security groups/NACLs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
An optional list of VPC peering configurations
An optional list of VPC template configurations
Network Load Balancer configuration.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Subnets to launch the Network Load Balancer in.
Cross Zone load balancing for Network Load Balancer.
Deletion protection for Network Load Balancer.
Listeners for Network Load Balancer.
Use this configuration to define Network Firewalls in your environment. AWS Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for your virtual private cloud (VPC) that you create in Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect.
The following example creates a simple Network Firewall rule group, policy,
and firewall. The policy and rule group are shared with the entire organization.
The firewall endpoints are created in subnets named Subnet-A and Subnet-B
in the VPC named Network-Inspection.
An array of Network Firewall firewall configurations.
An array of Network Firewall policy configurations.
An array of Network Firewall rule group configurations.
Use this configuration to define a Network Firewall firewall. An AWS Network Firewall firewall connects a firewall policy, which defines network traffic monitoring and filtering behavior, to the VPC that you want to protect. The firewall configuration includes specifications for the Availability Zones and subnets where the firewall endpoints are placed. It also defines high-level settings like the firewall logging configuration and tagging on the AWS firewall resource.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of the friendly names of subnets to deploy Network Firewall to.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Enable for deletion protection on the firewall.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Enable to disallow firewall policy changes.
(OPTIONAL) An array of Network Firewall logging configurations.
(OPTIONAL) Enable to disallow firewall subnet changes.
(OPTIONAL) An array of tags for the firewall.
Use this configuration to define a Network Firewall policy. An AWS Network Firewall firewall policy defines the monitoring and protection behavior for a firewall. The details of the behavior are defined in the rule groups that you add to your policy, and in some policy default settings.
Use this configuration to define how the Network Firewall policy will behave. An AWS Network Firewall firewall policy defines the monitoring and protection behavior for a firewall. The details of the behavior are defined in the rule groups that you add to your policy, and in some policy default settings.
7 nested properties
An array of default actions to take on packets evaluated by the stateless engine.
An array of default actions to take on fragmented packets.
(OPTIONAL) An array of default actions to take on packets evaluated by the stateful engine.
{OPTIONAL) An array of Network Firewall stateful rule group reference configurations.
(OPTIONAL) An array of Network Firewall custom action configurations.
(OPTIONAL) An array of Network Firewall stateless rule group reference configurations.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The regions to deploy the policy to.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of tags for the policy.
Use this configuration to define how the Network Firewall policy will behave. An AWS Network Firewall firewall policy defines the monitoring and protection behavior for a firewall. The details of the behavior are defined in the rule groups that you add to your policy, and in some policy default settings.
An array of default actions to take on packets evaluated by the stateless engine.
An array of default actions to take on fragmented packets.
(OPTIONAL) An array of default actions to take on packets evaluated by the stateful engine.
{OPTIONAL) An array of Network Firewall stateful rule group reference configurations.
(OPTIONAL) An array of Network Firewall custom action configurations.
(OPTIONAL) An array of Network Firewall stateless rule group reference configurations.
Use this configuration to define logging destinations for Network Firewall. You can configure AWS Network Firewall logging for your firewall's stateful engine. Logging gives you detailed information about network traffic, including the time that the stateful engine received a packet, detailed information about the packet, and any stateful rule action taken against the packet. The logs are published to the log destination that you've configured, where you can retrieve and view them.
Log Destination Type
Defines the supported destinations for storing and processing log data from various AWS services like VPC Flow Logs, CloudTrail, and other logging services.
Values
- s3: Amazon S3 for cost-effective long-term storage and batch analysis
- cloud-watch-logs: CloudWatch Logs for real-time monitoring and alerting
Use this configuration to define stateful and stateless rule groups for Network Firewall. An AWS Network Firewall rule group is a reusable set of criteria for inspecting and handling network traffic. You add one or more rule groups to a firewall policy as part of policy configuration.
The capacity of the rule group.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The regions to deploy the rule group to.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Network Firewall rule group rule configuration. Used to define rules for a Network Firewall rule group.
3 nested properties
Network Firewall rule source configuration. Use this configuration to define stateful and/or stateless rules for your Network Firewall. The following rules sources are supported:
- File with list of Suricata-compatible rules
- Domain list
- Single Suricata-compatible rule
- Stateful rule in IP header format
- Stateless rules and custom actions
5 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define DNS domain allow and deny lists for Network Firewall. Domain lists allow you to configure domain name filtering for your Network Firewall.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of Network Firewall stateful rule IP header configurations. Use this property to define a stateful rule in IP header format for Network Firewall.
Use this configuration to define stateless rules and custom actions for Network Firewall.
Use this configuration to define rule variable definitions for Network Firewall. Rule variables can be used in Suricata-compatible and domain list rule definitions. They are not supported in stateful rule IP header definitions.
2 nested properties
A Network Firewall rule variable definition configuration.
A Network Firewall rule variable definition configuration.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of tags for the rule group.
Network Firewall rule group rule configuration. Used to define rules for a Network Firewall rule group.
Network Firewall rule source configuration. Use this configuration to define stateful and/or stateless rules for your Network Firewall. The following rules sources are supported:
- File with list of Suricata-compatible rules
- Domain list
- Single Suricata-compatible rule
- Stateful rule in IP header format
- Stateless rules and custom actions
5 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define DNS domain allow and deny lists for Network Firewall. Domain lists allow you to configure domain name filtering for your Network Firewall.
3 nested properties
An array of protocol types to inspect.
An array of target domain names.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of Network Firewall stateful rule IP header configurations. Use this property to define a stateful rule in IP header format for Network Firewall.
Use this configuration to define stateless rules and custom actions for Network Firewall.
2 nested properties
An array of Network Firewall stateless rule configurations.
An array of Network Firewall custom action configurations.
Use this configuration to define rule variable definitions for Network Firewall. Rule variables can be used in Suricata-compatible and domain list rule definitions. They are not supported in stateful rule IP header definitions.
2 nested properties
A Network Firewall rule variable definition configuration.
A Network Firewall rule variable definition configuration.
Network Firewall rule source configuration. Use this configuration to define stateful and/or stateless rules for your Network Firewall. The following rules sources are supported:
- File with list of Suricata-compatible rules
- Domain list
- Single Suricata-compatible rule
- Stateful rule in IP header format
- Stateless rules and custom actions
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define DNS domain allow and deny lists for Network Firewall. Domain lists allow you to configure domain name filtering for your Network Firewall.
3 nested properties
An array of protocol types to inspect.
An array of target domain names.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of Network Firewall stateful rule IP header configurations. Use this property to define a stateful rule in IP header format for Network Firewall.
Use this configuration to define stateless rules and custom actions for Network Firewall.
2 nested properties
An array of Network Firewall stateless rule configurations.
An array of Network Firewall custom action configurations.
Use this configuration to define to define custom actions for Network Firewall. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
Use this configuration to define custom CloudWatch metrics for Network Firewall. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
1 nested properties
Use this configuration to define custom action dimensions to log in CloudWatch metrics. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
1 nested properties
An array of values of the custom metric dimensions to log.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define custom CloudWatch metrics for Network Firewall. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
Use this configuration to define custom action dimensions to log in CloudWatch metrics. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
1 nested properties
An array of values of the custom metric dimensions to log.
Use this configuration to define custom action dimensions to log in CloudWatch metrics. You can optionally specify a named custom action to apply. For this action, Network Firewall assigns a dimension to Amazon CloudWatch metrics with the name set to CustomAction and a value that you specify.
An array of values of the custom metric dimensions to log.
Use this configuration to define DNS domain allow and deny lists for Network Firewall. Domain lists allow you to configure domain name filtering for your Network Firewall.
An array of protocol types to inspect.
An array of target domain names.
Use this configuration to define stateful rules for Network Firewall in an IP packet header format. This header format can be used instead of Suricata-compatible rules to define your stateful firewall filtering behavior.
Use this configuration to define stateful rules for Network Firewall in an IP packet header format. This header format can be used instead of Suricata-compatible rules to define your stateful firewall filtering behavior.
6 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of Network Firewall stateful rule options configurations.
Use this configuration to define stateful rules for Network Firewall in an IP packet header format. This header format can be used instead of Suricata-compatible rules to define your stateful firewall filtering behavior.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Network Firewall stateful rule options configuration. Use this configuration to specify keywords and setting metadata for stateful rules.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of values for the keyword.
Use this configuration to define stateless rule match attributes for Network Firewall. To be a match, a packet must satisfy all of the match settings in the rule.
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of destination CIDR ranges to inspect for.
(OPTIONAL) An array of IP protocol numbers to inspect for.
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of source CIDR ranges to inspect for.
(OPTIONAL) An array of Network Firewall stateless TCP flag configurations.
Use this configuration to define a port range in stateless rules.
The port to start from in the range.
The port to end with in the range.
Use this configuration to define stateless rule for your Network Firewall. Network Firewall supports the standard stateless 5-tuple rule specification for network traffic inspection. When Network Firewall finds a match between a rule's inspection criteria and a packet, we say that the packet matches the rule and its rule group, and Network Firewall applies the rule's specified action to the packet.
The priority number for the rule.
Use this configuration to define a stateless rule definition for your Network Firewall.
2 nested properties
An array of actions to take using the stateless rule engine.
Use this configuration to define stateless rule match attributes for Network Firewall. To be a match, a packet must satisfy all of the match settings in the rule.
6 nested properties
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of destination CIDR ranges to inspect for.
(OPTIONAL) An array of IP protocol numbers to inspect for.
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of source CIDR ranges to inspect for.
(OPTIONAL) An array of Network Firewall stateless TCP flag configurations.
Use this configuration to define a stateless rule definition for your Network Firewall.
An array of actions to take using the stateless rule engine.
Use this configuration to define stateless rule match attributes for Network Firewall. To be a match, a packet must satisfy all of the match settings in the rule.
6 nested properties
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of destination CIDR ranges to inspect for.
(OPTIONAL) An array of IP protocol numbers to inspect for.
(OPTIONAL) An array of Network Firewall stateless port range configurations.
(OPTIONAL) An array of source CIDR ranges to inspect for.
(OPTIONAL) An array of Network Firewall stateless TCP flag configurations.
Use this configuration to define TCP flags to inspect in stateless rules. Optional, standard TCP flag settings, which indicate which flags to inspect and the values to inspect for.
An array of TCP flags.
The set of flags to consider in the inspection.
Use this configuration to define rule variable definitions for Network Firewall. Rule variables can be used in Suricata-compatible and domain list rule definitions. They are not supported in stateful rule IP header definitions.
A Network Firewall rule variable definition configuration.
A Network Firewall rule variable definition configuration.
Use this configuration to define rule variable definitions for Network Firewall. Rule variables can be used in Suricata-compatible and domain list rule definitions. They are not supported in stateful rule IP header definitions.
An array of values for the rule variable.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Network Firewall stateful rule group reference configuration. Use this configuration to reference a stateful rule group in a Network Firewall policy.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) If using strict ordering, a priority number for the rule.
Network Firewall stateless rule group reference configuration. Use this configuration to reference a stateless rule group in a Network Firewall policy.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
A priority number for the rule.
Use this configuration to define stateless rules and custom actions for Network Firewall.
An array of Network Firewall stateless rule configurations.
An array of Network Firewall custom action configurations.
Application Load Balancer listener config. Currently only action type of forward, redirect and fixed-response is allowed.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Port where the traffic is directed to.
The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to reference Outposts that exist in your environment. AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The availability zone where the Outpost resides
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to reference existing local gateways for your Outposts. The local gateway for your Outpost rack enables connectivity from your Outpost subnets to all AWS services that are available in the parent Region, in the same way that you access them from an Availability Zone subnet.
3 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The route tables for the Local Gateway
Internet Key Exchange (IKE) Phase 1 tunnel options configuration. Use this configuration to restrict the permitted Diffie-Hellman group numbers, encryption algorithms, and integrity algorithms for IKE Phase 1 negotiations. You may also modify the Phase 1 lifetime for the VPN tunnel.
(OPTIONAL) An array of permitted Diffie-Hellman group numbers used in the IKE Phase 1 for initial authentication.
Default - [2, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]
(OPTIONAL) An array of encryption algorithms permitted for IKE Phase 1 negotiations.
Default - [AES128, AES256, AES128-GCM-16, AES256-GCM-16]
(OPTIONAL) An array of integrity algorithms permitted for IKE Phase 1 negotiations.
Default - [SHA1, SHA2-256, SHA2-384, SHA2-512]
(OPTIONAL) The IKE Phase 1 lifetime (in seconds) for the VPN tunnel.
Default: 28800 (8 hours)
Internet Key Exchange (IKE) Phase 2 tunnel options configuration. Use this configuration to restrict the permitted Diffie-Hellman group numbers, encryption algorithms, and integrity algorithms for IKE Phase 2 negotiations. You may also modify the Phase 2 lifetime for the VPN tunnel.
(OPTIONAL) An array of permitted Diffie-Hellman group numbers used in the IKE Phase 2 negotiations.
Default - [2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]
(OPTIONAL) An array of encryption algorithms permitted for IKE Phase 2 negotiations.
Default - [AES128, AES256, AES128-GCM-16, AES256-GCM-16]
(OPTIONAL) An array of integrity algorithms permitted for IKE Phase 2 negotiations.
Default - [SHA1, SHA2-256, SHA2-384, SHA2-512]
(OPTIONAL) The IKE Phase 2 lifetime (in seconds) for the VPN tunnel.
Default: 3600 (1 hour)
Use this configuration to define custom prefix lists for your environment. A managed prefix list is a set of one or more CIDR blocks. You can use prefix lists to make it easier to configure and maintain your security groups and route tables.
The following example creates a prefix list named accelerator-pl that may contain up to 10 entries.
The prefix list is deployed to all accounts in the organization.
An array of CIDR entries for the prefix list.
The maximum allowed entries in the prefix list.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(DEPRECATED) An array of friendly names for the accounts the prefix list is deployed.
Deployment Targets Interface
Defines where AWS resources should be deployed within your AWS organization. This interface provides flexible targeting options for resource deployment across accounts, organizational units, and regions.
Key Features
- Account-level targeting: Deploy to specific AWS accounts
- OU-level targeting: Deploy to all accounts within organizational units
- Regional exclusions: Skip specific AWS regions for compliance or cost optimization
- Account exclusions: Exclude specific accounts from broader deployments
Example
yaml deploymentTargets: organizationalUnits: - Production - Development excludedAccounts: - Management excludedRegions: - us-west-1
4 nested properties
Target Accounts (Optional)
List of specific account names where resources should be deployed. Use for precise account-level targeting.
Excluded Accounts (Optional)
List of account names to exclude from deployment. Takes precedence over organizational unit and account inclusions.
Excluded Regions (Optional)
List of AWS regions to exclude from deployment. Useful for compliance requirements or cost optimization.
Organizational Units (Optional)
List of organizational unit names where resources should be deployed. When specified, resources will be created in all accounts within these OUs.
(DEPRECATED) An array of region names for the prefix list to be deployed.
(OPTIONAL) An array of tag objects for the prefix list.
Prefix list security group source configuration. Use this configuration to define a custom prefix list as a source in a security group rule.
An array of the friendly names of prefix lists to reference.
Use this configuration to define several features of Route 53 resolver, including resolver endpoints, DNS firewall rule groups, and DNS query logs. Amazon Route 53 Resolver responds recursively to DNS queries from AWS resources for public records, Amazon VPC-specific DNS names, and Amazon Route 53 private hosted zones, and is available by default in all VPCs.
(OPTIONAL) An array of Route 53 resolver endpoint configurations.
(OPTIONAL) An array of Route 53 DNS firewall rule group configurations.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
4 nested properties
An array of destination services used to store the logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of Route 53 resolver rules.
Use this configuration to define inbound and outbound resolver endpoints. Route 53 Resolver contains endpoints that you configure to answer DNS queries to and from your on-premises environment.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of friendly names for subnets to deploy the resolver endpoint to.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) The allowed ingress/egress CIDRs for the resolver endpoint security group.
(OPTIONAL) An array of DNS Queries over HTTPS (DoH) Protocols to apply to the Route 53 Resolver Endpoints.
(OPTIONAL) An array of resolver rule configurations for the endpoint.
(OPTIONAL) An array of tags for the resolver endpoint.
Use this configuration to define resolver SYSTEM and FORWARD rules for your resolver. If you want Resolver to forward queries for specified domain names to your network, you create one forwarding rule for each domain name and specify the name of the domain for which you want to forward queries.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Regions to exclude from SYSTEM rule deployment.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of tags for the resolver rule.
(OPTIONAL) An array of target IP configurations for the resolver rule.
Use this configuration to define custom route tables for your VPC. Route tables contain a set of rules, called routes, to determine where network traffic from a subnet or gateway is directed.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of VPC route table entry configuration objects.
(OPTIONAL) An array of tag objects for the VPC route table.
Use this configuration to define static route entries in a VPC subnet or gateway route table. Static routes are used determine traffic flow from your subnet to a defined destination address and target.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The Availability Zone (AZ) the target resides in.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define security groups in your VPC. A security group acts as a firewall that controls the traffic allowed to and from the resources in your VPC. You can choose the ports and protocols to allow for inbound and outbound traffic.
The following example creates a security group that allows inbound RDP and SSH traffic from source CIDR 10.0.0.0/16. It also allows all outbound traffic.
An array of security group rule configurations for ingress rules.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of security group rule configurations for egress rules.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the security group.
Use this configuration to define ingress and egress rules for your security groups. The rules of a security group control the inbound traffic that's allowed to reach the resources that are associated with the security group. The rules also control the outbound traffic that's allowed to leave them.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of sources for the security group rule.
(OPTIONAL) The port to start from in the security group rule.
(OPTIONAL) An array of custom IP Protocols for the security group rule
(OPTIONAL) An array of TCP ports to include in the security group rule.
(OPTIONAL) The port to end with in the security group rule.
(OPTIONAL) An array of port/protocol types to include in the security group rule.
(OPTIONAL) An array of UDP ports to include in the security group rule.
Security group source configuration. Use this configuration to define a security group as a source of a security group rule.
An array of the friendly names of security group rules to reference.
Use this configuration to define subnets for your VPC. A subnet is a range of IP addresses in your VPC that can be used to create AWS resources, such as EC2 instances.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Indicates whether a network interface created in this subnet receives an IPv6 address on creation.
The Availability Zone (AZ) the subnet resides in.
(OPTIONAL) Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
For more information, see {@link https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64 DNS64 and NAT64 } in the Amazon Virtual Private Cloud User Guide.
Use this configuration to dynamically assign a VPC or subnet CIDR from an IPAM pool.
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The subnet mask length to request.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Configure automatic mapping of public IPs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define custom DNS name settings for your VPC subnets.
3 nested properties
(OPTIONAL) Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
(OPTIONAL) Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
The type of hostname for EC2 instances.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of tag objects for the VPC subnet.
Use this configuration to define custom DNS name settings for your VPC subnets.
(OPTIONAL) Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
(OPTIONAL) Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
The type of hostname for EC2 instances.
VPC subnet security group source configuration. Use this configuration to dynamically reference subnet CIDRs in a security group rule.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of the friendly names of subnets to reference.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Indicates whether to target the IPv6 CIDR associated with a subnet.
AWS Resource Tag Configuration
Defines key-value pairs used for tagging AWS resources. Tags provide metadata for resource organization, cost allocation, access control, and automation.
Key Features
- Resource Organization: Group and categorize resources logically
- Cost Allocation: Track costs by project, department, or environment
- Access Control: Use tags in IAM policies for conditional access
- Automation: Trigger automated actions based on tag values
- Compliance: Meet organizational and regulatory tagging requirements
Example
yaml tags: - key: Environment value: Production - key: Project value: WebApplication - key: Owner value: Platform-Team - key: CostCenter value: Engineering - key: Backup value: Daily
Tag Key (Required)
The tag key name that identifies the type of metadata being stored. Tag keys should follow consistent naming conventions across your organization.
Tag Value (Required)
The tag value that provides the actual metadata content for the tag key. Values should be meaningful and follow organizational standards.
Set attributes for target group.
The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.
The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. The following attribute is supported only by Network Load Balancers.
Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.
The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Indicates whether target stickiness is enabled. The value is true or false. The default is false.
Configure health check for target group.
The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.
The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds.
Target Group Configuration
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The port on which the targets receive traffic.
Set attributes for target group.
12 nested properties
The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.
The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. The following attribute is supported only by Network Load Balancers.
Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.
The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.
Indicates whether target stickiness is enabled. The value is true or false. The default is false.
Configure health check for target group.
5 nested properties
The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.
The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds.
Add the ability to target an NLB created by the Landing Zone Accelerator
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
Target group targets. These targets should be the friendly names assigned to firewall instances.
Configure health check threshold for target group.
2 nested properties
The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 3.
The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 3.
Add the ability to target an NLB created by the Landing Zone Accelerator
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Configure health check threshold for target group.
The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 3.
The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 3.
Use this configuration to define a Transit Gateway attachment to your VPC. Transit Gateway attachments allow you to interconnect your virtual private clouds (VPCs) and on-premises networks. Defining a VPC attachment deploys an elastic network interface within VPC subnets, which is then used by the transit gateway to route traffic to and from the chosen subnets.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of the friendly names of VPC subnets for the attachment to be deployed.
Use this configuration to target a Transit Gateway when defining an attachment for your VPC.
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Used to specify advanced options for the VPC attachment.
4 nested properties
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
The friendly name of a Transit Gateway route table to associate the attachment to.
An array of friendly names of Transit Gateway route tables to propagate the attachment.
(OPTIONAL) An array of tag objects for the Transit Gateway attachment.
Used to specify advanced options for the VPC attachment.
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Use this configuration to target a Transit Gateway when defining an attachment for your VPC.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define Transit Gateways for your environment. A transit gateway acts as a virtual router for traffic flowing between your virtual private clouds (VPCs) and on-premises networks.
The following example creates a TGW called Network-Main in the Network account in the us-east-1 region.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
A Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The region name to deploy the Transit Gateway.
An array of Transit Gateway route table configuration objects.
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Enable/Disable Type
Represents activation states for features and services throughout the Landing Zone Accelerator configuration.
Values
- enable: Activate the feature or service
- disable: Deactivate the feature or service
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
(OPTIONAL) An array of tag objects for the Transit Gateway.
(OPTIONAL) A list of transit gateway IPv4 CIDR blocks.
Transit Gateway Flow Logs Configuration Interface
Interface for AWS Transit Gateway Flow Logs configuration, which captures information about IP traffic flowing to and from Transit Gateways . Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all Transit Gateway network traffic
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about Transit Gateway Flow Logs.
5 nested properties
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where Transit Gateway flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination. This value must be 60 for Transit Gateway Flow Logs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
(OPTIONAL) A list of transit gateway IPv6 CIDR blocks.
Use this configuration to define a Transit Gateway Connect attachment to your Direct Connect Gateway.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to target a Transit Gateway when defining an attachment for your VPC.
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the Transit Gateway attachment.
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway Flow Logs Configuration Interface
Interface for AWS Transit Gateway Flow Logs configuration, which captures information about IP traffic flowing to and from Transit Gateways . Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all Transit Gateway network traffic
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about Transit Gateway Flow Logs.
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where Transit Gateway flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination. This value must be 60 for Transit Gateway Flow Logs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Retention in Days (Optional)
Number of days to retain flow logs in CloudWatch Logs. After this period, logs are automatically deleted to control costs.
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
2 nested properties
Lifecycle Rules (Optional)
S3 lifecycle rules to manage flow log files automatically. Controls when logs transition to cheaper storage classes and when they expire.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway (TGW) peering accepter configuration. Use this configuration to define the accepter side of the peering attachment.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The name of the region the accepter transit gateway resides in
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Peering request apply tags flag. Note: When this flag is set to true, the requester attachment tags are replicated to the accepter attachment.
(OPTIONAL) Peering request auto accept flag. Note: When this flag is set to true, the peering request will be automatically accepted by the accelerator.
Use this configuration to define a peering attachment between two TGWs.
Transit Gateway (TGW) peering accepter configuration. Use this configuration to define the accepter side of the peering attachment.
6 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The name of the region the accepter transit gateway resides in
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Peering request apply tags flag. Note: When this flag is set to true, the requester attachment tags are replicated to the accepter attachment.
(OPTIONAL) Peering request auto accept flag. Note: When this flag is set to true, the peering request will be automatically accepted by the accelerator.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway (TGW) peering requester configuration. Use this configuration to define the requester side of the peering attachment.
5 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The name of the region the accepter transit gateway resides in
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the Transit Gateway Peering.
Transit Gateway (TGW) peering requester configuration. Use this configuration to define the requester side of the peering attachment.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The name of the region the accepter transit gateway resides in
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of tag objects for the Transit Gateway Peering.
Use this configuration to define static route entries in a Transit Gateway route table.
The target {@link https://docs.aws.amazon.com/vpc/latest/tgw/working-with-transit-gateways.html Transit Gateway attachment } for the route table entry. Supported attachment types include:
- VPC
- Direct Connect Gateway
- VPN
- Transit Gateway Peering
(OPTIONAL) Enable to create a blackhole for the destination CIDR. Leave undefined if specifying a VPC destination.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration define route tables for your Transit Gateway. Route tables are used to configure routing behaviors for your Transit Gateway.
The following example creates a TGW route table called Network-Main-Shared with no static route entries:
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of Transit Gateway route entry configuration objects.
(OPTIONAL) An array of tag objects for the Transit Gateway route table.
Transit Gateway Direct Connect Gateway static route entry configuration. Use this configuration to define a Direct Connect Gateway attachment as a target for Transit Gateway static routes.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway peering static route entry configuration. Used to define a peering attachment as a target for Transit Gateway static routes.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway VPC static route entry configuration. Use this configuration to define an account and VPC name as a target for Transit Gateway static route entries.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Transit Gateway VPN static route entry configuration. Use this configuration to define a VPN attachment as a target for Transit Gateway static routes.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
S3 Storage Class Transition Configuration
Defines when and how objects should transition from their current storage class to a different storage class. Used in S3 lifecycle rules to optimize storage costs based on data access patterns and retention requirements.
Key Components
- Storage Class: Target storage class for the transition
- Transition Timing: Number of days after object creation or version change
Example
yaml transitions: - storageClass: STANDARD_IA transitionAfter: 30 - storageClass: GLACIER transitionAfter: 365 - storageClass: DEEP_ARCHIVE transitionAfter: 2555
S3 Storage Class Type
Defines the available Amazon S3 storage classes for lifecycle transitions. Each storage class is optimized for different access patterns, durability requirements, and cost considerations.
Transition After (Days) (Required)
Number of days after object creation (for current versions) or after becoming non-current (for non-current versions) when the transition should occur.
Used to define Virtual Private Gateways that are attached to a VPC. You can create an IPsec VPN connection between your VPC and your remote network. On the AWS side of the Site-to-Site VPN connection, a virtual private gateway or transit gateway provides two VPN endpoints (tunnels) for automatic failover.
Define the ASN (Amazon Side) used for the Virtual Private Gateway
Use this configuration to define a VPC that is deployed to a single account and region. With Amazon Virtual Private Cloud (Amazon VPC), you can launch AWS resources in a logically isolated virtual network that you've defined. This virtual network closely resembles a traditional network that you'd operate in your own data center, with the benefits of using the scalable infrastructure of AWS.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The AWS region to deploy the VPC to
(OPTIONAL) A list of IPv4 CIDRs to associate with the VPC.
(OPTIONAL) Determine if the all traffic ingress and egress rules are deleted in the default security group of a VPC.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of DNS firewall VPC association configurations. Use this property to associate Route 53 resolver DNS firewall rule groups with the VPC.
(OPTIONAL) Create an {@link https://docs.aws.amazon.com/vpc/latest/userguide/egress-only-internet-gateway.html Egress-only internet gateway (EIGW) } for the VPC
Enable DNS hostname support for the VPC.
Enable DNS support for the VPC.
Use this configuration to define gateway endpoints for your VPC. A gateway endpoint targets specific IP routes in an Amazon VPC route table, in the form of a prefix-list, used for traffic destined to Amazon DynamoDB or Amazon Simple Storage Service (Amazon S3).
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of endpoints to create.
Use this configuration to define interface endpoints for your VPC. Interface endpoints powered by AWS PrivateLink to connect your VPC to AWS services as if they were in your VPC, without the use of an internet gateway.
6 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of VPC interface endpoint services to be deployed.
An array of the friendly names of VPC subnets for the endpoints to be deployed.
(OPTIONAL) An array of source CIDRs allowed to communicate with the endpoints.
(OPTIONAL) Enable to define interface endpoints as centralized endpoints.
(OPTIONAL) An array of tag objects for the private hosted zones associated with the VPC Interface endpoints.
Defines if an {@link https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html internet gateway } should be added to the VPC
(OPTIONAL) An array of IPAM allocation configurations.
(OPTIONAL) An array of IPv6 CIDR block configurations.
Use this configuration to define Application Load Balancers (ALBs) or Network Load Balancers (NLBs) to be deployed in the specified VPC subnets.
2 nested properties
(OPTIONAL) An array of Application Load Balancer (ALB) configurations. Use this property to define ALBs to be deployed in the specified VPC subnets.
(OPTIONAL) An array of Network Load Balancer (NLB) configurations. Use this property to define NLBs to be deployed in the specified VPC subnets.
(OPTIONAL) An array of NAT gateway configurations for the VPC. Use this property to configure the NAT gateways for the VPC.
(OPTIONAL) A list of Network Access Control Lists (ACLs) to deploy for this VPC
(OPTIONAL) An array of Local Gateway Route table configurations. Use this configuration to associate Outposts Local Gateway Route tables with the VPC.
(OPTIONAL) A list of DNS query log configuration names.
(OPTIONAL) A list of Route 53 resolver rule names.
(OPTIONAL) An array of route table configurations for the VPC. Use this property to configure the route tables for the VPC.
(OPTIONAL) A list of Security Groups to deploy for this VPC
(OPTIONAL) An array of subnet configurations for the VPC. Use this property to configure the subnets for the VPC.
(OPTIONAL) A list of tags to apply to this VPC
Target group configuration. Use this property to define target groups for this VPC.
(OPTIONAL) An array of Transit Gateway attachment configurations. Use this property to configure the Transit Gateway attachments for the VPC.
(OPTIONAL) When set to true, this VPC will be configured to utilize centralized endpoints. This includes having the Route 53 Private Hosted Zone associated with this VPC. Centralized endpoints are configured per region, and can span to spoke accounts.
NOTE: The AWS partition and regions must support the creation of Route 53 private hosted zones and DNS alias records for AWS VPC Endpoint resource types or the pipeline will fail. Ensure your partition and regions will support useCentralEndpoints before enabling it.
Used to define Virtual Private Gateways that are attached to a VPC. You can create an IPsec VPN connection between your VPC and your remote network. On the AWS side of the Site-to-Site VPN connection, a virtual private gateway or transit gateway provides two VPN endpoints (tunnels) for automatic failover.
1 nested properties
Define the ASN (Amazon Side) used for the Virtual Private Gateway
VPC Flow Logs Configuration Interface
Interface for AWS VPC Flow Logs configuration, which captures information about IP traffic flowing to and from network interfaces in your VPCs. Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all network traffic in your VPCs
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about VPC Flow Logs.
6 nested properties
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where VPC flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination.
VPC Flow Logs Traffic Type
Defines which types of network traffic should be captured in VPC Flow Logs. This determines the scope of network visibility and the volume of log data generated.
Values
- ALL: Capture all network traffic (both accepted and rejected)
- ACCEPT: Capture only traffic that was allowed by security groups/NACLs
- REJECT: Capture only traffic that was blocked by security groups/NACLs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
Use this configuration to define local resolver endpoints and Route 53 query logging to the VPC.
2 nested properties
(OPTIONAL) An array of Route 53 resolver endpoint configurations.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
4 nested properties
An array of destination services used to store the logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Retention in Days (Optional)
Number of days to retain flow logs in CloudWatch Logs. After this period, logs are automatically deleted to control costs.
VPC Flow Logs Configuration Interface
Interface for AWS VPC Flow Logs configuration, which captures information about IP traffic flowing to and from network interfaces in your VPCs. Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all network traffic in your VPCs
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about VPC Flow Logs.
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where VPC flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination.
VPC Flow Logs Traffic Type
Defines which types of network traffic should be captured in VPC Flow Logs. This determines the scope of network visibility and the volume of log data generated.
Values
- ALL: Capture all network traffic (both accepted and rejected)
- ACCEPT: Capture only traffic that was allowed by security groups/NACLs
- REJECT: Capture only traffic that was blocked by security groups/NACLs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Retention in Days (Optional)
Number of days to retain flow logs in CloudWatch Logs. After this period, logs are automatically deleted to control costs.
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
2 nested properties
Lifecycle Rules (Optional)
S3 lifecycle rules to manage flow log files automatically. Controls when logs transition to cheaper storage classes and when they expire.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Retention in Days (Optional)
Number of days to retain flow logs in CloudWatch Logs. After this period, logs are automatically deleted to control costs.
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
2 nested properties
Lifecycle Rules (Optional)
S3 lifecycle rules to manage flow log files automatically. Controls when logs transition to cheaper storage classes and when they expire.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
Lifecycle Rules (Optional)
S3 lifecycle rules to manage flow log files automatically. Controls when logs transition to cheaper storage classes and when they expire.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
VPC IPv6 static CIDR configuration. Use this to associate a static IPv6 CIDR block to your VPC.
(OPTIONAL) Indicates whether Amazon automatically provisions a /56 IPv6 CIDR block for the VPC.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
VPC peering configuration. Used to define VPC peering connections.
VPC can be from vpc or vpcTemplates configuration.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The VPCs to peer.
VPC can be from vpc or vpcTemplates configuration.
An array of tags for the peering connection.
Use this configuration to define local resolver endpoints and Route 53 query logging to the VPC.
(OPTIONAL) An array of Route 53 resolver endpoint configurations.
Use this configuration to define a centralized query logging configuration that can be associated with VPCs in your environment. You can use this configuration to log queries that originate from your VPCs, queries to your inbound and outbound resolver endpoints, and queries that use Route 53 Resolver DNS firewall to allow, block, or monitor domain lists.
The following example creates a query logging configuration that logs to both S3 and a CloudWatch Logs log group. It is shared with the entire organization.
4 nested properties
An array of destination services used to store the logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Resource Access Manager (RAM) Share Targets Interface
Interface for AWS Resource Access Manager (RAM) share targets, which defines where shared resources should be made available within your AWS organization. RAM enables secure sharing of resources between AWS accounts and organizational units without duplicating resources or compromising security.
Key Features
- Cross-Account Sharing: Share resources across multiple AWS accounts
- OU-Level Sharing: Share with entire organizational units at once
- Centralized Management: Manage shared resources from a central account
- Cost Optimization: Avoid resource duplication across accounts
- Security: Maintain resource ownership while enabling controlled access
Example
yaml shareTargets: organizationalUnits: - Root
Learn more about AWS Resource Access Manager.
2 nested properties
Target Accounts (Optional)
List of specific account names that should receive access to the shared resource. Use this for precise, account-level control over resource sharing.
Organizational Units (Optional)
List of organizational unit names that should receive access to the shared resource. When specified, all accounts within these OUs will be able to consume the shared resource.
Use this configuration to define a VPC using a standard configuration that is deployed to multiple account(s)/OU(s) defined using a deploymentTargets property.
With Amazon Virtual Private Cloud (Amazon VPC), you can launch AWS resources in a logically
isolated virtual network that you've defined. This virtual network closely resembles a traditional
network that you'd operate in your own data center, with the benefits of using the scalable infrastructure of AWS.
Static CIDR:
vpcTemplates:
- name: Accelerator-Template
deploymentTargets:
organizationalUnits:
- Infrastructure
region: us-east-1
cidrs:
- 10.0.0.0/24
enableDnsHostnames: true
enableDnsSupport: true
instanceTenancy: default
routeTables: []
subnets: []
natGateways: []
transitGatewayAttachments: []
tags: []
IPAM allocation:
vpcTemplates:
- name: Accelerator-Template
deploymentTargets:
organizationalUnits:
- Infrastructure
region: us-east-1
ipamAllocations:
- ipamPoolName: accelerator-regional-pool
netmaskLength: 24
enableDnsHostnames: true
enableDnsSupport: true
instanceTenancy: default
routeTables: []
subnets: []
natGateways: []
transitGatewayAttachments: []
tags: []
Static IPv6 CIDR:
vpcTemplates:
- name: Accelerator-Template
deploymentTargets:
organizationalUnits:
- Infrastructure
region: us-east-1
cidrs:
- 10.0.0.0/24
ipv6Cidrs:
- amazonProvided: true
enableDnsHostnames: true
enableDnsSupport: true
instanceTenancy: default
routeTables: []
subnets: []
natGateways: []
transitGatewayAttachments: []
tags: []
Deployment Targets Interface
Defines where AWS resources should be deployed within your AWS organization. This interface provides flexible targeting options for resource deployment across accounts, organizational units, and regions.
Key Features
- Account-level targeting: Deploy to specific AWS accounts
- OU-level targeting: Deploy to all accounts within organizational units
- Regional exclusions: Skip specific AWS regions for compliance or cost optimization
- Account exclusions: Exclude specific accounts from broader deployments
Example
yaml deploymentTargets: organizationalUnits: - Production - Development excludedAccounts: - Management excludedRegions: - us-west-1
4 nested properties
Target Accounts (Optional)
List of specific account names where resources should be deployed. Use for precise account-level targeting.
Excluded Accounts (Optional)
List of account names to exclude from deployment. Takes precedence over organizational unit and account inclusions.
Excluded Regions (Optional)
List of AWS regions to exclude from deployment. Useful for compliance requirements or cost optimization.
Organizational Units (Optional)
List of organizational unit names where resources should be deployed. When specified, resources will be created in all accounts within these OUs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
The AWS region to deploy the VPCs to
(OPTIONAL) A list of IPv4 CIDRs to associate with the VPC.
(OPTIONAL) Determine if the all traffic ingress and egress rules are deleted in the default security group of a VPC.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) An array of DNS firewall VPC association configurations. Use this property to associate Route 53 resolver DNS firewall rule groups with the VPC.
(OPTIONAL) Create an {@link https://docs.aws.amazon.com/vpc/latest/userguide/egress-only-internet-gateway.html Egress-only internet gateway (EIGW) } for the VPC
Enable DNS hostname support for the VPC.
Enable DNS support for the VPC.
Use this configuration to define gateway endpoints for your VPC. A gateway endpoint targets specific IP routes in an Amazon VPC route table, in the form of a prefix-list, used for traffic destined to Amazon DynamoDB or Amazon Simple Storage Service (Amazon S3).
2 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of endpoints to create.
Use this configuration to define interface endpoints for your VPC. Interface endpoints powered by AWS PrivateLink to connect your VPC to AWS services as if they were in your VPC, without the use of an internet gateway.
6 nested properties
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
An array of VPC interface endpoint services to be deployed.
An array of the friendly names of VPC subnets for the endpoints to be deployed.
(OPTIONAL) An array of source CIDRs allowed to communicate with the endpoints.
(OPTIONAL) Enable to define interface endpoints as centralized endpoints.
(OPTIONAL) An array of tag objects for the private hosted zones associated with the VPC Interface endpoints.
Defines if an {@link https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html internet gateway } should be added to the VPC
(OPTIONAL) An array of IPAM allocation configurations.
(OPTIONAL) An array of IPv6 CIDR block configurations.
Use this configuration to define Application Load Balancers (ALBs) or Network Load Balancers (NLBs) to be deployed in the specified VPC subnets.
2 nested properties
(OPTIONAL) An array of Application Load Balancer (ALB) configurations. Use this property to define ALBs to be deployed in the specified VPC subnets.
(OPTIONAL) An array of Network Load Balancer (NLB) configurations. Use this property to define NLBs to be deployed in the specified VPC subnets.
(OPTIONAL) An array of NAT gateway configurations for the VPC. Use this property to configure the NAT gateways for the VPC.
(OPTIONAL) A list of Network Access Control Lists (ACLs) to deploy for this VPC
(OPTIONAL) A list of DNS query log configuration names.
(OPTIONAL) A list of Route 53 resolver rule names.
(OPTIONAL) An array of route table configurations for the VPC. Use this property to configure the route tables for the VPC.
(OPTIONAL) A list of Security Groups to deploy for this VPC
(OPTIONAL) An array of subnet configurations for the VPC. Use this property to configure the subnets for the VPC.
(OPTIONAL) A list of tags to apply to this VPC
Target group configuration. Use this property to define target groups for this VPC.
(OPTIONAL) An array of Transit Gateway attachment configurations. Use this property to configure the Transit Gateway attachments for the VPC.
(OPTIONAL) When set to true, this VPC will be configured to utilize centralized endpoints. This includes having the Route 53 Private Hosted Zone associated with this VPC. Centralized endpoints are configured per region, and can span to spoke accounts
Used to define Virtual Private Gateways that are attached to a VPC. You can create an IPsec VPN connection between your VPC and your remote network. On the AWS side of the Site-to-Site VPN connection, a virtual private gateway or transit gateway provides two VPN endpoints (tunnels) for automatic failover.
1 nested properties
Define the ASN (Amazon Side) used for the Virtual Private Gateway
VPC Flow Logs Configuration Interface
Interface for AWS VPC Flow Logs configuration, which captures information about IP traffic flowing to and from network interfaces in your VPCs. Flow logs provide visibility into network traffic patterns, security analysis, and troubleshooting capabilities.
Key Features
- Traffic Visibility: Monitor all network traffic in your VPCs
- Security Analysis: Detect suspicious traffic patterns and potential threats
- Compliance: Meet regulatory requirements for network monitoring
- Troubleshooting: Diagnose connectivity and performance issues
- Cost Optimization: Analyze traffic patterns to optimize network costs
Supported Destinations
- Amazon S3: Cost-effective long-term storage and analysis
- CloudWatch Logs: Real-time monitoring and alerting capabilities
- Dual Destination: Send logs to both S3 and CloudWatch simultaneously
Learn more about VPC Flow Logs.
6 nested properties
Custom Fields (Required when defaultFormat is false)
Array of specific fields to include in flow log records when using custom format. This allows you to capture exactly the network information needed for your use cases.
Use Default Format (Required)
Controls whether to use the AWS default flow log format or a custom format with specific fields. When false, allows customization of logged fields.
Log Destinations (Required)
Array of destination services where VPC flow logs should be delivered. You can send logs to one or both supported destinations simultaneously.
Maximum Aggregation Interval (Required)
The maximum interval in seconds for aggregating flow log records before they are captured and delivered to the destination.
VPC Flow Logs Traffic Type
Defines which types of network traffic should be captured in VPC Flow Logs. This determines the scope of network visibility and the volume of log data generated.
Values
- ALL: Capture all network traffic (both accepted and rejected)
- ACCEPT: Capture only traffic that was allowed by security groups/NACLs
- REJECT: Capture only traffic that was blocked by security groups/NACLs
VPC Flow Logs Destination Configuration Interface
Configuration interface for VPC Flow Logs destination settings, supporting both S3 and CloudWatch Logs destinations. Allows fine-grained control over how flow logs are stored, retained, and processed.
Supported Destinations
- S3: Cost-effective long-term storage with lifecycle management
- CloudWatch Logs: Real-time monitoring with immediate alerting capabilities
- Dual Destination: Send to both S3 and CloudWatch simultaneously
Example
yaml destinationsConfig: s3: lifecycleRules: - enabled: true expiration: 2555 transitions: - storageClass: GLACIER transitionAfter: 365 cloudWatchLogs: retentionInDays: 365 kms: flow-logs-key
2 nested properties
VPC Flow Logs CloudWatch Logs Configuration Interface
Configuration interface for CloudWatch Logs destination settings when VPC Flow Logs are sent to Amazon CloudWatch Logs. Provides control over log retention and encryption for real-time monitoring capabilities.
Key Features
- Retention Management: Control how long logs are kept in CloudWatch
- Encryption: Secure logs with customer-managed KMS keys
- Real-time Analysis: Enable immediate log analysis and alerting
- Cost Control: Manage CloudWatch Logs storage costs through retention
VPC Flow Logs S3 Bucket Configuration Interface
Configuration interface for S3 destination settings when VPC Flow Logs are sent to Amazon S3. Provides control over lifecycle management and custom log path configurations for cost optimization and organization.
Key Features
- Lifecycle Management: Automatic transition and expiration of log files
- Custom Paths: Override default S3 log path structure
- Cost Optimization: Reduce storage costs through intelligent tiering
- Retention Control: Manage log retention periods automatically
Use this configuration to define the VPN connections that terminate either on a Transit Gateway or virtual private gateway. A VPN connection refers to the connection between your VPC and your own on-premises network. You can enable access to your remote network from your VPC by creating an AWS Site-to-Site VPN (Site-to-Site VPN) connection, and configuring routing to pass traffic through the connection.
IMPORTANT: After initial deployment of your VPN connection with any of the v1.5.0+ options noted below, you can make property changes in one of {@link VpnConnectionConfig } or {@link VpnTunnelOptionsSpecificationsConfig }, but not both. You may make multiple property changes in one of those configurations if necessary. Trying to modify properties in both configurations will result in a pipeline failure. This is due to the fact that only a single mutating API call can be made at a time for AWS Site-to-Site VPN connections.
Note: you may manually roll back the resulting CloudFormation stack should you encounter this failure. More details on how to skip failed resources in the following reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Enable Site-to-Site VPN Acceleration. For more information, see {@link https://docs.aws.amazon.com/vpn/latest/s2svpn/accelerated-vpn.html Accelerated Site-to-Site VPN connections } .
(OPTIONAL) An array of Transit Gateway route table names to associate the VPN attachment to
(OPTIONAL) An array of Transit Gateway route table names to propagate the VPN attachment to
(OPTIONAL) If creating a VPN connection for a device that doesn't support Border Gateway Protocol (BGP) declare true as a value, otherwise, use false.
(OPTIONAL) An array of tags for the VPN Connection.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Define the optional VPN Tunnel configuration
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define CloudWatch log groups for your Site-to-Site VPN connections. AWS Site-to-Site VPN logs provide you with deeper visibility into your Site-to-Site VPN deployments. With this feature, you have access to Site-to-Site VPN connection logs that provide details on IP Security (IPsec) tunnel establishment, Internet Key Exchange (IKE) negotiations, and dead peer detection (DPD) protocol messages.
(OPTIONAL) Enable site-to-site VPN tunnel logging to CloudWatch Logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Use this configuration to define optional tunnel configurations for a site-to-site VPN connection.
IMPORTANT: After initial deployment of your VPN connection with any of the v1.5.0+ options noted below, you can only make property changes to one VPN tunnel per core pipeline run. You may make multiple property changes in that one VPN tunnel if necessary. Trying to modify properties in both tunnels will result in a pipeline failure. This is due to the fact that only a single mutating API call can be made at a time for AWS Site-to-Site VPN connections.
Note: you may manually roll back the resulting CloudFormation stack should you encounter this failure. More details on how to skip failed resources in the following reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html
(OPTIONAL) The duration, in seconds, after which Dead Peer Detection (DPD) timeout occurs.
Default - 30
(OPTIONAL) The Internet Key Exchange (IKE) versions that are permitted on the tunnel.
Default - ikev1,ikev2
Use this configuration to define CloudWatch log groups for your Site-to-Site VPN connections. AWS Site-to-Site VPN logs provide you with deeper visibility into your Site-to-Site VPN deployments. With this feature, you have access to Site-to-Site VPN connection logs that provide details on IP Security (IPsec) tunnel establishment, Internet Key Exchange (IKE) negotiations, and dead peer detection (DPD) protocol messages.
3 nested properties
(OPTIONAL) Enable site-to-site VPN tunnel logging to CloudWatch Logs.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Internet Key Exchange (IKE) Phase 1 tunnel options configuration. Use this configuration to restrict the permitted Diffie-Hellman group numbers, encryption algorithms, and integrity algorithms for IKE Phase 1 negotiations. You may also modify the Phase 1 lifetime for the VPN tunnel.
4 nested properties
(OPTIONAL) An array of permitted Diffie-Hellman group numbers used in the IKE Phase 1 for initial authentication.
Default - [2, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]
(OPTIONAL) An array of encryption algorithms permitted for IKE Phase 1 negotiations.
Default - [AES128, AES256, AES128-GCM-16, AES256-GCM-16]
(OPTIONAL) An array of integrity algorithms permitted for IKE Phase 1 negotiations.
Default - [SHA1, SHA2-256, SHA2-384, SHA2-512]
(OPTIONAL) The IKE Phase 1 lifetime (in seconds) for the VPN tunnel.
Default: 28800 (8 hours)
Internet Key Exchange (IKE) Phase 2 tunnel options configuration. Use this configuration to restrict the permitted Diffie-Hellman group numbers, encryption algorithms, and integrity algorithms for IKE Phase 2 negotiations. You may also modify the Phase 2 lifetime for the VPN tunnel.
4 nested properties
(OPTIONAL) An array of permitted Diffie-Hellman group numbers used in the IKE Phase 2 negotiations.
Default - [2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]
(OPTIONAL) An array of encryption algorithms permitted for IKE Phase 2 negotiations.
Default - [AES128, AES256, AES128-GCM-16, AES256-GCM-16]
(OPTIONAL) An array of integrity algorithms permitted for IKE Phase 2 negotiations.
Default - [SHA1, SHA2-256, SHA2-384, SHA2-512]
(OPTIONAL) The IKE Phase 2 lifetime (in seconds) for the VPN tunnel.
Default: 3600 (1 hour)
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) The percentage of the rekey window (determined by the rekey margin time) within which the rekey time is randomly selected.
Default - 100
(OPTIONAL) The margin time in seconds before the phase 1 and phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
Default - 270 (4.5 minutes)
(OPTIONAL) The number of packets in an IKE replay window.
Default - 1024
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
(OPTIONAL) Enable tunnel endpoint lifecycle control. This feature provides control over the schedule of endpoint replacements. For more information, see {@link https://docs.aws.amazon.com/vpn/latest/s2svpn/tunnel-endpoint-lifecycle.html Tunnel Endpoint Lifecycle Control } .
Log Destination Type
Defines the supported destinations for storing and processing log data from various AWS services like VPC Flow Logs, CloudTrail, and other logging services.
Values
- s3: Amazon S3 for cost-effective long-term storage and batch analysis
- cloud-watch-logs: CloudWatch Logs for real-time monitoring and alerting
Non-Empty String Type
Represents a string that must contain at least one character. Used for required text fields throughout the Landing Zone Accelerator configuration where empty values are not permitted.
S3 Storage Class Type
Defines the available Amazon S3 storage classes for lifecycle transitions. Each storage class is optimized for different access patterns, durability requirements, and cost considerations.
VPC Flow Logs Traffic Type
Defines which types of network traffic should be captured in VPC Flow Logs. This determines the scope of network visibility and the volume of log data generated.
Values
- ALL: Capture all network traffic (both accepted and rejected)
- ACCEPT: Capture only traffic that was allowed by security groups/NACLs
- REJECT: Capture only traffic that was blocked by security groups/NACLs