AwsSimpleSubnetModuleSchema

AwsSimpleSubnetModuleSchema is the input schema for the AwsSimpleSubnetModule module. This schema defines the configuration for AWS subnets including networking settings, availability zone placement, sibling relationships, nat gateway, and filesystem mounting.

@group

Modules/Subnet/AwsSimpleSubnet

@see

AwsSimpleSubnetModule to learn more about the AwsSimpleSubnetModule module.

Index

Properties

• localFilesystems
• region
• subnetAvailabilityZone
• subnetCidrBlock
• subnetName
• subnetOptions
• subnetSiblings

Properties

optionallocalFilesystems

localFilesystems?: Filesystem[] = ...

Optional array of EFS filesystems to mount in this subnet. These filesystems provide shared persistent storage accessible from containers running in the subnet.

region

region: Region = ...

The AWS region where this subnet will be created. The region must have AWS region anchors configured.

subnetAvailabilityZone

subnetAvailabilityZone: string = ...

The availability zone where the subnet will be created. Must be a valid availability zone within the specified region.

subnetCidrBlock

subnetCidrBlock: string = ...

The CIDR block for the subnet. This defines the IP address range for the subnet and must be within the VPC CIDR block.

subnetName

subnetName: string = ...

The name of the subnet. This is used to identify the subnet within the region.

optionalsubnetOptions

subnetOptions?: { createNatGateway: boolean; disableSubnetIntraNetwork: boolean; subnetType: SubnetType } = ...

Optional subnet configuration options. These options control subnet behavior including NAT gateway creation and network isolation.

• subnetOptions.createNatGateway - Whether to create a NAT gateway in the subnet.
• subnetOptions.disableSubnetIntraNetwork - Whether to disable intra-network traffic within the subnet. With intra-network traffic disabled, traffic within the subnet will not be able to communicate with each other. They must go out of the subnet to communicate with each other. This can be useful in a private subnet where access between containers should be managed via a load balancer.
• subnetOptions.subnetType - The type of subnet to create. See SubnetType for options.

---

Type declaration

• createNatGateway: boolean

• disableSubnetIntraNetwork: boolean

• subnetType: SubnetType

optionalsubnetSiblings

subnetSiblings?: { attachToNatGateway: boolean; subnet: Subnet }[] = ...

Optional array of sibling subnets to establish network relationships with. Sibling subnets allow NAcl rules to allow traffic between the two subnets.