Skip to main content

AWS Networking

Properties

NameTypeDescriptionRequired
vpc
(VPC Configuration)
objectyes
load_balancer
(Load Balancer Configuration)
objectAt least one public or private load balancer is required
yes

Additional Properties: not allowed
Example

{
"vpc": {
"id": "vpc-1a2b3c4d",
"subnets": [
"subnet-1234abcd"
],
"security_groups": [
"sg-0a1b2c3d"
]
},
"load_balancer": {
"public": {
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-public-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-public-alb/4e0ec46f67bd1383/0987654321fedcba"
},
"private": {
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-private-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-private-alb/4e0ec46f67bd1383/0987654321fedcba"
}
}
}

vpc: VPC Configuration

Properties

NameTypeDescriptionRequired
id
(VPC ID)
stringThe identifier of the AWS Virtual Private Cloud (VPC)
Pattern: ^vpc-([0-9a-f]{8}|[0-9a-f]{17})$
yes
subnets
(Subnet IDs)
string[]List of AWS Subnet IDs associated with your VPC
yes
security_groups
(Security Group IDs)
string[]List of AWS Security Group IDs
yes

Example

{
"id": "vpc-1a2b3c4d",
"subnets": [
"subnet-1234abcd"
],
"security_groups": [
"sg-0a1b2c3d"
]
}

vpc.subnets[]: Subnet IDs

List of AWS Subnet IDs associated with your VPC

Items

Item Type: string
Item Pattern: ^subnet-([0-9a-f]{8}\|[0-9a-f]{17})$
Minimum Items: 1
Example

[
"subnet-1234abcd"
]

vpc.security_groups[]: Security Group IDs

List of AWS Security Group IDs

Items

Item Type: string
Item Pattern: ^sg-([0-9a-f]{8}\|[0-9a-f]{17})$
Minimum Items: 1
Example

[
"sg-0a1b2c3d"
]

load_balancer: Load Balancer Configuration

At least one public or private load balancer is required

Properties

NameTypeDescriptionRequired
public
(Public Load Balancer)
object
private
(Private Load Balancer)
object

Example

{
"public": {
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-public-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-public-alb/4e0ec46f67bd1383/0987654321fedcba"
},
"private": {
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-private-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-private-alb/4e0ec46f67bd1383/0987654321fedcba"
}
}

load_balancer.public: Public Load Balancer

Properties

NameTypeDescriptionRequired
arn
(Public ALB ARN)
stringARN of the public Application Load Balancer
Pattern: ^arn:aws:elasticloadbalancing:[a-z0-9-]+:[0-9]{12}:loadbalancer/app/[a-zA-Z0-9-]+/[a-f0-9]{16}$
listener_arn
(Public Listener ARN)
stringARN of the public ALB listener
Pattern: ^arn:aws:elasticloadbalancing:[a-z0-9-]+:[0-9]{12}:listener/app/[a-zA-Z0-9-]+/[a-f0-9]{16}/[a-f0-9]{16}$

Example

{
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-public-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-public-alb/4e0ec46f67bd1383/0987654321fedcba"
}

load_balancer.private: Private Load Balancer

Properties

NameTypeDescriptionRequired
arn
(Private ALB ARN)
stringARN of the private Application Load Balancer
Pattern: ^arn:aws:elasticloadbalancing:[a-z0-9-]+:[0-9]{12}:loadbalancer/app/[a-zA-Z0-9-]+/[a-f0-9]{16}$
listener_arn
(Private Listener ARN)
stringARN of the private ALB listener
Pattern: ^arn:aws:elasticloadbalancing:[a-z0-9-]+:[0-9]{12}:listener/app/[a-zA-Z0-9-]+/[a-f0-9]{16}/[a-f0-9]{16}$

Example

{
"arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-private-alb/4e0ec46f67bd1383",
"listener_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/my-private-alb/4e0ec46f67bd1383/0987654321fedcba"
}