Skip to content

Create Environment

proton_create_environment R Documentation

Deploy a new environment

Description

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

  • Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.

  • Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see Environments and Provisioning methods in the Proton User Guide.

Usage

proton_create_environment(codebuildRoleArn, componentRoleArn,
  description, environmentAccountConnectionId, name, protonServiceRoleArn,
  provisioningRepository, spec, tags, templateMajorVersion,
  templateMinorVersion, templateName)

Arguments

codebuildRoleArn

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

componentRoleArn

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

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

description

A description of the environment that's being created and deployed.

environmentAccountConnectionId

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

name

[required] The name of the environment.

protonServiceRoleArn

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

provisioningRepository

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see create_repository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

spec

[required] A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

tags

An optional list of metadata items that you can associate with the Proton environment. 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 environment template.

templateMinorVersion

The minor version of the environment template.

templateName

[required] The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

Value

A list with the following syntax: 

list(
  environment = list(
    arn = "string",
    codebuildRoleArn = "string",
    componentRoleArn = "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",
    environmentAccountConnectionId = "string",
    environmentAccountId = "string",
    lastAttemptedDeploymentId = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    name = "string",
    protonServiceRoleArn = "string",
    provisioning = "CUSTOMER_MANAGED",
    provisioningRepository = list(
      arn = "string",
      branch = "string",
      name = "string",
      provider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
    ),
    spec = "string",
    templateMajorVersion = "string",
    templateMinorVersion = "string",
    templateName = "string"
  )
)

Request syntax

svc$create_environment(
  codebuildRoleArn = "string",
  componentRoleArn = "string",
  description = "string",
  environmentAccountConnectionId = "string",
  name = "string",
  protonServiceRoleArn = "string",
  provisioningRepository = list(
    branch = "string",
    name = "string",
    provider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
  ),
  spec = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  templateMajorVersion = "string",
  templateMinorVersion = "string",
  templateName = "string"
)