CREATEENVIRONMENTCONNECTOR()`¶

About CreateEnvironmentConnector¶

Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name.

You can create only one connector of each type per environment. For environments where Amazon EVS installs VCF, the SDDC_MANAGER connector is created automatically.

Amazon EVS requires an active connector to SDDC Manager or VCF Operations Manager to monitor environment health and license compliance.

Method Signature¶

METHODS /AWS1/IF_EVS~CREATEENVIRONMENTCONNECTOR
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/EVSCLIENTTOKEN OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/EVSENVIRONMENTID OPTIONAL
    !IV_TYPE TYPE /AWS1/EVSCONNECTORTYPE OPTIONAL
    !IV_APPLIANCEFQDN TYPE /AWS1/EVSAPPLIANCEFQDN OPTIONAL
    !IV_SECRETIDENTIFIER TYPE /AWS1/EVSSECRETIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_evscreateenvcnctrrsp
  RAISING
    /AWS1/CX_EVSRESOURCENOTFOUNDEX
    /AWS1/CX_EVSTHROTTLINGEX
    /AWS1/CX_EVSVALIDATIONEX
    /AWS1/CX_EVSCLIENTEXC
    /AWS1/CX_EVSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_environmentid` `TYPE /AWS1/EVSENVIRONMENTID` `/AWS1/EVSENVIRONMENTID`¶

A unique ID for the environment to create the connector in.

`iv_type` `TYPE /AWS1/EVSCONNECTORTYPE` `/AWS1/EVSCONNECTORTYPE`¶

The type of connector to create.

OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments.

SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.

VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.

`iv_appliancefqdn` `TYPE /AWS1/EVSAPPLIANCEFQDN` `/AWS1/EVSAPPLIANCEFQDN`¶

The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.

`iv_secretidentifier` `TYPE /AWS1/EVSSECRETIDENTIFIER` `/AWS1/EVSSECRETIDENTIFIER`¶

The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields.

Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.

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 connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_evscreateenvcnctrrsp` `/AWS1/CL_EVSCREATEENVCNCTRRSP`¶

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->createenvironmentconnector(
  iv_appliancefqdn = |string|
  iv_clienttoken = |string|
  iv_environmentid = |string|
  iv_secretidentifier = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_connector = lo_result->get_connector( ).
  IF lo_connector IS NOT INITIAL.
    lv_environmentid = lo_connector->get_environmentid( ).
    lv_connectorid = lo_connector->get_connectorid( ).
    lv_connectortype = lo_connector->get_type( ).
    lv_appliancefqdn = lo_connector->get_appliancefqdn( ).
    lv_secretidentifier = lo_connector->get_secretarn( ).
    lv_connectorstate = lo_connector->get_state( ).
    lv_statedetails = lo_connector->get_statedetails( ).
    lv_checkresult = lo_connector->get_status( ).
    LOOP AT lo_connector->get_checks( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_checktype = lo_row_1->get_type( ).
        lv_checkresult = lo_row_1->get_result( ).
        lv_timestamp = lo_row_1->get_lastcheckattempt( ).
        lv_timestamp = lo_row_1->get_impairedsince( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_connector->get_createdat( ).
    lv_timestamp = lo_connector->get_modifiedat( ).
  ENDIF.
ENDIF.

/AWS1/IF_EVS=>CREATEENVIRONMENTCONNECTOR()¶