Skip to content

ApiGatewayProxyConfig

Source code in docs_src/capo_migration_hub_refactor_spaces/types/api_gateway_proxy_config.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class ApiGatewayProxyConfig(TypedDict, closed=True):
    proxy_url: NotRequired["capo_migration_hub_refactor_spaces.types.uri.Uri"]
    """<p>The endpoint URL of the API Gateway proxy. </p>"""
    api_gateway_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.api_gateway_id.ApiGatewayId"
    ]
    """<p>The resource ID of the API Gateway for the proxy. </p>"""
    vpc_link_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.vpc_link_id.VpcLinkId"
    ]
    """<p>The <code>VpcLink</code> ID of the API Gateway proxy. </p>"""
    nlb_arn: NotRequired["capo_migration_hub_refactor_spaces.types.nlb_arn.NlbArn"]
    """<p>The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy. </p>"""
    nlb_name: NotRequired["capo_migration_hub_refactor_spaces.types.nlb_name.NlbName"]
    """<p>The name of the Network Load Balancer that is configured by the API Gateway proxy. </p>"""
    endpoint_type: NotRequired[
        "capo_migration_hub_refactor_spaces.types.api_gateway_endpoint_type.ApiGatewayEndpointType"
    ]
    """<p>The type of API Gateway endpoint created. </p>"""
    stage_name: NotRequired[
        "capo_migration_hub_refactor_spaces.types.stage_name.StageName"
    ]
    """<p>The name of the API Gateway stage. The name defaults to <code>prod</code>. </p>"""

api_gateway_id instance-attribute 

api_gateway_id: NotRequired[ApiGatewayId]

The resource ID of the API Gateway for the proxy.

endpoint_type instance-attribute 

endpoint_type: NotRequired[ApiGatewayEndpointType]

The type of API Gateway endpoint created.

nlb_arn instance-attribute 

nlb_arn: NotRequired[NlbArn]

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

nlb_name instance-attribute 

nlb_name: NotRequired[NlbName]

The name of the Network Load Balancer that is configured by the API Gateway proxy.

proxy_url instance-attribute 

proxy_url: NotRequired[Uri]

The endpoint URL of the API Gateway proxy.

stage_name instance-attribute 

stage_name: NotRequired[StageName]

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

vpc_link_id: NotRequired[VpcLinkId]

The VpcLink ID of the API Gateway proxy.