Skip to content

/AWS1/IF_MPB=>UPDATERESPONDERGATEWAY()

About UpdateResponderGateway

Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway. This operation also updates the protocols list in the listener configuration.

You cannot change the domainName, port, and protocol values that you set when you create a responder gateway. To change any of them, delete the gateway and create a new one.

Method Signature

METHODS /AWS1/IF_MPB~UPDATERESPONDERGATEWAY
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/MPBDOMAINNAME OPTIONAL
    !IV_PORT TYPE /AWS1/MPBINTEGER OPTIONAL
    !IV_PROTOCOL TYPE /AWS1/MPBPROTOCOL OPTIONAL
    !IO_LISTENERCONFIG TYPE REF TO /AWS1/CL_MPBLISTENERCONFIG OPTIONAL
    !IO_TRUSTSTORECONFIGURATION TYPE REF TO /AWS1/CL_MPBTRUSTSTORECONF OPTIONAL
    !IO_MANAGEDENDPOINTCONF TYPE REF TO /AWS1/CL_MPBMANAGEDENDPTCONF OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/MPBSTRING OPTIONAL
    !IV_GATEWAYID TYPE /AWS1/MPBGATEWAYID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/MPBSTRING OPTIONAL
    !IV_CLIENTROUTINGPOLICY TYPE /AWS1/MPBCLIENTROUTINGPOLICY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpbupdaterespgwrsp
  RAISING
    /AWS1/CX_MPBACCESSDENIEDEX
    /AWS1/CX_MPBCONFLICTEXCEPTION
    /AWS1/CX_MPBINTERNALSERVEREX
    /AWS1/CX_MPBRESOURCENOTFOUNDEX
    /AWS1/CX_MPBTHROTTLINGEX
    /AWS1/CX_MPBVALIDATIONEX
    /AWS1/CX_MPBCLIENTEXC
    /AWS1/CX_MPBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_port TYPE /AWS1/MPBINTEGER /AWS1/MPBINTEGER

Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.

iv_protocol TYPE /AWS1/MPBPROTOCOL /AWS1/MPBPROTOCOL

Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.

iv_clienttoken TYPE /AWS1/MPBSTRING /AWS1/MPBSTRING

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

iv_gatewayid TYPE /AWS1/MPBGATEWAYID /AWS1/MPBGATEWAYID

The unique identifier of the gateway.

Optional arguments:

iv_domainname TYPE /AWS1/MPBDOMAINNAME /AWS1/MPBDOMAINNAME

Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.

io_listenerconfig TYPE REF TO /AWS1/CL_MPBLISTENERCONFIG /AWS1/CL_MPBLISTENERCONFIG

The listener configuration for the responder gateway.

io_truststoreconfiguration TYPE REF TO /AWS1/CL_MPBTRUSTSTORECONF /AWS1/CL_MPBTRUSTSTORECONF

The configuration of the trust store.

io_managedendpointconf TYPE REF TO /AWS1/CL_MPBMANAGEDENDPTCONF /AWS1/CL_MPBMANAGEDENDPTCONF

The configuration for the managed endpoint.

iv_description TYPE /AWS1/MPBSTRING /AWS1/MPBSTRING

An optional description for the responder gateway.

iv_clientroutingpolicy TYPE /AWS1/MPBCLIENTROUTINGPOLICY /AWS1/MPBCLIENTROUTINGPOLICY

The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:

  • AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.

  • ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.

If you don't specify a value, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_mpbupdaterespgwrsp /AWS1/CL_MPBUPDATERESPGWRSP

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->updaterespondergateway(
  io_listenerconfig = new /aws1/cl_mpblistenerconfig(
    it_protocols = VALUE /aws1/cl_mpbprotocollist_w=>tt_protocollist(
      ( new /aws1/cl_mpbprotocollist_w( |string| ) )
    )
  )
  io_managedendpointconf = new /aws1/cl_mpbmanagedendptconf(
    io_autoscalinggroups = new /aws1/cl_mpbautoscgroupsconf(
      io_healthcheckconfig = new /aws1/cl_mpbhealthcheckconfig(
        iv_healthythresholdcount = 123
        iv_intervalseconds = 123
        iv_path = |string|
        iv_port = 123
        iv_protocol = |string|
        iv_statuscodematcher = |string|
        iv_timeoutms = 123
        iv_unhealthythresholdcount = 123
      )
      it_autoscalinggroupnames = VALUE /aws1/cl_mpbautoscgrpnamelst_w=>tt_autoscalinggroupnamelist(
        ( new /aws1/cl_mpbautoscgrpnamelst_w( |string| ) )
      )
      iv_rolearn = |string|
    )
    io_eksendpoints = new /aws1/cl_mpbeksendpointsconf(
      iv_clustapiservercacertchain = |string|
      iv_clusterapiserverendpturi = |string|
      iv_clustername = |string|
      iv_endpointsresourcename = |string|
      iv_endptsresourcenamespace = |string|
      iv_rolearn = |string|
    )
  )
  io_truststoreconfiguration = new /aws1/cl_mpbtruststoreconf(
    it_certauthoritycerts = VALUE /aws1/cl_mpbcrtauthoritycrts_w=>tt_certauthoritycerts(
      ( new /aws1/cl_mpbcrtauthoritycrts_w( |string| ) )
    )
  )
  iv_clientroutingpolicy = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_domainname = |string|
  iv_gatewayid = |string|
  iv_port = 123
  iv_protocol = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_gatewayid = lo_result->get_gatewayid( ).
  lv_respondergatewaystatus = lo_result->get_status( ).
  lv_clientroutingpolicy = lo_result->get_clientroutingpolicy( ).
ENDIF.

Update responder gateway

Update responder gateway

DATA(lo_result) = lo_client->updaterespondergateway(
  iv_clienttoken = |12345678-1234-1234-1234-123456789012|
  iv_description = |Updated responder gateway description|
  iv_gatewayid = |rtb-gw-12345678|
  iv_port = 8080
  iv_protocol = |HTTP|
).