RTBFabric / Client / create_responder_gateway

create_responder_gateway

RTBFabric.Client.create_responder_gateway(**kwargs)

Creates a responder gateway.

Warning

A domain name or managed endpoint is required.

See also: AWS API Documentation

Request Syntax

response = client.create_responder_gateway(
    vpcId='string',
    subnetIds=[
        'string',
    ],
    securityGroupIds=[
        'string',
    ],
    domainName='string',
    port=123,
    protocol='HTTP'|'HTTPS',
    listenerConfig={
        'protocols': [
            'HTTP'|'HTTPS',
        ]
    },
    trustStoreConfiguration={
        'certificateAuthorityCertificates': [
            'string',
        ]
    },
    managedEndpointConfiguration={
        'autoScalingGroups': {
            'autoScalingGroupNames': [
                'string',
            ],
            'roleArn': 'string',
            'healthCheckConfig': {
                'port': 123,
                'path': 'string',
                'protocol': 'HTTP'|'HTTPS',
                'timeoutMs': 123,
                'intervalSeconds': 123,
                'statusCodeMatcher': 'string',
                'healthyThresholdCount': 123,
                'unhealthyThresholdCount': 123
            }
        },
        'eksEndpoints': {
            'endpointsResourceName': 'string',
            'endpointsResourceNamespace': 'string',
            'clusterApiServerEndpointUri': 'string',
            'clusterApiServerCaCertificateChain': 'string',
            'clusterName': 'string',
            'roleArn': 'string'
        }
    },
    clientToken='string',
    description='string',
    tags={
        'string': 'string'
    },
    gatewayType='EXTERNAL'|'INTERNAL'
)

Parameters:

• vpcId (string) –

  [REQUIRED]

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

• subnetIds (list) –

  [REQUIRED]

  The unique identifiers of the subnets.

  • (string) –

• securityGroupIds (list) –

  [REQUIRED]

  The unique identifiers of the security groups.

  • (string) –

• domainName (string) – The domain name for the responder gateway.

• port (integer) –

  [REQUIRED]

  The networking port to use.

• protocol (string) –

  [REQUIRED]

  The networking protocol to use.

• listenerConfig (dict) –

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

  • protocols (list) – [REQUIRED]

    The protocol for connections from clients to the gateway

    • (string) –

• trustStoreConfiguration (dict) –

  The configuration of the trust store.

  • certificateAuthorityCertificates (list) – [REQUIRED]

    The certificate authority certificate.

    • (string) –

• managedEndpointConfiguration (dict) –

  The configuration for the managed endpoint.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: autoScalingGroups, eksEndpoints.

  • autoScalingGroups (dict) –

    Describes the configuration of an auto scaling group.

    • autoScalingGroupNames (list) – [REQUIRED]

      The names of the auto scaling group.

      • (string) –

    • roleArn (string) – [REQUIRED]

      The role ARN of the auto scaling group.

    • healthCheckConfig (dict) –

      The health check configuration for the Auto Scaling group managed endpoint.

      • port (integer) – [REQUIRED]

        The port to use for health check probes. Valid range is 80 to 65535.

      • path (string) – [REQUIRED]

        The destination path for the health check request. Must start with /.

      • protocol (string) –

        The protocol to use for health check probes.

      • timeoutMs (integer) –

        The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

      • intervalSeconds (integer) –

        The interval between health check probes, in seconds. Valid range is 5 to 60.

      • statusCodeMatcher (string) –

        The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

      • healthyThresholdCount (integer) –

        The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

      • unhealthyThresholdCount (integer) –

        The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

  • eksEndpoints (dict) –

    Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.

    • endpointsResourceName (string) – [REQUIRED]

      The name of the endpoint resource.

    • endpointsResourceNamespace (string) – [REQUIRED]

      The namespace of the endpoint resource.

    • clusterApiServerEndpointUri (string) – [REQUIRED]

      The URI of the cluster API server endpoint.

    • clusterApiServerCaCertificateChain (string) – [REQUIRED]

      The CA certificate chain of the cluster API server.

    • clusterName (string) – [REQUIRED]

      The name of the cluster.

    • roleArn (string) – [REQUIRED]

      The role ARN for the cluster.

• clientToken (string) –

  [REQUIRED]

  The unique client token.

  This field is autopopulated if not provided.

• description (string) – An optional description for the responder gateway.

• tags (dict) –

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

  • (string) –

    • (string) –

• gatewayType (string) – The type of gateway. Valid values are EXTERNAL or INTERNAL.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
    'listenerConfig': {
        'protocols': [
            'HTTP'|'HTTPS',
        ]
    },
    'externalInboundEndpoint': 'string'
}

Response Structure

• (dict) –

  • gatewayId (string) –

    The unique identifier of the gateway.

  • status (string) –

    The status of the request.

  • listenerConfig (dict) –

    The listener configuration for the responder gateway.

    • protocols (list) –

      The protocol for connections from clients to the gateway

      • (string) –

  • externalInboundEndpoint (string) –

    The external inbound endpoint for the responder gateway.

Exceptions

• RTBFabric.Client.exceptions.ServiceQuotaExceededException

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException