REST API Reference

Back Next

Updating a configuration

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

PUT request

To update a configuration, send a PUT request using the following URI:

/public/core/v3/ClusterConfig/<advanced_config_ID>

Include the following information:

Field	Type	Required	Description
ID	String	Yes	Configuration ID.
orgId	String	Yes	ID of the organization the configuration belongs to.
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	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	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\":[]}"

PUT response

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

PUT example

To update a configuration, send a request like the following example:

POST <baseApiUrl>/public/core/v3/ClusterConfig/<config_ID>
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "id": "89Dnw937Al30sN40ia9Oat",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "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\": \"\", \"sourceMount\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceMount\": \"\", \"targetMount\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": null,
    "imageRegistryPassword": "null",
    "dateDeployed": null,
    "miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
}

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

{
    "id": "89Dnw937Al30sN40ia9Oat",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "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\": \"\", \"sourceMount\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceMount\": \"\", \"targetMount\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": null,
    "imageRegistryPassword": "null",
    "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

Updating a configuration

Updating a configuration

PUT request

PUT response

PUT example