Skip to content

/AWS1/CL_MHRAPIGWPROXYINPUT

A wrapper object holding the Amazon API Gateway endpoint input.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_endpointtype TYPE /AWS1/MHRAPIGATEWAYENDPTTYPE /AWS1/MHRAPIGATEWAYENDPTTYPE

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

iv_stagename TYPE /AWS1/MHRSTAGENAME /AWS1/MHRSTAGENAME

The name of the API Gateway stage. The name defaults to prod.

Queryable Attributes

EndpointType

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

Accessible with the following methods

Method Description
GET_ENDPOINTTYPE() Getter for ENDPOINTTYPE, with configurable default
ASK_ENDPOINTTYPE() Getter for ENDPOINTTYPE w/ exceptions if field has no value
HAS_ENDPOINTTYPE() Determine if ENDPOINTTYPE has a value

StageName

The name of the API Gateway stage. The name defaults to prod.

Accessible with the following methods

Method Description
GET_STAGENAME() Getter for STAGENAME, with configurable default
ASK_STAGENAME() Getter for STAGENAME w/ exceptions if field has no value
HAS_STAGENAME() Determine if STAGENAME has a value