CfnHttpApiProps

class aws_cdk.aws_sam.CfnHttpApiProps(*, access_log_setting=None, auth=None, cors_configuration=None, default_route_settings=None, definition_body=None, definition_uri=None, description=None, disable_execute_api_endpoint=None, domain=None, fail_on_warnings=None, route_settings=None, stage_name=None, stage_variables=None, tags=None)

Bases: object

Properties for defining a CfnHttpApi.

Parameters
  • access_log_setting (Union[IResolvable, AccessLogSettingProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.AccessLogSetting.

  • auth (Union[IResolvable, HttpApiAuthProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.Auth.

  • cors_configuration (Union[bool, IResolvable, CorsConfigurationObjectProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.CorsConfiguration.

  • default_route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.DefaultRouteSettings.

  • definition_body (Optional[Any]) – AWS::Serverless::HttpApi.DefinitionBody.

  • definition_uri (Union[str, IResolvable, S3LocationProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.DefinitionUri.

  • description (Optional[str]) – AWS::Serverless::HttpApi.Description.

  • disable_execute_api_endpoint (Union[bool, IResolvable, None]) – AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.

  • domain (Union[IResolvable, HttpApiDomainConfigurationProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.Domain.

  • fail_on_warnings (Union[bool, IResolvable, None]) – AWS::Serverless::HttpApi.FailOnWarnings.

  • route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None]) – AWS::Serverless::HttpApi.RouteSettings.

  • stage_name (Optional[str]) – AWS::Serverless::HttpApi.StageName.

  • stage_variables (Union[IResolvable, Mapping[str, str], None]) – AWS::Serverless::HttpApi.StageVariables.

  • tags (Optional[Mapping[str, str]]) – AWS::Serverless::HttpApi.Tags.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

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_sam as sam

# authorizers: Any
# definition_body: Any

cfn_http_api_props = sam.CfnHttpApiProps(
    access_log_setting=sam.CfnHttpApi.AccessLogSettingProperty(
        destination_arn="destinationArn",
        format="format"
    ),
    auth=sam.CfnHttpApi.HttpApiAuthProperty(
        authorizers=authorizers,
        default_authorizer="defaultAuthorizer"
    ),
    cors_configuration=False,
    default_route_settings=sam.CfnHttpApi.RouteSettingsProperty(
        data_trace_enabled=False,
        detailed_metrics_enabled=False,
        logging_level="loggingLevel",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    ),
    definition_body=definition_body,
    definition_uri="definitionUri",
    description="description",
    disable_execute_api_endpoint=False,
    domain=sam.CfnHttpApi.HttpApiDomainConfigurationProperty(
        certificate_arn="certificateArn",
        domain_name="domainName",

        # the properties below are optional
        base_path="basePath",
        endpoint_configuration="endpointConfiguration",
        mutual_tls_authentication=sam.CfnHttpApi.MutualTlsAuthenticationProperty(
            truststore_uri="truststoreUri",
            truststore_version=False
        ),
        route53=sam.CfnHttpApi.Route53ConfigurationProperty(
            distributed_domain_name="distributedDomainName",
            evaluate_target_health=False,
            hosted_zone_id="hostedZoneId",
            hosted_zone_name="hostedZoneName",
            ip_v6=False
        ),
        security_policy="securityPolicy"
    ),
    fail_on_warnings=False,
    route_settings=sam.CfnHttpApi.RouteSettingsProperty(
        data_trace_enabled=False,
        detailed_metrics_enabled=False,
        logging_level="loggingLevel",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    ),
    stage_name="stageName",
    stage_variables={
        "stage_variables_key": "stageVariables"
    },
    tags={
        "tags_key": "tags"
    }
)

Attributes

access_log_setting

AWS::Serverless::HttpApi.AccessLogSetting.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, AccessLogSettingProperty, None]

auth

AWS::Serverless::HttpApi.Auth.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, HttpApiAuthProperty, None]

cors_configuration

AWS::Serverless::HttpApi.CorsConfiguration.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[bool, IResolvable, CorsConfigurationObjectProperty, None]

default_route_settings

AWS::Serverless::HttpApi.DefaultRouteSettings.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, RouteSettingsProperty, None]

definition_body

AWS::Serverless::HttpApi.DefinitionBody.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Any

definition_uri

AWS::Serverless::HttpApi.DefinitionUri.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[str, IResolvable, S3LocationProperty, None]

description

AWS::Serverless::HttpApi.Description.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Optional[str]

disable_execute_api_endpoint

AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-httpapi.html#sam-httpapi-disableexecuteapiendpoint

Return type

Union[bool, IResolvable, None]

domain

AWS::Serverless::HttpApi.Domain.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, HttpApiDomainConfigurationProperty, None]

fail_on_warnings

AWS::Serverless::HttpApi.FailOnWarnings.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[bool, IResolvable, None]

route_settings

AWS::Serverless::HttpApi.RouteSettings.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, RouteSettingsProperty, None]

stage_name

AWS::Serverless::HttpApi.StageName.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Optional[str]

stage_variables

AWS::Serverless::HttpApi.StageVariables.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Union[IResolvable, Mapping[str, str], None]

tags

AWS::Serverless::HttpApi.Tags.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

Optional[Mapping[str, str]]