Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateResponderGateway

Creates a responder gateway.

Important

A domain name or managed endpoint is required.

Request Syntax


POST /responder-gateway HTTP/1.1
Content-type: application/json

{
   "clientRoutingPolicy": "string",
   "clientToken": "string",
   "description": "string",
   "domainName": "string",
   "gatewayType": "string",
   "listenerConfig": { 
      "protocols": [ "string" ]
   },
   "managedEndpointConfiguration": { ... },
   "port": number,
   "protocol": "string",
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "trustStoreConfiguration": { 
      "certificateAuthorityCertificates": [ "string" ]
   },
   "vpcId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientRoutingPolicy

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, RTB Fabric uses AVAILABILITY_ZONE_AFFINITY. To get the behavior of ANY_AVAILABILITY_ZONE, create the gateway with subnets in more than one Availability Zone. 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 AWS RTB Fabric User Guide.

Type: String

Valid Values: AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE

Required: No

clientToken

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 AWS 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.

Type: String

Required: Yes

description

An optional description for the responder gateway.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Required: No

domainName

The domain name for the responder gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+

Required: No

gatewayType

The type of gateway. Valid values are EXTERNAL or INTERNAL.

Type: String

Valid Values: EXTERNAL | INTERNAL

Required: No

listenerConfig

Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.

Type: ListenerConfig object

Required: No

managedEndpointConfiguration

The configuration for the managed endpoint.

Type: ManagedEndpointConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

port

The networking port to use.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes

protocol

The networking protocol to use.

Type: String

Valid Values: HTTP | HTTPS

Required: Yes

securityGroupIds

The unique identifiers of the security groups.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 11. Maximum length of 43.

Pattern: sg-[0-9a-f]{8,40}

Required: Yes

subnetIds

Unique identifiers of the subnets. A service quota for your account sets the number of Availability Zones that your subnets can span. By default, this quota is one Availability Zone. To span more Availability Zones, request a quota increase.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: subnet-\w{8,17}

Required: Yes

tags

A map of the key-value pairs of the tag or tags to assign to the resource.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (resourceArn|internalId|[a-zA-Z0-9+\-=._:/@]+)

Value Length Constraints: Minimum length of 0. Maximum length of 1600.

Required: No

trustStoreConfiguration

The configuration of the trust store.

Type: TrustStoreConfiguration object

Required: No

vpcId

The unique identifier of the Virtual Private Cloud (VPC).

Type: String

Length Constraints: Minimum length of 12. Maximum length of 21.

Pattern: vpc-[a-f0-9]{8,17}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "clientRoutingPolicy": "string",
   "externalInboundEndpoint": "string",
   "gatewayId": "string",
   "listenerConfig": { 
      "protocols": [ "string" ]
   },
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientRoutingPolicy

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. For more information, see Configuring Availability Zone affinity in the AWS RTB Fabric User Guide.

Type: String

Valid Values: AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE

externalInboundEndpoint

The external inbound endpoint for the responder gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+

gatewayId

The unique identifier of the gateway.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 32.

Pattern: rtb-gw-[a-z0-9-]{1,25}

listenerConfig

The listener configuration for the responder gateway.

Type: ListenerConfig object

status

The status of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request could not be completed because you do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request could not be completed because of an internal server error. Try your call again.

HTTP Status Code: 500

ResourceNotFoundException

The request could not be completed because the resource does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request could not be completed because you exceeded a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request could not be completed because it fails satisfy the constraints specified by the service.

HTTP Status Code: 400