REST API Reference

Back Next

Creating a configuration

If you have administrator privileges, you can use the ClusterConfig resource to create a configuration.

POST request

To create a configuration, 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 configuration belongs to.
amiId	String	Yes	Amazon Machine Image (AMI) ID.
infaManaged	Boolean	Yes	Whether the configuration is managed by Informatica. Set to false.
clusterName	String	Yes	Name of the configuration.
description	String	-	Description of the configuration.
cloudPlatform	String	Yes	Cloud platform hosting the configuration. Set to AWS.
haEnabled	Boolean	Yes	Whether high availability is enabled.
region	String	Yes	Region in which the configuration is located.
subnets	Array	Yes	Subnets used within the network. Enter the subnet name, not the subnet ID. 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	Leave this field empty.
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	System storage properties, if configured. Includes the file system ID, access point ID, source file path, and projected file path. For system storage, leave the projected file path empty.
dataDisksConfig	Escaped string representation of JSON	Yes	Data storage properties, if configured. Includes the file system ID, access point ID, source file path, and projected file path. The projected file path is optional. If empty, the runtime environment uses the source file path.
initScriptPath	String	Yes	Not used. An elastic runtime environment doesn't use initialization scripts.
masterNodeIAMRole	String	Yes	IAM role for the master node.
workerNodeIAMRole	String	-	Not used.
imageRegistryHost	String	-	Not used.
imageRegistryUser	String	-	Not used.
imageRegistryPassword	String	-	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: "miscTags": "{\"cloudEcosystemTags\":[],\"runtimeProperties\":[]}"

POST response

If successful, returns the ClusterConfig object in the POST request.

POST example

To create a configuration, send a request similar to the following example:

POST <baseApiUrl>/public/core/v3/ClusterConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "amiId": "ami-08d3ca04cc1a1b2c3",
    "infaManaged": false,
    "clusterName": "test-cluster-102",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "ap-south-1",
    "subnets": [
        "subnet-name1",
        "subnet-name2"
    ],
    "masterNodeInstanceType": "",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "c4.2xlarge",
    "workerNodeVolumeSize": 100,
    "systemDiskConfig": "{\"id\": \"\", \"sourceFilePath\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceFilePath\": \"\", \"projectedFilePath\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": "user",
    "imageRegistryPassword": "password",
    "dateDeployed": null,
    "miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
}

If successful, you might receive a response like the following example:

{
    "id": "89Dnw937Al30sN40ia9Oat",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "amiId": "ami-08d3ca04cc1a1b2c3",
    "infaManaged": false,
    "clusterName": "test-cluster-102",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "ap-south-1",
    "subnets": [
        "subnet-name1",
        "subnet-name2"
    ],
    "masterNodeInstanceType": "",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "c4.2xlarge",
    "workerNodeVolumeSize": 100,
    "systemDiskConfig": "{\"id\": \"\", \"sourceFilePath\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceFilePath\": \"\", \"projectedFilePath\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": "user",
    "imageRegistryPassword": "password",
    "dateDeployed": null,
    "miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Creating a configuration

Creating a configuration

POST request

POST response

POST example