/AWS1/IF_EC2=>ASSOCCLIENTVPNTARGETNETWORK()

About AssociateClientVpnTargetNetwork

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

Method Signature

METHODS /AWS1/IF_EC2~ASSOCCLIENTVPNTARGETNETWORK
  IMPORTING
    !IV_CLIENTVPNENDPOINTID TYPE /AWS1/EC2CLIENTVPNENDPOINTID OPTIONAL
    !IV_SUBNETID TYPE /AWS1/EC2SUBNETID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_AVAILABILITYZONE TYPE /AWS1/EC2AVAILABILITYZONENAME OPTIONAL
    !IV_AVAILABILITYZONEID TYPE /AWS1/EC2AVAILABILITYZONEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2ascclivpntgtnetw01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clientvpnendpointid TYPE /AWS1/EC2CLIENTVPNENDPOINTID /AWS1/EC2CLIENTVPNENDPOINTID

The ID of the Client VPN endpoint.

Optional arguments:

iv_subnetid TYPE /AWS1/EC2SUBNETID /AWS1/EC2SUBNETID

The ID of the subnet to associate with the Client VPN endpoint. Required for VPC-based endpoints. For Transit Gateway-based endpoints, use AvailabilityZone or AvailabilityZoneId instead.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

iv_availabilityzone TYPE /AWS1/EC2AVAILABILITYZONENAME /AWS1/EC2AVAILABILITYZONENAME

The Availability Zone name for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both SubnetId and AvailabilityZone.

iv_availabilityzoneid TYPE /AWS1/EC2AVAILABILITYZONEID /AWS1/EC2AVAILABILITYZONEID

The Availability Zone ID for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both AvailabilityZone and AvailabilityZoneId.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2ascclivpntgtnetw01 /AWS1/CL_EC2ASCCLIVPNTGTNETW01

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->assocclientvpntargetnetwork(
  iv_availabilityzone = |string|
  iv_availabilityzoneid = |string|
  iv_clienttoken = |string|
  iv_clientvpnendpointid = |string|
  iv_dryrun = ABAP_TRUE
  iv_subnetid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_associationid( ).
  lo_associationstatus = lo_result->get_status( ).
  IF lo_associationstatus IS NOT INITIAL.
    lv_associationstatuscode = lo_associationstatus->get_code( ).
    lv_string = lo_associationstatus->get_message( ).
  ENDIF.
ENDIF.