Create Component

proton_create_component

R Documentation

Create an Proton component

Description

Create an Proton component. A component is an infrastructure extension for a service instance.

For more information about components, see Proton components in the Proton User Guide.

Usage

proton_create_component(clientToken, description, environmentName,
  manifest, name, serviceInstanceName, serviceName, serviceSpec, tags,
  templateFile)

Arguments

clientToken

The client token for the created component.

description

An optional customer-provided description of the component.

environmentName

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

manifest

[required] A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

name

[required] The customer-provided name of the component.

serviceInstanceName

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

serviceName

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

serviceSpec

The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

tags

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

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

templateFile

[required] A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

Value

A list with the following syntax:

list(
  component = 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",
    description = "string",
    environmentName = "string",
    lastAttemptedDeploymentId = "string",
    lastClientRequestToken = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastModifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    name = "string",
    serviceInstanceName = "string",
    serviceName = "string",
    serviceSpec = "string"
  )
)

Request syntax

svc$create_component(
  clientToken = "string",
  description = "string",
  environmentName = "string",
  manifest = "string",
  name = "string",
  serviceInstanceName = "string",
  serviceName = "string",
  serviceSpec = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  templateFile = "string"
)