Skip to main content

Modify DynamoDB Instance properties​

Select

SaaS
Customer Managed

This operation will modify the instance properties using Instance ID.

Path Parameters
  • Instance_id string required

    ID of instance

Request Body
  • instanceProperties object
  • instance object
  • instanceId integer

    InstanceId of the DynamoDB instance to be modified

  • applicationId integer

    Default value: 134

  • clientId integer
  • cloudAppsInstance object
  • instanceType string
  • generalCloudProperties object
  • credentials object

    Authentication and credential to be modified

  • credentialId integer
  • credentialName string
  • regionEndPoints string
  • accessNodes object

    Details of access node to be modified

  • memberServers object[]
  • client object
  • clientId integer
  • clientName string
  • _type_ integer
  • isClientGroup boolean
  • displayLabel string
  • optionId string
  • typeLabel string
  • selected boolean
  • amazonInstanceInfo object
  • useIamRole boolean
  • credentialType integer
  • planEntity object

    Details of the plan to be modified

  • planId integer
  • planName string
  • type string
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instance_id

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Instance_id — path required
Body
{

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "applicationId": 134,

      "clientId": 0

    },

    "cloudAppsInstance": {

      "instanceType": "string",

      "generalCloudProperties": {

        "credentials": {

          "credentialId": 0,

          "credentialName": "string"

        },

        "regionEndPoints": "string",

        "accessNodes": {

          "memberServers": [

            {

              "client": {

                "clientId": 0,

                "clientName": "string",

                "_type_": 0,

                "isClientGroup": true,

                "displayLabel": "string",

                "optionId": "string",

                "typeLabel": "string",

                "selected": true

              }

            }

          ]

        },

        "amazonInstanceInfo": {

          "useIamRole": true

        }

      },

      "credentialType": 0

    },

    "planEntity": {

      "planId": 0,

      "planName": "string",

      "type": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:Instance_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 134,
      "clientId": 0
    },
    "cloudAppsInstance": {
      "instanceType": "string",
      "generalCloudProperties": {
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "regionEndPoints": "string",
        "accessNodes": {
          "memberServers": [
            {
              "client": {
                "clientId": 0,
                "clientName": "string",
                "_type_": 0,
                "isClientGroup": true,
                "displayLabel": "string",
                "optionId": "string",
                "typeLabel": "string",
                "selected": true
              }
            }
          ]
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      },
      "credentialType": 0
    },
    "planEntity": {
      "planId": 0,
      "planName": "string",
      "type": "string"
    }
  }
}'