Skip to content

Update Service Pipeline

proton_update_service_pipeline R Documentation

Update the service pipeline

Description

Update the service pipeline.

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.

Usage

proton_update_service_pipeline(deploymentType, serviceName, spec,
  templateMajorVersion, templateMinorVersion)

Arguments

deploymentType

[required] 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.

serviceName

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

spec

[required] The spec for the service pipeline to update.

templateMajorVersion

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

templateMinorVersion

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

Value

A list with the following syntax: 

list(
  pipeline = list(
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
    deploymentStatusMessage = "string",
    lastAttemptedDeploymentId = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    spec = "string",
    templateMajorVersion = "string",
    templateMinorVersion = "string",
    templateName = "string"
  )
)

Request syntax

svc$update_service_pipeline(
  deploymentType = "NONE"|"CURRENT_VERSION"|"MINOR_VERSION"|"MAJOR_VERSION",
  serviceName = "string",
  spec = "string",
  templateMajorVersion = "string",
  templateMinorVersion = "string"
)