CREATEENVIRONMENT()`¶

About CreateEnvironment¶

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_vpcid` `TYPE /AWS1/EVSVPCID` `/AWS1/EVSVPCID`¶

A unique ID for the VPC that connects to the environment control plane for service access.

Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.

The VPC that you select must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts.

If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.

Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.

`iv_serviceaccesssubnetid` `TYPE /AWS1/EVSSUBNETID` `/AWS1/EVSSUBNETID`¶

The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to validate mandatory DNS records for your VCF appliances and hosts and create the environment.

`iv_vcfversion` `TYPE /AWS1/EVSVCFVERSION` `/AWS1/EVSVCFVERSION`¶

The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.

`iv_termsaccepted` `TYPE /AWS1/EVSBOOLEAN` `/AWS1/EVSBOOLEAN`¶

Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.

`it_licenseinfo` `TYPE /AWS1/CL_EVSLICENSEINFO=>TT_LICENSEINFOLIST` `TT_LICENSEINFOLIST`¶

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

VCF license information can be retrieved from the Broadcom portal.

`io_initialvlans` `TYPE REF TO /AWS1/CL_EVSINITIALVLANS` `/AWS1/CL_EVSINITIALVLANS`¶

The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.

`it_hosts` `TYPE /AWS1/CL_EVSHOSTINFOFORCREATE=>TT_HOSTINFOFORCREATELIST` `TT_HOSTINFOFORCREATELIST`¶

The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

`io_connectivityinfo` `TYPE REF TO /AWS1/CL_EVSCONNECTIVITYINFO` `/AWS1/CL_EVSCONNECTIVITYINFO`¶

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX, providing BGP dynamic routing for overlay networks.

`io_vcfhostnames` `TYPE REF TO /AWS1/CL_EVSVCFHOSTNAMES` `/AWS1/CL_EVSVCFHOSTNAMES`¶

The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.

`iv_siteid` `TYPE /AWS1/EVSSTRING` `/AWS1/EVSSTRING`¶

