Skip to content

CreateDeploymentRequest

Source code in docs_src/capo_api_gateway/types/create_deployment_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class CreateDeploymentRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    stage_name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of the Stage resource for the Deployment resource to create.</p>"""
    stage_description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the Stage resource for the Deployment resource to create.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description for the Deployment resource to create.</p>"""
    cache_cluster_enabled: NotRequired[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Enables a cache cluster for the Stage resource specified in the input.</p>"""
    cache_cluster_size: NotRequired[
        "capo_api_gateway.types.cache_cluster_size.CacheClusterSize"
    ]
    """<p>The stage's cache capacity in GB. For more information about choosing a cache size, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html">Enabling API caching to enhance responsiveness</a>.</p>"""
    variables: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>"""
    canary_settings: NotRequired[
        "capo_api_gateway.types.deployment_canary_settings.DeploymentCanarySettings"
    ]
    """<p>The input configuration for the canary deployment when the deployment is a canary release deployment. </p>"""
    tracing_enabled: NotRequired[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>"""

cache_cluster_enabled instance-attribute 

cache_cluster_enabled: NotRequired[NullableBoolean]

Enables a cache cluster for the Stage resource specified in the input.

cache_cluster_size instance-attribute 

cache_cluster_size: NotRequired[CacheClusterSize]

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

canary_settings instance-attribute 

canary_settings: NotRequired[DeploymentCanarySettings]

The input configuration for the canary deployment when the deployment is a canary release deployment.

description instance-attribute 

description: NotRequired[String]

The description for the Deployment resource to create.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.

stage_description instance-attribute 

stage_description: NotRequired[String]

The description of the Stage resource for the Deployment resource to create.

stage_name instance-attribute 

stage_name: NotRequired[String]

The name of the Stage resource for the Deployment resource to create.

tracing_enabled instance-attribute 

tracing_enabled: NotRequired[NullableBoolean]

Specifies whether active tracing with X-ray is enabled for the Stage.

variables instance-attribute 

variables: NotRequired[MapOfStringToString]

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.