Deployment configuration
View configuration parameters
To view the current configuration:
Visit the AWS CloudFormation Console.
Ensure that you are in the correct region.
Navigate to Stacks.
Click on the Data Pipes stack (if you followed the docs, the name is
datapipes).Click on the Parameters tab.
Now, you can see the configuration parameters.
Change deployment configuration parameters
To change the configuration parameters of Data Pipes:
Visit the AWS CloudFormation Console.
Ensure that you are in the correct region.
Navigate to Stacks.
Click on the Data Pipes stack (if you followed the docs, the name is
datapipes).At the top right, click on Update.
In the next step, just click Next.
Now, you can change the configuration parameters.
Click Next.
In the next step, just click Next.
At the bottom, check “I acknowledge that AWS CloudFormation might create IAM resources.”, check “I acknowledge that AWS CloudFormation might require the following capability: CAPABILITY_AUTO_EXPAND” and click Submit.
It can take several minutes for an update to finish!
List of all deployments configuration parameters
Parameter | Description | Default value | Allowed values |
|---|---|---|---|
Required Parameters | |||
CompanyName | Your company name. Use to differentiate specific resources within datapipes application. |
| Must be a valid email address. |
EnvironmentName | Name of the Data Pipes environment (e.g: dev, test, prod, etc.). Used to differentiate instance if multiple Data Pipes application are deployed in the same account. | dev | Must contain only up to 5 characters in lower case |
RemoteAccessCIDR | Trusted IPv4 CIDR block or VPC prefix list that is permitted remote access to your instances if desired in addition to AWS Systems Manager (SSM) access. |
| Must be an IPv4 CIDR block (x.x.x.x/x) |
AvailabilityZones | List of Availability Zones to use for the subnets in the VPC. Availability Zones are used for this deployment. |
| Select at least two values from the list |
EmailAddress | /!\ Email address is used to send the default ADMIN user password for the first connection and Data Pipes initial set-up. |
|
|
VPC network configuration | |||
NumberOfAZs | Number of Availability Zones to use in the VPC. | 2 (recommended value) | This must match the value entered for the AvailabilityZones parameter. |
VPCCIDR | CIDR block Data Pipes VPC creation. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet1CIDRCore | CIDR block for private subnet 1, located in Availability Zone 1. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet2CIDRCore | CIDR block for private subnet 2, located in Availability Zone 2. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet3CIDRCore | CIDR block for private subnet 3, located in Availability Zone 3. Required if NumberOfAZs is set to 3. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet1CIDRDatabase | CIDR block for private database subnet 1, located in Availability Zone 1. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet2CIDRDatabase | CIDR block for private database subnet 2, located in Availability Zone 2. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet1CIDRElasticache | CIDR block for the private subnet elasticache 1, located in Availability Zone 1. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PrivateSubnet2CIDRElasticache | CIDR block for the private subnet elasticache 2, located in Availability Zone 2. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PublicSubnet1CIDR | CIDR block for the public (DMZ) subnet 1, located in Availability Zone 1. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PublicSubnet2CIDR | CIDR block for the public (DMZ) subnet 2, located in Availability Zone 2. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
PublicSubnet3CIDR | CIDR block for the public (DMZ) subnet 3, located in Availability Zone 3. Required if NumberOfAZs is set to 3. |
| CIDR block parameter must be in the form x.x.x.x/16-28 |
Amazon EKS cluster configuration | |||
EKSCoreNodeInstanceType | EC2 instance type. |
|
|
EKSCoreNumberOfNodes | Number of Amazon EKS node instances. Standard deployment include 3 nodes accross 2 AZs. | 3 |
|
EKSCoreMaxNumberOfNodes | Maximum number of Amazon EKS node instances. | 4 | Minimum 3 No maximum |
EKSCoreNodeGroupOS | Operating system to use for node instances. Choose "Bottlerocket" for the Amazon purpose-built container OS (unmanaged node groups only). |
|
|