Parameters declaration
- Last Updated: April 14, 2026
- 7 minute read
- MarkLogic Server
- Version 12.0
- Documentation
The Parameters portion of the template defines the parameters necessary to build your MarkLogic cluster. The three zones define the hosted zones on which the servers in cluster are to be created. All of the zones should be in the same region, as described in Regions and Zones.
For a description of each parameter, see the table at the end of Step 5 in Creating a CloudFormation Stack Using the AWS Console.
The parameters used to configure the resources are shown below.
Parameters:
# resource configuration
IAMRole:
Description: IAM Role
Type: String
VolumeSize:
Description: The EBS Data volume size (GB) for all nodes
Type: Number
MinValue: '10'
MaxValue: '1000'
Default: '10'
VolumeType:
Description: The EBS Data volume Type
Type: String
AllowedValues:
- standard
- gp2
- gp3
Default: gp2
VolumeIOPS:
Description: The number of I/O operations per second for a gp3 volume. This parameter is only applicable for a gp3 volume
Type: Number
MinValue: '3000'
MaxValue: '16000'
Default: '3000'
VolumeThroughput:
Description: The throughput to provision for a gp3 volume. This parameter is only applicable for a gp3 volume
Type: Number
MinValue: '125'
MaxValue: '1000'
Default: '125'
VolumeEncryption:
Description: Whether to enable volume encryption
Type: String
AllowedValues:
- enable
- disable
Default: enable
VolumeEncryptionKey:
Description: The key ID of AWS KMS key to encrypt volumes - Optional
Type: String
Default: ""
InstanceType:
Description: Type of EC2 instance to launch
Type: String
Default: r5.4xlarge
AllowedValues:
- ---- Pay As You Go and Bring-Your-Own-License ----
- c3.xlarge
- c3.2xlarge
- c3.4xlarge
- c3.8xlarge
- c4.xlarge
- c4.2xlarge
- c4.4xlarge
- c4.8xlarge
- c5.xlarge
- c5.2xlarge
- c5.4xlarge
- c5.9xlarge
- c5.12xlarge
- c5.18xlarge
- c5.24xlarge
- c5a.xlarge
- c5a.2xlarge
- c5a.4xlarge
- c5a.8xlarge
- c5a.12xlarge
- c5a.16xlarge
- c5a.24xlarge
- c5ad.xlarge
- c5ad.2xlarge
- c5ad.4xlarge
- c5ad.8xlarge
- c5ad.12xlarge
- c5ad.16xlarge
- c5ad.24xlarge
- c5d.xlarge
- c5d.2xlarge
- c5d.4xlarge
- c5d.9xlarge
- c5d.12xlarge
- c5d.18xlarge
- c5d.24xlarge
- c5n.xlarge
- c5n.2xlarge
- c5n.4xlarge
- c5n.9xlarge
- c5n.18xlarge
- c6a.xlarge
- c6a.2xlarge
- c6a.4xlarge
- c6a.8xlarge
- c6a.12xlarge
- c6a.16xlarge
- c6a.24xlarge
- c6a.32xlarge
- c6a.48xlarge
- c6i.xlarge
- c6i.2xlarge
- c6i.4xlarge
- c6i.8xlarge
- c6i.12xlarge
- c6i.16xlarge
- c6i.24xlarge
- c6i.32xlarge
- c6id.xlarge
- c6id.2xlarge
- c6id.4xlarge
- c6id.8xlarge
- c6id.12xlarge
- c6id.16xlarge
- c6id.24xlarge
- c6id.32xlarge
- c7i.xlarge
- c7i.2xlarge
- c7i.4xlarge
- c7i.8xlarge
- c7i.12xlarge
- c7i.16xlarge
- c7i.24xlarge
- c7i.48xlarge
- c7i-flex.xlarge
- c7i-flex.2xlarge
- c7i-flex.4xlarge
- c7i-flex.8xlarge
- c7i-flex.12xlarge
- c7i-flex.16xlarge
- c7a.xlarge
- c7a.2xlarge
- c7a.4xlarge
- c7a.8xlarge
- c7a.12xlarge
- c7a.16xlarge
- c7a.24xlarge
- c7a.32xlarge
- c7a.48xlarge
- cc2.8xlarge
- i2.2xlarge
- i2.4xlarge
- i2.8xlarge
- i2.xlarge
- i3.xlarge
- i3.2xlarge
- i3.4xlarge
- i3.8xlarge
- i3.16xlarge
- i3en.xlarge
- i3en.2xlarge
- i3en.3xlarge
- i3en.6xlarge
- i3en.12xlarge
- i3en.24xlarge
- i4i.xlarge
- i4i.2xlarge
- i4i.4xlarge
- i4i.8xlarge
- i4i.16xlarge
- i4i.32xlarge
- i7ie.xlarge
- i7ie.2xlarge
- i7ie.3xlarge
- i7ie.6xlarge
- i7ie.12xlarge
- i7ie.18xlarge
- i7ie.24xlarge
- i7ie.48xlarge
- m3.xlarge
- m3.2xlarge
- m4.xlarge
- m4.2xlarge
- m4.4xlarge
- m4.10xlarge
- m4.16xlarge
- m5.xlarge
- m5.2xlarge
- m5.4xlarge
- m5.8xlarge
- m5.12xlarge
- m5.16xlarge
- m5.24xlarge
- m5a.xlarge
- m5a.2xlarge
- m5a.4xlarge
- m5a.8xlarge
- m5a.12xlarge
- m5a.16xlarge
- m5a.24xlarge
- m5d.xlarge
- m5d.2xlarge
- m5d.4xlarge
- m5d.8xlarge
- m5d.16xlarge
- m5d.12xlarge
- m5d.24xlarge
- m5ad.xlarge
- m5ad.2xlarge
- m5ad.4xlarge
- m5ad.8xlarge
- m5ad.12xlarge
- m5ad.16xlarge
- m5ad.24xlarge
- m5zn.xlarge
- m5zn.2xlarge
- m5zn.3xlarge
- m5zn.6xlarge
- m5zn.12xlarge
- m5n.xlarge
- m5n.2xlarge
- m5n.4xlarge
- m5n.8xlarge
- m5n.12xlarge
- m5n.16xlarge
- m5n.24xlarge
- m5dn.xlarge
- m5dn.2xlarge
- m5dn.4xlarge
- m5dn.8xlarge
- m5dn.12xlarge
- m5dn.16xlarge
- m5dn.24xlarge
- m6a.xlarge
- m6a.2xlarge
- m6a.4xlarge
- m6a.8xlarge
- m6a.12xlarge
- m6a.16xlarge
- m6a.24xlarge
- m6a.32xlarge
- m6a.48xlarge
- m6i.xlarge
- m6i.2xlarge
- m6i.4xlarge
- m6i.8xlarge
- m6i.12xlarge
- m6i.16xlarge
- m6i.24xlarge
- m6i.32xlarge
- m6id.xlarge
- m6id.2xlarge
- m6id.4xlarge
- m6id.8xlarge
- m6id.12xlarge
- m6id.16xlarge
- m6id.24xlarge
- m6id.32xlarge
- m7i.xlarge
- m7i.2xlarge
- m7i.4xlarge
- m7i.8xlarge
- m7i.12xlarge
- m7i.16xlarge
- m7i.24xlarge
- m7i.48xlarge
- m7i-flex.xlarge
- m7i-flex.2xlarge
- m7i-flex.4xlarge
- m7i-flex.8xlarge
- m7i-flex.12xlarge
- m7i-flex.16xlarge
- m7a.xlarge
- m7a.2xlarge
- m7a.4xlarge
- m7a.8xlarge
- m7a.12xlarge
- m7a.16xlarge
- m7a.24xlarge
- m7a.32xlarge
- m7a.48xlarge
- p2.xlarge
- p2.8xlarge
- p2.16xlarge
- p3.2xlarge
- p3.8xlarge
- p3.16xlarge
- p3dn.24xlarge
- p4d.24xlarge
- r3.xlarge
- r3.2xlarge
- r3.4xlarge
- r3.8xlarge
- r4.xlarge
- r4.2xlarge
- r4.4xlarge
- r4.8xlarge
- r4.16xlarge
- r5.xlarge
- r5.2xlarge
- r5.4xlarge
- r5.8xlarge
- r5.12xlarge
- r5.16xlarge
- r5.24xlarge
- r5a.xlarge
- r5a.2xlarge
- r5a.4xlarge
- r5a.8xlarge
- r5a.12xlarge
- r5a.16xlarge
- r5a.24xlarge
- r5ad.xlarge
- r5ad.2xlarge
- r5ad.4xlarge
- r5ad.8xlarge
- r5ad.12xlarge
- r5ad.16xlarge
- r5ad.24xlarge
- r5b.xlarge
- r5b.2xlarge
- r5b.4xlarge
- r5b.8xlarge
- r5b.12xlarge
- r5b.16xlarge
- r5b.24xlarge
- r5d.xlarge
- r5d.2xlarge
- r5d.4xlarge
- r5d.8xlarge
- r5d.12xlarge
- r5d.16xlarge
- r5d.24xlarge
- r5dn.xlarge
- r5dn.2xlarge
- r5dn.4xlarge
- r5dn.8xlarge
- r5dn.12xlarge
- r5dn.16xlarge
- r5dn.24xlarge
- r5n.xlarge
- r5n.2xlarge
- r5n.4xlarge
- r5n.8xlarge
- r5n.12xlarge
- r5n.16xlarge
- r5n.24xlarge
- r6a.xlarge
- r6a.2xlarge
- r6a.4xlarge
- r6a.8xlarge
- r6a.12xlarge
- r6a.16xlarge
- r6a.24xlarge
- r6a.32xlarge
- r6a.48xlarge
- r6i.xlarge
- r6i.2xlarge
- r6i.4xlarge
- r6i.8xlarge
- r6i.12xlarge
- r6i.16xlarge
- r6i.24xlarge
- r6i.32xlarge
- r6id.xlarge
- r6id.2xlarge
- r6id.4xlarge
- r6id.8xlarge
- r6id.12xlarge
- r6id.16xlarge
- r6id.24xlarge
- r6id.32xlarge
- r7i.xlarge
- r7i.2xlarge
- r7i.4xlarge
- r7i.8xlarge
- r7i.12xlarge
- r7i.16xlarge
- r7i.24xlarge
- r7i.48xlarge
- r7iz.xlarge
- r7iz.2xlarge
- r7iz.4xlarge
- r7iz.8xlarge
- r7iz.12xlarge
- r7iz.16xlarge
- r7iz.32xlarge
- r7a.xlarge
- r7a.2xlarge
- r7a.4xlarge
- r7a.8xlarge
- r7a.12xlarge
- r7a.16xlarge
- r7a.24xlarge
- r7a.32xlarge
- r7a.48xlarge
- x1.16xlarge
- x1.32xlarge
- x1e.xlarge
- x1e.2xlarge
- x1e.4xlarge
- x1e.8xlarge
- x1e.16xlarge
- x1e.32xlarge
- x2idn.16xlarge
- x2idn.24xlarge
- x2idn.32xlarge
- x2iedn.xlarge
- x2iedn.2xlarge
- x2iedn.4xlarge
- x2iedn.8xlarge
- x2iedn.16xlarge
- x2iedn.24xlarge
- x2iedn.32xlarge
- x2iezn.2xlarge
- x2iezn.4xlarge
- x2iezn.6xlarge
- x2iezn.8xlarge
- x2iezn.12xlarge
- d2.xlarge
- d2.2xlarge
- d2.4xlarge
- d2.8xlarge
- d3.xlarge
- d3.2xlarge
- d3.4xlarge
- d3.8xlarge
- d3en.xlarge
- d3en.2xlarge
- d3en.4xlarge
- d3en.6xlarge
- d3en.8xlarge
- d3en.12xlarge
- dl1.24xlarge
- f1.2xlarge
- f1.4xlarge
- f1.16xlarge
- g2.2xlarge
- g2.8xlarge
- g3.4xlarge
- g3.8xlarge
- g3.16xlarge
- g3s.xlarge
- g4ad.xlarge
- g4ad.2xlarge
- g4ad.4xlarge
- g4ad.8xlarge
- g4ad.16xlarge
- g4dn.xlarge
- g4dn.2xlarge
- g4dn.4xlarge
- g4dn.8xlarge
- g4dn.12xlarge
- g4dn.16xlarge
- g5.xlarge
- g5.2xlarge
- g5.4xlarge
- g5.8xlarge
- g5.12xlarge
- g5.16xlarge
- g5.24xlarge
- g5.48xlarge
- h1.2xlarge
- h1.4xlarge
- h1.8xlarge
- h1.16xlarge
- inf1.xlarge
- inf1.2xlarge
- inf1.6xlarge
- inf1.24xlarge
- trn1.2xlarge
- trn1.32xlarge
- u-3tb1.56xlarge
- u-6tb1.56xlarge
- u-6tb1.112xlarge
- u-9tb1.112xlarge
- u-12tb1.112xlarge
- u-18tb1.112xlarge
- vt1.3xlarge
- vt1.6xlarge
- vt1.24xlarge
- z1d.xlarge
- z1d.2xlarge
- z1d.3xlarge
- z1d.6xlarge
- z1d.12xlarge
- -------------- Bring-Your-Own-License Only --------------
- c3.large
- c4.large
- c5.metal
- c5.large
- c5a.large
- c5ad.large
- c5d.metal
- c5d.large
- c5n.large
- c5n.metal
- c6a.large
- c6a.metal
- c6i.large
- c6i.metal
- c6id.large
- c6id.metal
- c7i.large
- c7i.metal-24xl
- c7i.metal-48xl
- c7i-flex.large
- c7a.medium
- c7a.large
- c7a.metal-48xl
- g4dn.metal
- i3.large
- i3en.large
- i3en.metal
- i4i.large
- i4i.metal
- i7ie.large
- i7ie.metal-24xl
- i7ie.metal-48xl
- m3.large
- m3.medium
- m4.large
- m5.metal
- m5.large
- m5a.large
- m5ad.large
- m5d.metal
- m5d.large
- m5zn.large
- m5zn.metal
- m5n.large
- m5n.metal
- m5dn.large
- m5dn.metal
- m6a.large
- m6a.metal
- m6i.large
- m6i.metal
- m6id.large
- m6id.metal
- m7i.large
- m7i.metal-24xl
- m7i.metal-48xl
- m7i-flex.large
- m7a.medium
- m7a.large
- m7a.metal-48xl
- r3.large
- r4.large
- r5.metal
- r5.large
- r5a.large
- r5d.metal
- r5ad.large
- r5d.large
- r5dn.large
- r5dn.metal
- r5b.large
- r5b.metal
- r5n.large
- r5n.metal
- r6a.large
- r6a.metal
- r6i.large
- r6i.metal
- r6id.large
- r6id.metal
- r7i.large
- r7i.metal-24xl
- r7i.metal-48xl
- r7iz.large
- r7iz.metal-16xl
- r7iz.metal-32xl
- r7a.medium
- r7a.large
- r7a.metal-48xl
- t2.2xlarge
- t2.large
- t2.medium
- t2.micro
- t2.nano
- t2.small
- t2.xlarge
- t3.2xlarge
- t3.large
- t3.medium
- t3.micro
- t3.nano
- t3.small
- t3.xlarge
- t3a.2xlarge
- t3a.large
- t3a.medium
- t3a.micro
- t3a.nano
- t3a.small
- t3a.xlarge
- x2idn.metal
- x2iedn.metal
- x2iezn.metal
- z1d.metal
- z1d.large
SpotPrice:
Description: Spot price for instances in USD/Hour - Optional/advanced
Type: Number
MinValue: '0'
MaxValue: '2'
Default: '0'
KeyName:
Description: Name of an existing EC2 KeyPair to enable SSH access to the instance
Type: String
NumberOfZones:
Description: Total number of Availability Zones, which can be 1 or 3. Select 3 zones for Application Load Balancer. Once the stack has been created, the number of Availability Zones cannot be changed.
Type: Number
AllowedValues:
- 1
- 3
Default: 3
NodesPerZone:
Description: Total number of nodes per Zone. Set to 0 to shutdown/hibernate
Type: Number
MinValue: '0'
MaxValue: '20'
Default: '1'
The parameters used to configure the network are shown below.
The cluster can be in either one Availability Zone or three Availability Zones. Multiple nodes can be placed within an Availability Zone. The Availability Zones for subnets. Accept either 1 zone or 3 zones. In the order of Subnet 1, Subnet 2 and Subnet 3 (if applicable).
AZ:
Description: The Availability Zones for VPC subnets. Accept either 1 zone or 3 zones. In the order of Subnet 1, Subnet 2 and Subnet 3 (if applicable).
Type: 'List<AWS::EC2::AvailabilityZone::Name>'
LogSNS:
Description: SNS Topic for logging - optional/advanced.
Type: String
Default: none
# network configuration
# network configuration
Parameters for VPC and subnets ........
The parameters used to configure MarkLogic Server are shown below.
# marklogic configuration
AdminUser:
Description: The MarkLogic administrator username
Type: String
AdminPass:
Description: The MarkLogic administrator password
Type: String
NoEcho: 'true'
AllowedPattern: >-
^(?!.*[*]).*$
ConstraintDescription: Admin password must contain any characters except asterisk (*).
Licensee:
Description: The MarkLogic Licensee or 'none'. Provide none/none to choose PAYG version. Provide valid Licensee/Licensekey to choose BYOL version.
Type: String
Default: none
LicenseKey:
Description: The MarkLogic License Key or 'none'. Provide none/none to choose PAYG version. Provide valid Licensee/Licensekey to choose BYOL version.
Type: String
Default: none