Use this resource to get advanced configuration details for an elastic runtime environment, or to create or update an advanced configuration. You can also read the link between the advanced configuration and the runtime environment.
Use the ClusterConfig resource to create and manage the advanced configuration for an elastic runtime environment through the command line.
You can send the following requests:
•To get details about an advanced configuration, send a GET request.
•To create an advanced configuration, send a POST request.
•To update an advanced configuration, send a PUT request.
•To retrieve the association between the advanced configuration and the runtime environment, sent a GET request. You can retrieve either by the runtime environment ID or advanced configuration ID.
•To associate an advanced configuration with a runtime environment, send a POST request.
Getting advanced configuration details
You can request the details for a specific advanced configuration.
GET request
To get advanced configuration details, use the following URI:
If you have administrator privileges, you can use the ClusterConfig resource to create an advanced configuration.
POST request
To create a user group, send a POST request using the following URI:
/public/core/v3/ClusterConfig
Include the following information:
Field
Type
Required
Description
orgId
String
Yes
ID of the organization the advanced configuration belongs to.
infaManaged
Boolean
Yes
Whether the advanced configuration is managed by Informatica.
Note: While the elastic runtime environment feature is in preview, the infaManaged field is always false.
clusterName
String
Yes
Name of the advanced configuration.
description
String
-
Description of the advanced configuration.
cloudPlatform
String
Yes
Cloud platform hosting the advanced configuration. Currently this is AWS.
haEnabled
Boolean
Yes
Whether high availability is enabled.
region
String
Yes
Region in which the advanced configuration is located.
subnets
Array
Yes
Subnets used within the network.
Note: While the elastic runtime environment feature is in preview, the subnets field is dependent on the haEnabled field:
- If haEnabled = true, subnets should have two values.
- If haEnabled = false, subnets should be empty or null.
masterNodeInstanceType
String
Yes
Instance type to host the master node.
Note: While the elastic runtime environment feature is in preview, the master node instance type should be left empty because the cluster installer is always run on the master node.
maxWorkerNodes
Integer
Yes
Maximum number of worker nodes to use.
minWorkerNodes
Integer
Yes
Minimum number of worker nodes to use.
workerNodeIdleTimeout
Integer
Yes
Amount of time in minutes before a worker node times out.
workerNodeInstanceType
String
Yes
Instance type to host a worker node.
workerNodeVolumeSize
Integer
Yes
Volume size of a worker node.
systemDiskConfig
Escaped string representation of JSON
Yes
Properties of the system storage, if configured. Includes the file system, source mount, and access point.
dataDisksConfig
Escaped string representation of JSON
Yes
Properties of the data storage, if configured. Includes the file system, source mount, and access point.
initScriptPath
String
Yes
Amazon S3 file path of the initialization script to run on each cluster node when the node is created. Use the format: <bucket name>/<folder name>.
The script can reference other init scripts in the same folder or in a subfolder. Script must be a bash script.
masterNodeIAMRole
String
Yes
IAM role for the master node.
workerNodeIAMRole
String
-
IAM role for the worker nodes.
Note: While the elastic runtime environment feature is in preview, the workerNodeIAMRole is not used.
imageRegistryHost
String
-
Domain name or IP address of the registry hosting the container images.
Note: While the elastic runtime environment feature is in preview, the imageRegistryHost is not used.
imageRegistryUser
String
-
User name to log into the image registry host.
Note: While the elastic runtime environment feature is in preview, the imageRegistryUser is not used.
imageRegistryPassword
String
-
Password to log into the image registry host.
Note: While the elastic runtime environment feature is in preview, the imageRegistryPassword is not used.
dateDeployed
Date
-
Leave this field empty.
miscTags
Escaped string representation of JSON
Yes
Cloud ecosystem tags and runtime properties.
Each tag category is required, but their values can be empty. For example:
ID of the organization the advanced configuration belongs to.
infaManaged
Boolean
Yes
Whether the advanced configuration is managed by Informatica.
Note: While the elastic runtime environment feature is in preview, the infaManaged field is always false.
clusterName
String
Yes
Name of the advanced configuration.
description
String
-
Description of the advanced configuration.
cloudPlatform
String
Yes
Cloud platform hosting the advanced configuration. Currently this is AWS.
haEnabled
Boolean
Yes
Whether high availability is enabled.
region
String
Yes
Region in which the advanced configuration is located.
subnets
Array
Yes
Subnets used within the network.
Note: While the elastic runtime environment feature is in preview, the subnets field is dependent on the haEnabled field:
- If haEnabled = true, subnets should have two values.
- If haEnabled = false, subnets should be empty or null.
masterNodeInstanceType
String
Yes
Instance type to host the master node.
Note: While the elastic runtime environment feature is in preview, the master node instance type should be left empty because the cluster installer is always run on the master node.
maxWorkerNodes
Integer
Yes
Maximum number of worker nodes to use.
minWorkerNodes
Integer
Yes
Minimum number of worker nodes to use.
workerNodeIdleTimeout
Integer
Yes
Amount of time in minutes before a worker node times out.
workerNodeInstanceType
String
Yes
Instance type to host a worker node.
workerNodeVolumeSize
Integer
Yes
Volume size of a worker node.
systemDiskConfig
Escaped string representation of JSON
Yes
Properties of the system storage. Includes the file system, source mount, and access point.
dataDisksConfig
Escaped string representation of JSON
Yes
Properties of the data storage. Includes the file system, source mount, and access point.
initScriptPath
String
Yes
Amazon S3 file path of the initialization script to run on each cluster node when the node is created. Use the format: <bucket name>/<folder name>.
The script can reference other init scripts in the same folder or in a subfolder. Script must be a bash script.
masterNodeIAMRole
String
Yes
IAM role for the master node.
workerNodeIAMRole
String
-
IAM role for the worker nodes.
Note: While the elastic runtime environment feature is in preview, the workerNodeIAMRole is not used.
imageRegistryHost
String
-
Domain name or IP address of the registry hosting the container images.
Note: While the elastic runtime environment feature is in preview, the imageRegistryHost is not used.
imageRegistryUser
String
-
User name to log into the image registry host.
Note: While the elastic runtime environment feature is in preview, the imageRegistryUser is not used.
imageRegistryPassword
String
-
Password to log into the image registry host.
Note: While the elastic runtime environment feature is in preview, the imageRegistryPassword is not used.
dateDeployed
Date
-
Leave this field empty.
miscTags
Escaped string representation of JSON
Yes
Cloud ecosystem tags and runtime properties.
Each tag category is required, but their values can be empty. For example: