Amazon Proton · Schema
UpdateServiceInstanceInput
UpdateServiceInstanceInput schema from Amazon Proton API
DevOpsInfrastructure as CodePlatform EngineeringServerlessTemplatesSelf-ServiceCI/CD
Properties
| Name | Type | Description |
|---|---|---|
| clientToken | object | |
| deploymentType | object | |
| name | object | |
| serviceName | object | |
| spec | object | |
| templateMajorVersion | object | |
| templateMinorVersion | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-proton/refs/heads/main/json-schema/amazon-proton-update-service-instance-input-schema.json",
"title": "UpdateServiceInstanceInput",
"description": "UpdateServiceInstanceInput schema from Amazon Proton API",
"type": "object",
"properties": {
"clientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientToken"
},
{
"description": "The client token of the service instance to update."
}
]
},
"deploymentType": {
"allOf": [
{
"$ref": "#/components/schemas/DeploymentUpdateType"
},
{
"description": "<p>The deployment type. It defines the mode for updating a service instance, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don\u2019t</i> include major or minor version parameters when you use this deployment type.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.</p> </dd> </dl>"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"description": "The name of the service instance to update."
}
]
},
"serviceName": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"description": "The name of the service that the service instance belongs to."
}
]
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/SpecContents"
},
{
"description": "The formatted specification that defines the service instance update."
}
]
},
"templateMajorVersion": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateVersionPart"
},
{
"description": "The major version of the service template to update."
}
]
},
"templateMinorVersion": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateVersionPart"
},
{
"description": "The minor version of the service template to update."
}
]
}
},
"required": [
"deploymentType",
"name",
"serviceName"
]
}