Skip to content

UpdateServicePipelineInput

Source code in docs_src/capo_proton/types/update_service_pipeline_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class UpdateServicePipelineInput(TypedDict, closed=True):
    service_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the service to that the pipeline is associated with.</p>"""
    spec: "capo_proton.types.spec_contents.SpecContents"
    """<p>The spec for the service pipeline to update.</p>"""
    deployment_type: "capo_proton.types.deployment_update_type.DeploymentUpdateType"
    """<p>The deployment type.</p> <p>There are four modes for updating a service pipeline. The <code>deploymentType</code> field defines the mode.</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 pipeline 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 <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can 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 pipeline 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>"""
    template_major_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>The major version of the service template that was used to create the service that the pipeline is associated with.</p>"""
    template_minor_version: NotRequired[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ]
    """<p>The minor version of the service template that was used to create the service that the pipeline is associated with.</p>"""

deployment_type instance-attribute 

deployment_type: DeploymentUpdateType

The deployment type.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

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

CURRENT_VERSION

In this mode, the service pipeline 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 pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline 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.

service_name instance-attribute 

service_name: ResourceName

The name of the service to that the pipeline is associated with.

spec instance-attribute 

spec: SpecContents

The spec for the service pipeline to update.

template_major_version instance-attribute 

template_major_version: NotRequired[TemplateVersionPart]

The major version of the service template that was used to create the service that the pipeline is associated with.

template_minor_version instance-attribute 

template_minor_version: NotRequired[TemplateVersionPart]

The minor version of the service template that was used to create the service that the pipeline is associated with.