CfnApiGatewayManagedOverridesPropsMixin

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiGatewayManagedOverridesPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create.

When you create an API by using quick create, an AWS::ApiGatewayV2::Route , AWS::ApiGatewayV2::Integration , and AWS::ApiGatewayV2::Stage are created for you and associated with your AWS::ApiGatewayV2::Api . The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html
CloudformationResource:: AWS::ApiGatewayV2::ApiGatewayManagedOverrides
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

# route_settings: Any
# stage_variables: Any

cfn_api_gateway_managed_overrides_props_mixin = apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin(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
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGatewayV2::ApiGatewayManagedOverrides.

Parameters:

props (Union[CfnApiGatewayManagedOverridesMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiId', 'integration', 'route', 'stage']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AccessLogSettingsProperty

class CfnApiGatewayManagedOverridesPropsMixin.AccessLogSettingsProperty(*, destination_arn=None, format=None)

Bases: object

The AccessLogSettings property overrides the access log settings for an API Gateway-managed stage.

Parameters:

destination_arn (Optional[str]) – The ARN of the CloudWatch Logs log group to receive access logs.
format (Optional[str]) – A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.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

access_log_settings_property = apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.AccessLogSettingsProperty(
    destination_arn="destinationArn",
    format="format"
)

Attributes

destination_arn

The ARN of the CloudWatch Logs log group to receive access logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings-destinationarn

format

A single line format of the access logs of data, as specified by selected $context variables.

The format must include at least $context.requestId.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings-format

IntegrationOverridesProperty

class CfnApiGatewayManagedOverridesPropsMixin.IntegrationOverridesProperty(*, description=None, integration_method=None, payload_format_version=None, timeout_in_millis=None)

Bases: object

The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration.

If you remove this property, API Gateway restores the default values.

Parameters:

description (Optional[str]) – The description of the integration.
integration_method (Optional[str]) – Specifies the integration’s HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
payload_format_version (Optional[str]) – Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
timeout_in_millis (Union[int, float, None]) – Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.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

integration_overrides_property = apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.IntegrationOverridesProperty(
    description="description",
    integration_method="integrationMethod",
    payload_format_version="payloadFormatVersion",
    timeout_in_millis=123
)

Attributes

description

The description of the integration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-description

integration_method

Specifies the integration’s HTTP method type.

For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-integrationmethod

payload_format_version

Specifies the format of the payload sent to an integration.

Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-payloadformatversion

timeout_in_millis

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-timeoutinmillis

RouteOverridesProperty

class CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty(*, authorization_scopes=None, authorization_type=None, authorizer_id=None, operation_name=None, target=None)

Bases: object

The RouteOverrides property overrides the route configuration for an API Gateway-managed route.

If you remove this property, API Gateway restores the default values.

Parameters:

authorization_scopes (Optional[Sequence[str]]) – The authorization scopes supported by this route.
authorization_type (Optional[str]) – The authorization type for the route. To learn more, see AuthorizationType .
authorizer_id (Optional[str]) – The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
operation_name (Optional[str]) – The operation name for the route.
target (Optional[str]) – For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.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_overrides_property = apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty(
    authorization_scopes=["authorizationScopes"],
    authorization_type="authorizationType",
    authorizer_id="authorizerId",
    operation_name="operationName",
    target="target"
)

Attributes

authorization_scopes

The authorization scopes supported by this route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationscopes

authorization_type

The authorization type for the route.

To learn more, see AuthorizationType .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationtype

authorizer_id

The identifier of the Authorizer resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizerid

operation_name

The operation name for the route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-operationname

target

For HTTP integrations, specify a fully qualified URL.

For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-target

RouteSettingsProperty

class CfnApiGatewayManagedOverridesPropsMixin.RouteSettingsProperty(*, data_trace_enabled=None, detailed_metrics_enabled=None, logging_level=None, throttling_burst_limit=None, throttling_rate_limit=None)

Bases: object

The RouteSettings property overrides the route settings for an API Gateway-managed route.

Parameters:

data_trace_enabled (Union[bool, IResolvable, None]) – Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
detailed_metrics_enabled (Union[bool, IResolvable, None]) – Specifies whether detailed metrics are enabled.
logging_level (Optional[str]) – Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
throttling_burst_limit (Union[int, float, None]) – Specifies the throttling burst limit.
throttling_rate_limit (Union[int, float, None]) – Specifies the throttling rate limit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.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_property = apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin.RouteSettingsProperty(
    data_trace_enabled=False,
    detailed_metrics_enabled=False,
    logging_level="loggingLevel",
    throttling_burst_limit=123,
    throttling_rate_limit=123
)

Attributes

data_trace_enabled

Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route.

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-datatraceenabled

detailed_metrics_enabled

Specifies whether detailed metrics are enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-detailedmetricsenabled

logging_level

INFO , ERROR , or OFF .

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-logginglevel
Type:: Specifies the logging level for this route

throttling_burst_limit

Specifies the throttling burst limit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-throttlingburstlimit

throttling_rate_limit

Specifies the throttling rate limit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-throttlingratelimit

StageOverridesProperty

class CfnApiGatewayManagedOverridesPropsMixin.StageOverridesProperty(*, access_log_settings=None, auto_deploy=None, default_route_settings=None, description=None, route_settings=None, stage_variables=None)

Bases: object

The StageOverrides property overrides the stage configuration for an API Gateway-managed stage.

If you remove this property, API Gateway restores the default values.

Parameters:

access_log_settings (Union[IResolvable, AccessLogSettingsProperty, Dict[str, Any], None]) – Settings for logging access in a stage.
auto_deploy (Union[bool, IResolvable, None]) – Specifies whether updates to an API automatically trigger a new deployment. The default value is true .
default_route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None]) – The default route settings for the stage.
description (Optional[str]) – The description for the API stage.
route_settings (Any) – Route settings for the stage.
stage_variables (Any) – A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.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

stage_overrides_property = 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
)