Skip to content

/AWS1/IF_PRN=>CREATEENVIRONMENT()

About CreateEnvironment

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.

Method Signature

METHODS /AWS1/IF_PRN~CREATEENVIRONMENT
  IMPORTING
    !IV_NAME TYPE /AWS1/PRNRESOURCENAME OPTIONAL
    !IV_TEMPLATENAME TYPE /AWS1/PRNRESOURCENAME OPTIONAL
    !IV_TEMPLATEMAJORVERSION TYPE /AWS1/PRNTEMPLATEVERSIONPART OPTIONAL
    !IV_TEMPLATEMINORVERSION TYPE /AWS1/PRNTEMPLATEVERSIONPART OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/PRNDESCRIPTION OPTIONAL
    !IV_SPEC TYPE /AWS1/PRNSPECCONTENTS OPTIONAL
    !IV_PROTONSERVICEROLEARN TYPE /AWS1/PRNARN OPTIONAL
    !IV_ENVIRONMENTACCOUNTCONNID TYPE /AWS1/PRNENVIRONMENTACCTCONNID OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PRNTAG=>TT_TAGLIST OPTIONAL
    !IO_PROVISIONINGREPOSITORY TYPE REF TO /AWS1/CL_PRNREPOSITORYBRANCH00 OPTIONAL
    !IV_COMPONENTROLEARN TYPE /AWS1/PRNROLEARN OPTIONAL
    !IV_CODEBUILDROLEARN TYPE /AWS1/PRNROLEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_prncreenvironmentout
  RAISING
    /AWS1/CX_PRNACCESSDENIEDEX
    /AWS1/CX_PRNCONFLICTEXCEPTION
    /AWS1/CX_PRNINTERNALSERVEREX
    /AWS1/CX_PRNRESOURCENOTFOUNDEX
    /AWS1/CX_PRNSERVICEQUOTAEXCDEX
    /AWS1/CX_PRNTHROTTLINGEX
    /AWS1/CX_PRNVALIDATIONEX
    /AWS1/CX_PRNCLIENTEXC
    /AWS1/CX_PRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/PRNRESOURCENAME /AWS1/PRNRESOURCENAME

The name of the environment.

iv_templatename TYPE /AWS1/PRNRESOURCENAME /AWS1/PRNRESOURCENAME

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

iv_templatemajorversion TYPE /AWS1/PRNTEMPLATEVERSIONPART /AWS1/PRNTEMPLATEVERSIONPART

The major version of the environment template.

iv_spec TYPE /AWS1/PRNSPECCONTENTS /AWS1/PRNSPECCONTENTS

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.

Optional arguments:

iv_templateminorversion TYPE /AWS1/PRNTEMPLATEVERSIONPART /AWS1/PRNTEMPLATEVERSIONPART

The minor version of the environment template.

iv_description TYPE /AWS1/PRNDESCRIPTION /AWS1/PRNDESCRIPTION

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

iv_protonservicerolearn TYPE /AWS1/PRNARN /AWS1/PRNARN

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.

iv_environmentaccountconnid TYPE /AWS1/PRNENVIRONMENTACCTCONNID /AWS1/PRNENVIRONMENTACCTCONNID

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.

it_tags TYPE /AWS1/CL_PRNTAG=>TT_TAGLIST TT_TAGLIST

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.

io_provisioningrepository TYPE REF TO /AWS1/CL_PRNREPOSITORYBRANCH00 /AWS1/CL_PRNREPOSITORYBRANCH00

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 CreateRepository.

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

iv_componentrolearn TYPE /AWS1/PRNROLEARN /AWS1/PRNROLEARN

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.

iv_codebuildrolearn TYPE /AWS1/PRNROLEARN /AWS1/PRNROLEARN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_prncreenvironmentout /AWS1/CL_PRNCREENVIRONMENTOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createenvironment(
  io_provisioningrepository = new /aws1/cl_prnrepositorybranch00(
    iv_branch = |string|
    iv_name = |string|
    iv_provider = |string|
  )
  it_tags = VALUE /aws1/cl_prntag=>tt_taglist(
    (
      new /aws1/cl_prntag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_codebuildrolearn = |string|
  iv_componentrolearn = |string|
  iv_description = |string|
  iv_environmentaccountconnid = |string|
  iv_name = |string|
  iv_protonservicerolearn = |string|
  iv_spec = |string|
  iv_templatemajorversion = |string|
  iv_templateminorversion = |string|
  iv_templatename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_environment = lo_result->get_environment( ).
  IF lo_environment IS NOT INITIAL.
    lv_resourcename = lo_environment->get_name( ).
    lv_description = lo_environment->get_description( ).
    lv_timestamp = lo_environment->get_createdat( ).
    lv_timestamp = lo_environment->get_lastdeploymentattempte00( ).
    lv_timestamp = lo_environment->get_lastdeploymentsuccat( ).
    lv_environmentarn = lo_environment->get_arn( ).
    lv_resourcename = lo_environment->get_templatename( ).
    lv_templateversionpart = lo_environment->get_templatemajorversion( ).
    lv_templateversionpart = lo_environment->get_templateminorversion( ).
    lv_deploymentstatus = lo_environment->get_deploymentstatus( ).
    lv_statusmessage = lo_environment->get_deploymentstatusmessage( ).
    lv_arn = lo_environment->get_protonservicerolearn( ).
    lv_environmentaccountconne = lo_environment->get_environmentaccountconnid( ).
    lv_awsaccountid = lo_environment->get_environmentaccountid( ).
    lv_speccontents = lo_environment->get_spec( ).
    lv_provisioning = lo_environment->get_provisioning( ).
    lo_repositorybranch = lo_environment->get_provisioningrepository( ).
    IF lo_repositorybranch IS NOT INITIAL.
      lv_repositoryarn = lo_repositorybranch->get_arn( ).
      lv_repositoryprovider = lo_repositorybranch->get_provider( ).
      lv_repositoryname = lo_repositorybranch->get_name( ).
      lv_gitbranchname = lo_repositorybranch->get_branch( ).
    ENDIF.
    lv_rolearn = lo_environment->get_componentrolearn( ).
    lv_rolearn = lo_environment->get_codebuildrolearn( ).
    lv_deploymentid = lo_environment->get_lastattempteddeploymen00( ).
    lv_deploymentid = lo_environment->get_lastsuccdeploymentid( ).
  ENDIF.
ENDIF.