CfnApiGatewayManagedOverridesMixinProps

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiGatewayManagedOverridesMixinProps(*, api_id=None, integration=None, route=None, stage=None)

Bases: object

Properties for CfnApiGatewayManagedOverridesPropsMixin.

Parameters:

  • api_id (Optional[str]) – The ID of the API for which to override the configuration of API Gateway-managed resources.

  • integration (Union[IResolvable, IntegrationOverridesProperty, Dict[str, Any], None]) – Overrides the integration configuration for an API Gateway-managed integration.

  • route (Union[IResolvable, RouteOverridesProperty, Dict[str, Any], None]) – Overrides the route configuration for an API Gateway-managed route.

  • stage (Union[IResolvable, StageOverridesProperty, Dict[str, Any], None]) – Overrides the stage configuration for an API Gateway-managed stage.

See:

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.
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

# route_settings: Any
# stage_variables: Any

cfn_api_gateway_managed_overrides_mixin_props = apigatewayv2_mixins.CfnApiGatewayManagedOverridesMixinProps(
    api_id="apiId",
    integration=apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.IntegrationOverridesProperty(
        description="description",
        integration_method="integrationMethod",
        payload_format_version="payloadFormatVersion",
        timeout_in_millis=123
    ),
    route=apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty(
        authorization_scopes=["authorizationScopes"],
        authorization_type="authorizationType",
        authorizer_id="authorizerId",
        operation_name="operationName",
        target="target"
    ),
    stage=apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.StageOverridesProperty(
        access_log_settings=apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.AccessLogSettingsProperty(
            destination_arn="destinationArn",
            format="format"
        ),
        auto_deploy=False,
        default_route_settings=apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.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.

See:

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

integration

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

See:

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

route

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

See:

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

stage

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

See:

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