Parameters Declaration
- Last Updated: April 14, 2026
- 2 minute read
- MarkLogic Server
- Version 11.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
Default: gp2
InstanceType:
Description: Type of EC2 instance to launch
Type: String
Default: r5.4xlarge
AllowedValues:
- ---- Essential Enterprise and Bring-Your-Own-License ----
allowed instance types ......
- -------------- Bring-Your-Own-License Only --------------
allowed instance types ......
SpotPrice:
Description: Spot price for instances in USD/Hour - Optional/advanced.
Type: Number
MinValue: '0'
MaxValue: '2'
Default: '0'
KeyName:
Description: Name of and existing EC2 KeyPair to enable SSH access to the instance.
Type: String
NumberOfZones:
Description: Total number of Availability Zones. 1 or 3.
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. Requires instance public IP enabled.
Type: String
Default: none
# 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'
Licensee:
Description: The MarkLogic Licensee or 'none'
Type: String
Default: none
LicenseKey:
Description: The MarkLogic License Key or 'none'
Type: String
Default: none