CreateRestApiRequest ¶

class CreateRestApiRequest(TypedDict, closed=True):
    name: "capo_api_gateway.types.string.String"
    """<p>The name of the RestApi.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the RestApi.</p>"""
    version: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A version identifier for the API.</p>"""
    clone_from: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The ID of the RestApi that you want to clone from.</p>"""
    binary_media_types: NotRequired[
        "capo_api_gateway.types.list_of_string.ListOfString"
    ]
    """<p>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.</p>"""
    minimum_compression_size: NotRequired[
        "capo_api_gateway.types.nullable_integer.NullableInteger"
    ]
    """<p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>"""
    api_key_source: NotRequired[
        "capo_api_gateway.types.api_key_source_type.ApiKeySourceType"
    ]
    """<p>The source of the API key for metering requests according to a usage plan. Valid values are: <code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</p>"""
    endpoint_configuration: NotRequired[
        "capo_api_gateway.types.endpoint_configuration.EndpointConfiguration"
    ]
    """<p>The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API. </p>"""
    policy: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.</p>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>"""
    disable_execute_api_endpoint: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint</p>"""
    security_policy: NotRequired[
        "capo_api_gateway.types.security_policy.SecurityPolicy"
    ]
    """<p> The Transport Layer Security (TLS) version + cipher suite for this RestApi. </p>"""
    endpoint_access_mode: NotRequired[
        "capo_api_gateway.types.endpoint_access_mode.EndpointAccessMode"
    ]
    """<p> The endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with <code>SecurityPolicy_</code>.</p>"""