CfnApiGatewayManagedOverridesProps

class aws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverridesProps(*, api_id, integration=None, route=None, stage=None)

Bases: object

Properties for defining a CfnApiGatewayManagedOverrides.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# route_settings is of type object
# stage_variables is of type object

cfn_api_gateway_managed_overrides_props = apigatewayv2.CfnApiGatewayManagedOverridesProps(
    api_id="apiId",

    # the properties below are optional
    integration=apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty(
        description="description",
        integration_method="integrationMethod",
        payload_format_version="payloadFormatVersion",
        timeout_in_millis=123
    ),
    route=apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty(
        authorization_scopes=["authorizationScopes"],
        authorization_type="authorizationType",
        authorizer_id="authorizerId",
        operation_name="operationName",
        target="target"
    ),
    stage=apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty(
        access_log_settings=apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty(
            destination_arn="destinationArn",
            format="format"
        ),
        auto_deploy=False,
        default_route_settings=apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty(
            data_trace_enabled=False,
            detailed_metrics_enabled=False,
            logging_level="loggingLevel",
            throttling_burst_limit=123,
            throttling_rate_limit=123
        ),
        description="description",
        route_settings=route_settings,
        stage_variables=stage_variables
    )
)

Attributes

api_id

The ID of the API for which to override the configuration of API Gateway-managed resources.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-apiid

Return type

str

integration

Overrides the integration configuration for an API Gateway-managed integration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integration

Return type

Union[IntegrationOverridesProperty, IResolvable, None]

route

Overrides the route configuration for an API Gateway-managed route.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-route

Return type

Union[IResolvable, RouteOverridesProperty, None]

stage

Overrides the stage configuration for an API Gateway-managed stage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stage

Return type

Union[IResolvable, StageOverridesProperty, None]