The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/EVSCLIENTTOKEN` `/AWS1/EVSCLIENTTOKEN`¶

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

`iv_environmentname` `TYPE /AWS1/EVSENVIRONMENTNAME` `/AWS1/EVSENVIRONMENTNAME`¶

The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.

`iv_kmskeyid` `TYPE /AWS1/EVSSTRING` `/AWS1/EVSSTRING`¶

A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.

`it_tags` `TYPE /AWS1/CL_EVSREQUESTTAGMAP_W=>TT_REQUESTTAGMAP` `TT_REQUESTTAGMAP`¶

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

`io_serviceaccesssecgroups` `TYPE REF TO /AWS1/CL_EVSSVCACCESSSECGROUPS` `/AWS1/CL_EVSSVCACCESSSECGROUPS`¶

The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.

The security group should allow access to the following.

TCP/UDP access to the DNS servers

HTTPS/SSH access to the host management VLAN subnet

HTTPS/SSH access to the Management VM VLAN subnet

You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_evscreateenvresponse` `/AWS1/CL_EVSCREATEENVRESPONSE`¶

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->/aws1/if_evs~createenvironment(
  io_connectivityinfo = new /aws1/cl_evsconnectivityinfo(
    it_pvtrouteserverpeerings = VALUE /aws1/cl_evsroutesrvpeerlist_w=>tt_routeserverpeeringlist(
      ( new /aws1/cl_evsroutesrvpeerlist_w( |string| ) )
    )
  )
  io_initialvlans = new /aws1/cl_evsinitialvlans(
    io_edgevtep = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_expansionvlan1 = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_expansionvlan2 = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_hcx = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_nsxuplink = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_vmkmanagement = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_vmmanagement = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_vmotion = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_vsan = new /aws1/cl_evsinitialvlaninfo( |string| )
    io_vtep = new /aws1/cl_evsinitialvlaninfo( |string| )
  )
  io_serviceaccesssecgroups = new /aws1/cl_evssvcaccesssecgroups(
    it_securitygroups = VALUE /aws1/cl_evssecuritygroups_w=>tt_securitygroups(
      ( new /aws1/cl_evssecuritygroups_w( |string| ) )
    )
  )
  io_vcfhostnames = new /aws1/cl_evsvcfhostnames(
    iv_cloudbuilder = |string|
    iv_nsx = |string|
    iv_nsxedge1 = |string|
    iv_nsxedge2 = |string|
    iv_nsxmanager1 = |string|
    iv_nsxmanager2 = |string|
    iv_nsxmanager3 = |string|
    iv_sddcmanager = |string|
    iv_vcenter = |string|
  )
  it_hosts = VALUE /aws1/cl_evshostinfoforcreate=>tt_hostinfoforcreatelist(
    (
      new /aws1/cl_evshostinfoforcreate(
        iv_dedicatedhostid = |string|
        iv_hostname = |string|
        iv_instancetype = |string|
        iv_keyname = |string|
        iv_placementgroupid = |string|
      )
    )
  )
  it_licenseinfo = VALUE /aws1/cl_evslicenseinfo=>tt_licenseinfolist(
    (
      new /aws1/cl_evslicenseinfo(
        iv_solutionkey = |string|
        iv_vsankey = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_evsrequesttagmap_w=>tt_requesttagmap(
    (
      VALUE /aws1/cl_evsrequesttagmap_w=>ts_requesttagmap_maprow(
        key = |string|
        value = new /aws1/cl_evsrequesttagmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_environmentname = |string|
  iv_kmskeyid = |string|
  iv_serviceaccesssubnetid = |string|
  iv_siteid = |string|
  iv_termsaccepted = ABAP_TRUE
  iv_vcfversion = |string|
  iv_vpcid = |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_environmentid = lo_environment->get_environmentid( ).
    lv_environmentstate = lo_environment->get_environmentstate( ).
    lv_statedetails = lo_environment->get_statedetails( ).
    lv_timestamp = lo_environment->get_createdat( ).
    lv_timestamp = lo_environment->get_modifiedat( ).
    lv_arn = lo_environment->get_environmentarn( ).
    lv_environmentname = lo_environment->get_environmentname( ).
    lv_vpcid = lo_environment->get_vpcid( ).
    lv_subnetid = lo_environment->get_serviceaccesssubnetid( ).
    lv_vcfversion = lo_environment->get_vcfversion( ).
    lv_boolean = lo_environment->get_termsaccepted( ).
    LOOP AT lo_environment->get_licenseinfo( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_solutionkey = lo_row_1->get_solutionkey( ).
        lv_vsanlicensekey = lo_row_1->get_vsankey( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_environment->get_siteid( ).
    lv_checkresult = lo_environment->get_environmentstatus( ).
    LOOP AT lo_environment->get_checks( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_checktype = lo_row_3->get_type( ).
        lv_checkresult = lo_row_3->get_result( ).
        lv_timestamp = lo_row_3->get_impairedsince( ).
      ENDIF.
    ENDLOOP.
    lo_connectivityinfo = lo_environment->get_connectivityinfo( ).
    IF lo_connectivityinfo IS NOT INITIAL.
      LOOP AT lo_connectivityinfo->get_pvtrouteserverpeerings( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_routeserverpeering = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_vcfhostnames = lo_environment->get_vcfhostnames( ).
    IF lo_vcfhostnames IS NOT INITIAL.
      lv_hostname = lo_vcfhostnames->get_vcenter( ).
      lv_hostname = lo_vcfhostnames->get_nsx( ).
      lv_hostname = lo_vcfhostnames->get_nsxmanager1( ).
      lv_hostname = lo_vcfhostnames->get_nsxmanager2( ).
      lv_hostname = lo_vcfhostnames->get_nsxmanager3( ).
      lv_hostname = lo_vcfhostnames->get_nsxedge1( ).
      lv_hostname = lo_vcfhostnames->get_nsxedge2( ).
      lv_hostname = lo_vcfhostnames->get_sddcmanager( ).
      lv_hostname = lo_vcfhostnames->get_cloudbuilder( ).
    ENDIF.
    lv_string = lo_environment->get_kmskeyid( ).
    lo_serviceaccesssecuritygr = lo_environment->get_serviceaccesssecgroups( ).
    IF lo_serviceaccesssecuritygr IS NOT INITIAL.
      LOOP AT lo_serviceaccesssecuritygr->get_securitygroups( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_securitygroupid = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    LOOP AT lo_environment->get_credentials( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_secretarn( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/CL_EVS=>CREATEENVIRONMENT()¶

About CreateEnvironment¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_vpcid TYPE /AWS1/EVSVPCID /AWS1/EVSVPCID¶

iv_serviceaccesssubnetid TYPE /AWS1/EVSSUBNETID /AWS1/EVSSUBNETID¶

iv_vcfversion TYPE /AWS1/EVSVCFVERSION /AWS1/EVSVCFVERSION¶

iv_termsaccepted TYPE /AWS1/EVSBOOLEAN /AWS1/EVSBOOLEAN¶

it_licenseinfo TYPE /AWS1/CL_EVSLICENSEINFO=>TT_LICENSEINFOLIST TT_LICENSEINFOLIST¶

io_initialvlans TYPE REF TO /AWS1/CL_EVSINITIALVLANS /AWS1/CL_EVSINITIALVLANS¶

it_hosts TYPE /AWS1/CL_EVSHOSTINFOFORCREATE=>TT_HOSTINFOFORCREATELIST TT_HOSTINFOFORCREATELIST¶

io_connectivityinfo TYPE REF TO /AWS1/CL_EVSCONNECTIVITYINFO /AWS1/CL_EVSCONNECTIVITYINFO¶

io_vcfhostnames TYPE REF TO /AWS1/CL_EVSVCFHOSTNAMES /AWS1/CL_EVSVCFHOSTNAMES¶

iv_siteid TYPE /AWS1/EVSSTRING /AWS1/EVSSTRING¶