Skip to content

UpdateServiceInstanceInput

Source code in docs_src/capo_proton/types/update_service_instance_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class UpdateServiceInstanceInput(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service instance to update.</p>"""
    service_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service that the service instance belongs to.</p>"""
    deployment_type: "capo_proton.types.deployment_update_type.DeploymentUpdateType"
    """<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’t</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>"""
    spec: NotRequired["capo_proton.types.spec_contents.SpecContents"]
    """<p>The formatted specification that defines the service instance update.</p>"""
    template_major_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>The major version of the service template to update.</p>"""
    template_minor_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>The minor version of the service template to update.</p>"""
    client_token: NotRequired["capo_proton.types.client_token.ClientToken"]
    """<p>The client token of the service instance to update.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

The client token of the service instance to update.

deployment_type instance-attribute 

deployment_type: DeploymentUpdateType

The deployment type. It defines the mode for updating a service instance, as follows:

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

MINOR_VERSION

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.

MAJOR_VERSION

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.

name instance-attribute 

name: ResourceName

The name of the service instance to update.

service_name instance-attribute 

service_name: ResourceName

The name of the service that the service instance belongs to.

spec instance-attribute 

spec: NotRequired[SpecContents]

The formatted specification that defines the service instance update.

template_major_version instance-attribute 

template_major_version: NotRequired[TemplateVersionPart]

The major version of the service template to update.

template_minor_version instance-attribute 

template_minor_version: NotRequired[TemplateVersionPart]

The minor version of the service template to update.