Create Service

proton_create_service

R Documentation

Create an Proton service

Description

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide.

Usage

proton_create_service(branchName, description, name,
  repositoryConnectionArn, repositoryId, spec, tags, templateMajorVersion,
  templateMinorVersion, templateName)

Arguments

branchName

The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

description

A description of the Proton service.

name

[required] The service name.

repositoryConnectionArn

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

repositoryId

The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

spec

[required] A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

tags

An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

templateMajorVersion

[required] The major version of the service template that was used to create the service.

templateMinorVersion

The minor version of the service template that was used to create the service.

templateName

[required] The name of the service template that's used to create the service.

Value

A list with the following syntax:

list(
  service = list(
    arn = "string",
    branchName = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    lastModifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    name = "string",
    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"
    ),
    repositoryConnectionArn = "string",
    repositoryId = "string",
    spec = "string",
    status = "CREATE_IN_PROGRESS"|"CREATE_FAILED_CLEANUP_IN_PROGRESS"|"CREATE_FAILED_CLEANUP_COMPLETE"|"CREATE_FAILED_CLEANUP_FAILED"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED_CLEANUP_IN_PROGRESS"|"UPDATE_FAILED_CLEANUP_COMPLETE"|"UPDATE_FAILED_CLEANUP_FAILED"|"UPDATE_FAILED"|"UPDATE_COMPLETE_CLEANUP_FAILED",
    statusMessage = "string",
    templateName = "string"
  )
)

Request syntax

svc$create_service(
  branchName = "string",
  description = "string",
  name = "string",
  repositoryConnectionArn = "string",
  repositoryId = "string",
  spec = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  templateMajorVersion = "string",
  templateMinorVersion = "string",
  templateName = "string"
)