Fortinet Document Library

Version:


Table of Contents

AWS Cookbook

Resources

Upgrade Path Tool

AWS Cookbook

6.4.0
Download PDF
Copy Link

CFT parameters

In Step 2 Specify stack details, you enter the stack name and CFT parameters.

CFT parameters

The following sections provide descriptions of the available parameters. After entering all required parameters, click Next.

Resource tagging configuration

Parameter label (name)

Default

Description

Resource tag prefix (ResourceTagPrefix)

Requires input

The ResourceGroup Tag Key used on all resources and as the name prefix of all applicable resources. Can only contain uppercase letters, lowercase letters, and numbers, ampersat(@), hyphens (-), period (.), and hash (#).

Maximum length is 50.

Resource name prefix (CustomIdentifier)

fgtASG

An alternative name prefix to be used on a resource that the Resource tag prefix cannot apply to. Can only contain uppercase letters, lowercase letters, and numbers.

Maximum length is 10.

Network configuration

Parameter label (name)

Default

Description

Availability Zones (AvailabilityZones)

Requires input

The list of AZs to use for the subnets in the VPC. The FortiGate Autoscale solution uses two AZs from your list and preserves the logical order you specify.

VPC CIDR (VpcCidr)

192.168.0.0/16

The CIDR block for the FortiGate Autoscale VPC.

Autoscale subnet 1 CIDR (PublicSubnet1Cidr)

192.168.0.0/24

The CIDR block for the subnet located in AZ 1 where the FortiGate Autoscale instances will be deployed to.

Autoscale subnet 2 CIDR (PublicSubnet2Cidr)

192.168.1.0/24

The CIDR block for the subnet located in AZ 2 where the FortiGate Autoscale instances will be deployed to.

FortiGate-VM configuration

Parameter label (name)

Default

Description

Instance type (FortiGateInstanceType)

c5.large

Instance type to launch for the FortiGate-VMs in the Auto Scaling group. There are t2.small and compute-optimized instances such as c4 and c5 available with different vCPU sizes and bandwidths. For more information about instance types, see Instance Types.

FortiOS version (FortiOSVersion)

6.2.1

FortiOS version supported by FortiGate Autoscale for AWS.

FortiGate PSK secret (FortiGatePskSecret)

Requires input

A secret key for the FortiGate-VM instances to securely communicate with each other. Must contain numbers and letters and may contain special characters.

Maximum length is 128.

Note

Changes to the PSK secret after FortiGate Autoscale for AWS has been deployed are not reflected here. For new instances to be spawned with the changed PSK secret, this environment variable will need to be manually updated.

Admin port (FortiGateAdminPort)

8443

A port number for FortiGate-VM administration.

Do not use the FortiGate reserved ports 443, 541, 514, or 703.

Minimum is 1. Maximum is 65535.

Admin CIDR block (FortiGateAdminCidr)

Requires input

CIDR block for external admin management access.

Warning

0.0.0.0/0 accepts connections from any IP address. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses.

Key pair name (KeyPairName)

Requires input

Amazon EC2 Key Pair for admin access.

BGP ASN (BgpAsn)

65000

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the Customer Gateway of each FortiGate-VM instance in the Auto Scaling group. This value ranges from 64512 to 65534.

FortiGate-VM Auto Scaling group configuration

Parameter label (name)

Default

Description

Instance lifecycle timeout (LifecycleHookTimeout)

480

The amount of time (in seconds) that can elapse before the FortiGate Autoscale lifecycle hook times out.

Minimum is 60. Maximum is 3600.

Desired capacity (FgtAsgDesiredCapacity)

2

The number of FortiGate-VM instances the Auto Scaling group should have at any time. For High Availability, ensure at least 2 FortiGate-VMs are in the group.

Minimum is 2.

Minimum group size (FgtAsgMinSize)

2

The number of FortiGate-VM instances the Auto Scaling group should have at any time.

Minimum is 2.

Maximum group size (FgtAsgMaxSize)

4

Maximum number of FortiGate-VM instances in the Auto Scaling group.

Minimum is 2.

Health check grace period (FgtAsgHealthCheckGracePeriod)

300

The length of time (in seconds) that Auto Scaling waits before checking an instance's health status.

Minimum is 60.

Scaling cool down period (FgtCooldown)

300

The Auto Scaling group waits for the cool down period (in seconds) to complete before resuming scaling activities.

Minimum is 60. Maximum is 3600.

Scale-out threshold (FgtAsgScaleOutThreshold)

80

The threshold (in percentage) for the FortiGate-VM Auto Scaling group to scale out (add) 1 instance.

Minimum is 1. Maximum is 100.

Scale-in threshold (FgtAsgScaleInThreshold)

25

The threshold (in percentage) for the FortiGate-VM Auto Scaling group to scale in (remove) 1 instance.

Minimum is 1. Maximum is 100.

Transit Gateway configuration

Parameter label (name)

Default

Description

Transit Gateway support (TransitGatewaySupportOptions)

Create one

Create a Transit Gateway for the FortiGate Autoscale VPC to attach to, or specify to use an existing one.

Transit Gateway ID (TransitGatewayId)

Conditionally requires input

Required when Transit Gateway support is set to "use an existing one". It is the ID of the Transit Gateway that the FortiGate Autoscale VPC will be attached to.

Failover configuration

Parameter label (name)

Default

Description

Heart beat loss count (HeartBeatLossCount)

3

Number of consecutively lost heartbeats. When the Heartbeat loss count has been reached, the FortiGate-VM is deemed unhealthy and failover activities will commence.

Heart beat interval (HeartBeatInterval)

30

The length of time (in seconds) that a FortiGate-VM waits between sending heartbeat requests to the Autoscale handler.

Minimum is 30. Maximum is 90.

Deployment resources configuration

Parameter label (name)

Default

Description

S3 bucket name (S3BucketName)

Requires input

Name of the S3 bucket (created in step 4 of Obtaining the deployment package) that contains the FortiGate Autoscale deployment package. Can only contain numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

S3 resource folder (S3KeyPrefix)

Requires input

Name of the S3 folder (created in step 5 of Obtaining the deployment package) that stores the FortiGate Autoscale deployment resources. Can only contain numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). If provided, it must end with a forward slash (/).

