RestApiBaseProps

class aws_cdk.aws_apigateway.RestApiBaseProps(*, cloud_watch_role=None, cloud_watch_role_removal_policy=None, deploy=None, deploy_options=None, description=None, disable_execute_api_endpoint=None, domain_name=None, endpoint_export_name=None, endpoint_types=None, fail_on_warnings=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None)

Bases: object

Represents the props that all Rest APIs share.

Parameters:

cloud_watch_role (Optional[bool]) – Automatically configure an AWS CloudWatch role for API Gateway. Default: - false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise
cloud_watch_role_removal_policy (Optional[RemovalPolicy]) – The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled. Default: - RemovalPolicy.RETAIN
deploy (Optional[bool]) – Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: true
deploy_options (Union[StageOptions, Dict[str, Any], None]) – Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled. If deploy is disabled, this value cannot be set. Default: - Based on defaults of StageOptions.
description (Optional[str]) – A description of the RestApi construct. Default: - ‘Automatically created by the RestApi construct’
disable_execute_api_endpoint (Optional[bool]) – Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
domain_name (Union[DomainNameOptions, Dict[str, Any], None]) – Configure a custom domain name and map it to this API. Default: - no domain name is defined, use addDomainName or directly define a DomainName.
endpoint_export_name (Optional[str]) – Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
endpoint_types (Optional[Sequence[EndpointType]]) – A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
fail_on_warnings (Optional[bool]) – Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
parameters (Optional[Mapping[str, str]]) – Custom header parameters for the request. Default: - No parameters.
policy (Optional[PolicyDocument]) – A policy document that contains the permissions for this RestApi. Default: - No policy.
rest_api_name (Optional[str]) – A name for the API Gateway RestApi resource. Default: - ID of the RestApi construct.
retain_deployments (Optional[bool]) – Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. Default: false

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 as cdk
from aws_cdk import aws_apigateway as apigateway
from aws_cdk import aws_certificatemanager as certificatemanager
from aws_cdk import aws_iam as iam
from aws_cdk import aws_s3 as s3

# access_log_destination: apigateway.IAccessLogDestination
# access_log_format: apigateway.AccessLogFormat
# bucket: s3.Bucket
# certificate: certificatemanager.Certificate
# policy_document: iam.PolicyDocument

rest_api_base_props = apigateway.RestApiBaseProps(
    cloud_watch_role=False,
    cloud_watch_role_removal_policy=cdk.RemovalPolicy.DESTROY,
    deploy=False,
    deploy_options=apigateway.StageOptions(
        access_log_destination=access_log_destination,
        access_log_format=access_log_format,
        cache_cluster_enabled=False,
        cache_cluster_size="cacheClusterSize",
        cache_data_encrypted=False,
        cache_ttl=cdk.Duration.minutes(30),
        caching_enabled=False,
        client_certificate_id="clientCertificateId",
        data_trace_enabled=False,
        description="description",
        documentation_version="documentationVersion",
        logging_level=apigateway.MethodLoggingLevel.OFF,
        method_options={
            "method_options_key": apigateway.MethodDeploymentOptions(
                cache_data_encrypted=False,
                cache_ttl=cdk.Duration.minutes(30),
                caching_enabled=False,
                data_trace_enabled=False,
                logging_level=apigateway.MethodLoggingLevel.OFF,
                metrics_enabled=False,
                throttling_burst_limit=123,
                throttling_rate_limit=123
            )
        },
        metrics_enabled=False,
        stage_name="stageName",
        throttling_burst_limit=123,
        throttling_rate_limit=123,
        tracing_enabled=False,
        variables={
            "variables_key": "variables"
        }
    ),
    description="description",
    disable_execute_api_endpoint=False,
    domain_name=apigateway.DomainNameOptions(
        certificate=certificate,
        domain_name="domainName",

        # the properties below are optional
        base_path="basePath",
        endpoint_type=apigateway.EndpointType.EDGE,
        mtls=apigateway.MTLSConfig(
            bucket=bucket,
            key="key",

            # the properties below are optional
            version="version"
        ),
        security_policy=apigateway.SecurityPolicy.TLS_1_0
    ),
    endpoint_export_name="endpointExportName",
    endpoint_types=[apigateway.EndpointType.EDGE],
    fail_on_warnings=False,
    parameters={
        "parameters_key": "parameters"
    },
    policy=policy_document,
    rest_api_name="restApiName",
    retain_deployments=False
)

Attributes

cloud_watch_role

Automatically configure an AWS CloudWatch role for API Gateway.

Default:

false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise

cloud_watch_role_removal_policy

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

Requires cloudWatchRole to be enabled.

Default:

RemovalPolicy.RETAIN

deploy

Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

Default:: true

deploy_options

Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.

If deploy is disabled, this value cannot be set.

Default:

Based on defaults of StageOptions.

description

A description of the RestApi construct.

Default:

‘Automatically created by the RestApi construct’

disable_execute_api_endpoint

Specifies whether clients can invoke the API using the default execute-api endpoint.

To require that clients use a custom domain name to invoke the API, disable the default endpoint.

Default:: false
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

domain_name

Configure a custom domain name and map it to this API.

Default:

no domain name is defined, use addDomainName or directly define a DomainName.

endpoint_export_name

Export name for the CfnOutput containing the API endpoint.

Default:

when no export name is given, output will be created without export

endpoint_types

A list of the endpoint types of the API.

Use this property when creating an API.

Default:: EndpointType.EDGE

fail_on_warnings

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Default:: false

parameters

Custom header parameters for the request.

Default:

No parameters.

See:

https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

policy

A policy document that contains the permissions for this RestApi.

Default:

No policy.

rest_api_name

A name for the API Gateway RestApi resource.

Default:

ID of the RestApi construct.

retain_deployments

Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.

Default:: false