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',
    trustStoreConfiguration={
        'certificateAuthorityCertificates': [
            'string',
        ]
    },
    managedEndpointConfiguration={
        'autoScalingGroups': {
            'autoScalingGroupNames': [
                'string',
            ],
            'roleArn': 'string'
        },
        'eksEndpoints': {
            'endpointsResourceName': 'string',
            'endpointsResourceNamespace': 'string',
            'clusterApiServerEndpointUri': 'string',
            'clusterApiServerCaCertificateChain': 'string',
            'clusterName': 'string',
            'roleArn': 'string'
        }
    },
    clientToken='string',
    description='string',
    tags={
        'string': 'string'
    }
)
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.

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

    • 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) –

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}

Response Structure

  • (dict) –

    • gatewayId (string) –

      The unique identifier of the gateway.

    • status (string) –

      The status of the request.

Exceptions