Resources

CFT parameters

In Step 2 Specify stack details, you enter the stack name and CFT parameters.

CFT parameters

The following sections provide descriptions of the available parameters. After entering all required parameters, click Next.

Resource tagging configuration

Parameter label (name)

Default

Description

Resource tag prefix (ResourceTagPrefix)

Requires input

The ResourceGroup Tag Key used on all resources and as the name prefix of all applicable resources. Can only contain uppercase letters, lowercase letters, and numbers, ampersat(@), hyphens (-), period (.), and hash (#).

Maximum length is 50.

Resource name prefix (CustomIdentifier)

fgtASG

An alternative name prefix to be used on a resource that the Resource tag prefix cannot apply to. Can only contain uppercase letters, lowercase letters, and numbers.

Maximum length is 10.

Network configuration

Parameter label (name)

Default

Description

Availability Zones (AvailabilityZones)

Requires input

The list of AZs to use for the subnets in the VPC. The FortiGate Autoscale solution uses two AZs from your list and preserves the logical order you specify.

VPC CIDR (VpcCidr)

192.168.0.0/16

The CIDR block for the FortiGate Autoscale VPC.

Autoscale subnet 1 CIDR (PublicSubnet1Cidr)

192.168.0.0/24

The CIDR block for the subnet located in AZ 1 where the FortiGate Autoscale instances will be deployed to.

Autoscale subnet 2 CIDR (PublicSubnet2Cidr)

192.168.1.0/24

The CIDR block for the subnet located in AZ 2 where the FortiGate Autoscale instances will be deployed to.

FortiGate-VM configuration

Parameter label (name)

Default

Description

Instance type (FortiGateInstanceType)

c5.large

Instance type to launch for the FortiGate-VMs in the Auto Scaling group. There are t2.small and compute-optimized instances such as c4 and c5 available with different vCPU sizes and bandwidths. For more information about instance types, see Instance Types.

FortiOS version (FortiOSVersion)

6.2.1

FortiOS version supported by FortiGate Autoscale for AWS.

FortiGate PSK secret (FortiGatePskSecret)

Requires input

A secret key for the FortiGate-VM instances to securely communicate with each other. Must contain numbers and letters and may contain special characters.

Maximum length is 128.

Note

Changes to the PSK secret after FortiGate Autoscale for AWS has been deployed are not reflected here. For new instances to be spawned with the changed PSK secret, this environment variable will need to be manually updated.

Admin port (FortiGateAdminPort)

8443

A port number for FortiGate-VM administration.

Do not use the FortiGate reserved ports 443, 541, 514, or 703.

Minimum is 1. Maximum is 65535.

Admin CIDR block (FortiGateAdminCidr)

Requires input

CIDR block for external admin management access.

Warning

0.0.0.0/0 accepts connections from any IP address. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses.

Key pair name (KeyPairName)

Requires input

Amazon EC2 Key Pair for admin access.

BGP ASN (BgpAsn)

65000

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the Customer Gateway of each FortiGate-VM instance in the Auto Scaling group. This value ranges from 64512 to 65534.

FortiGate-VM Auto Scaling group configuration

Parameter label (name)

Default

Description

Instance lifecycle timeout (LifecycleHookTimeout)

480

The amount of time (in seconds) that can elapse before the FortiGate Autoscale lifecycle hook times out.

Minimum is 60. Maximum is 3600.

Desired capacity (FgtAsgDesiredCapacity)

2

The number of FortiGate-VM instances the Auto Scaling group should have at any time. For High Availability, ensure at least 2 FortiGate-VMs are in the group.

Minimum is 2.

Minimum group size (FgtAsgMinSize)

2

The number of FortiGate-VM instances the Auto Scaling group should have at any time.

Minimum is 2.

Maximum group size (FgtAsgMaxSize)

4

Maximum number of FortiGate-VM instances in the Auto Scaling group.

Minimum is 2.

Health check grace period (FgtAsgHealthCheckGracePeriod)

300

The length of time (in seconds) that Auto Scaling waits before checking an instance's health status.

Minimum is 60.

Scaling cool down period (FgtCooldown)

300

The Auto Scaling group waits for the cool down period (in seconds) to complete before resuming scaling activities.

Minimum is 60. Maximum is 3600.

Scale-out threshold (FgtAsgScaleOutThreshold)

80

The threshold (in percentage) for the FortiGate-VM Auto Scaling group to scale out (add) 1 instance.

Minimum is 1. Maximum is 100.

Scale-in threshold (FgtAsgScaleInThreshold)

25

The threshold (in percentage) for the FortiGate-VM Auto Scaling group to scale in (remove) 1 instance.

Minimum is 1. Maximum is 100.

Transit Gateway configuration

Parameter label (name)

Default

Description

Transit Gateway support (TransitGatewaySupportOptions)

Create one

Create a Transit Gateway for the FortiGate Autoscale VPC to attach to, or specify to use an existing one.

Transit Gateway ID (TransitGatewayId)

Conditionally requires input

Required when Transit Gateway support is set to "use an existing one". It is the ID of the Transit Gateway that the FortiGate Autoscale VPC will be attached to.

Failover configuration

Parameter label (name)

Default

Description

Heart beat loss count (HeartBeatLossCount)

3

Number of consecutively lost heartbeats. When the Heartbeat loss count has been reached, the FortiGate-VM is deemed unhealthy and failover activities will commence.

Heart beat interval (HeartBeatInterval)

30

The length of time (in seconds) that a FortiGate-VM waits between sending heartbeat requests to the Autoscale handler.

Minimum is 30. Maximum is 90.

Deployment resources configuration

Parameter label (name)

Default

Description

S3 bucket name (S3BucketName)

Requires input

Name of the S3 bucket (created in step 4 of Obtaining the deployment package) that contains the FortiGate Autoscale deployment package. Can only contain numbers, lowercase letters, uppercase letters, and hyphens (-). It cannot start or end with a hyphen (-).

S3 resource folder (S3KeyPrefix)

Requires input

Name of the S3 folder (created in step 5 of Obtaining the deployment package) that stores the FortiGate Autoscale deployment resources. Can only contain numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). If provided, it must end with a forward slash (/).