Skip to content
v2.277.0

CfnHttpApiProps Struct ​

Properties for defining a CfnHttpApi.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const authorizers: any;
declare const definitionBody: any;
const cfnHttpApiProps: sam.CfnHttpApiProps = {
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  auth: {
    authorizers: authorizers,
    defaultAuthorizer: 'defaultAuthorizer',
  },
  corsConfiguration: false,
  defaultRouteSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  definitionBody: definitionBody,
  definitionUri: 'definitionUri',
  description: 'description',
  disableExecuteApiEndpoint: false,
  domain: {
    certificateArn: 'certificateArn',
    domainName: 'domainName',

    // the properties below are optional
    basePath: 'basePath',
    endpointConfiguration: 'endpointConfiguration',
    mutualTlsAuthentication: {
      truststoreUri: 'truststoreUri',
      truststoreVersion: false,
    },
    route53: {
      distributedDomainName: 'distributedDomainName',
      evaluateTargetHealth: false,
      hostedZoneId: 'hostedZoneId',
      hostedZoneName: 'hostedZoneName',
      ipV6: false,
    },
    securityPolicy: 'securityPolicy',
  },
  failOnWarnings: false,
  routeSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  stageName: 'stageName',
  stageVariables: {
    stageVariablesKey: 'stageVariables',
  },
  tags: {
    tagsKey: 'tags',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
    }
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sam.*;

Object authorizers;
Object definitionBody;

CfnHttpApiProps cfnHttpApiProps = CfnHttpApiProps.builder()
        .accessLogSetting(AccessLogSettingProperty.builder()
                .destinationArn("destinationArn")
                .format("format")
                .build())
        .auth(HttpApiAuthProperty.builder()
                .authorizers(authorizers)
                .defaultAuthorizer("defaultAuthorizer")
                .build())
        .corsConfiguration(false)
        .defaultRouteSettings(RouteSettingsProperty.builder()
                .dataTraceEnabled(false)
                .detailedMetricsEnabled(false)
                .loggingLevel("loggingLevel")
                .throttlingBurstLimit(123)
                .throttlingRateLimit(123)
                .build())
        .definitionBody(definitionBody)
        .definitionUri("definitionUri")
        .description("description")
        .disableExecuteApiEndpoint(false)
        .domain(HttpApiDomainConfigurationProperty.builder()
                .certificateArn("certificateArn")
                .domainName("domainName")

                // the properties below are optional
                .basePath("basePath")
                .endpointConfiguration("endpointConfiguration")
                .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                        .truststoreUri("truststoreUri")
                        .truststoreVersion(false)
                        .build())
                .route53(Route53ConfigurationProperty.builder()
                        .distributedDomainName("distributedDomainName")
                        .evaluateTargetHealth(false)
                        .hostedZoneId("hostedZoneId")
                        .hostedZoneName("hostedZoneName")
                        .ipV6(false)
                        .build())
                .securityPolicy("securityPolicy")
                .build())
        .failOnWarnings(false)
        .routeSettings(RouteSettingsProperty.builder()
                .dataTraceEnabled(false)
                .detailedMetricsEnabled(false)
                .loggingLevel("loggingLevel")
                .throttlingBurstLimit(123)
                .throttlingRateLimit(123)
                .build())
        .stageName("stageName")
        .stageVariables(Map.of(
                "stageVariablesKey", "stageVariables"))
        .tags(Map.of(
                "tagsKey", "tags"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;

var authorizers;
var definitionBody;

var cfnHttpApiProps = new CfnHttpApiProps {
    AccessLogSetting = new AccessLogSettingProperty {
        DestinationArn = "destinationArn",
        Format = "format"
    },
    Auth = new HttpApiAuthProperty {
        Authorizers = authorizers,
        DefaultAuthorizer = "defaultAuthorizer"
    },
    CorsConfiguration = false,
    DefaultRouteSettings = new RouteSettingsProperty {
        DataTraceEnabled = false,
        DetailedMetricsEnabled = false,
        LoggingLevel = "loggingLevel",
        ThrottlingBurstLimit = 123,
        ThrottlingRateLimit = 123
    },
    DefinitionBody = definitionBody,
    DefinitionUri = "definitionUri",
    Description = "description",
    DisableExecuteApiEndpoint = false,
    Domain = new HttpApiDomainConfigurationProperty {
        CertificateArn = "certificateArn",
        DomainName = "domainName",

        // the properties below are optional
        BasePath = "basePath",
        EndpointConfiguration = "endpointConfiguration",
        MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
            TruststoreUri = "truststoreUri",
            TruststoreVersion = false
        },
        Route53 = new Route53ConfigurationProperty {
            DistributedDomainName = "distributedDomainName",
            EvaluateTargetHealth = false,
            HostedZoneId = "hostedZoneId",
            HostedZoneName = "hostedZoneName",
            IpV6 = false
        },
        SecurityPolicy = "securityPolicy"
    },
    FailOnWarnings = false,
    RouteSettings = new RouteSettingsProperty {
        DataTraceEnabled = false,
        DetailedMetricsEnabled = false,
        LoggingLevel = "loggingLevel",
        ThrottlingBurstLimit = 123,
        ThrottlingRateLimit = 123
    },
    StageName = "stageName",
    StageVariables = new Dictionary<string, string> {
        { "stageVariablesKey", "stageVariables" }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var authorizers interface{}
var definitionBody interface{}

cfnHttpApiProps := &CfnHttpApiProps{
	AccessLogSetting: &AccessLogSettingProperty{
		DestinationArn: jsii.String("destinationArn"),
		Format: jsii.String("format"),
	},
	Auth: &HttpApiAuthProperty{
		Authorizers: authorizers,
		DefaultAuthorizer: jsii.String("defaultAuthorizer"),
	},
	CorsConfiguration: jsii.Boolean(false),
	DefaultRouteSettings: &RouteSettingsProperty{
		DataTraceEnabled: jsii.Boolean(false),
		DetailedMetricsEnabled: jsii.Boolean(false),
		LoggingLevel: jsii.String("loggingLevel"),
		ThrottlingBurstLimit: jsii.Number(123),
		ThrottlingRateLimit: jsii.Number(123),
	},
	DefinitionBody: definitionBody,
	DefinitionUri: jsii.String("definitionUri"),
	Description: jsii.String("description"),
	DisableExecuteApiEndpoint: jsii.Boolean(false),
	Domain: &HttpApiDomainConfigurationProperty{
		CertificateArn: jsii.String("certificateArn"),
		DomainName: jsii.String("domainName"),

		// the properties below are optional
		BasePath: jsii.String("basePath"),
		EndpointConfiguration: jsii.String("endpointConfiguration"),
		MutualTlsAuthentication: &MutualTlsAuthenticationProperty{
			TruststoreUri: jsii.String("truststoreUri"),
			TruststoreVersion: jsii.Boolean(false),
		},
		Route53: &Route53ConfigurationProperty{
			DistributedDomainName: jsii.String("distributedDomainName"),
			EvaluateTargetHealth: jsii.Boolean(false),
			HostedZoneId: jsii.String("hostedZoneId"),
			HostedZoneName: jsii.String("hostedZoneName"),
			IpV6: jsii.Boolean(false),
		},
		SecurityPolicy: jsii.String("securityPolicy"),
	},
	FailOnWarnings: jsii.Boolean(false),
	RouteSettings: &RouteSettingsProperty{
		DataTraceEnabled: jsii.Boolean(false),
		DetailedMetricsEnabled: jsii.Boolean(false),
		LoggingLevel: jsii.String("loggingLevel"),
		ThrottlingBurstLimit: jsii.Number(123),
		ThrottlingRateLimit: jsii.Number(123),
	},
	StageName: jsii.String("stageName"),
	StageVariables: map[string]*string{
		"stageVariablesKey": jsii.String("stageVariables"),
	},
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Properties ​

accessLogSettingoptionalIResolvable | CfnHttpApi.AccessLogSettingPropertyaccess_log_settingoptionaltyping.Union[IResolvable, AccessLogSettingProperty]accessLogSettingoptionalIResolvableAccessLogSettingoptionalIResolvableAccessLogSettingoptionalinterface{}#
authoptionalIResolvable | CfnHttpApi.HttpApiAuthPropertyauthoptionaltyping.Union[IResolvable, HttpApiAuthProperty]authoptionalIResolvableAuthoptionalIResolvableAuthoptionalinterface{}#
corsConfigurationoptionalboolean | IResolvable | CfnHttpApi.CorsConfigurationObjectPropertycors_configurationoptionaltyping.Union[bool, IResolvable, CorsConfigurationObjectProperty]corsConfigurationoptionalBooleanCorsConfigurationoptionalboolCorsConfigurationoptionalinterface{}#
defaultRouteSettingsoptionalIResolvable | CfnHttpApi.RouteSettingsPropertydefault_route_settingsoptionaltyping.Union[IResolvable, RouteSettingsProperty]defaultRouteSettingsoptionalIResolvableDefaultRouteSettingsoptionalIResolvableDefaultRouteSettingsoptionalinterface{}#
definitionBodyoptionalanydefinition_bodyoptionalAnydefinitionBodyoptionalObjectDefinitionBodyoptionalobjectDefinitionBodyoptionalinterface{}#
definitionUrioptionalstring | IResolvable | CfnHttpApi.S3LocationPropertydefinition_urioptionaltyping.Union[str, IResolvable, S3LocationProperty]definitionUrioptionalStringDefinitionUrioptionalstringDefinitionUrioptionalinterface{}#
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
disableExecuteApiEndpointoptionalboolean | IResolvabledisable_execute_api_endpointoptionaltyping.Union[bool, IResolvable]disableExecuteApiEndpointoptionalBooleanDisableExecuteApiEndpointoptionalboolDisableExecuteApiEndpointoptionalinterface{}#
domainoptionalIResolvable | CfnHttpApi.HttpApiDomainConfigurationPropertydomainoptionaltyping.Union[IResolvable, HttpApiDomainConfigurationProperty]domainoptionalIResolvableDomainoptionalIResolvableDomainoptionalinterface{}#
failOnWarningsoptionalboolean | IResolvablefail_on_warningsoptionaltyping.Union[bool, IResolvable]failOnWarningsoptionalBooleanFailOnWarningsoptionalboolFailOnWarningsoptionalinterface{}#
routeSettingsoptionalIResolvable | CfnHttpApi.RouteSettingsPropertyroute_settingsoptionaltyping.Union[IResolvable, RouteSettingsProperty]routeSettingsoptionalIResolvableRouteSettingsoptionalIResolvableRouteSettingsoptionalinterface{}#
stageNameoptionalstringstage_nameoptionalstrstageNameoptionalStringStageNameoptionalstringStageNameoptional*string#
stageVariablesoptionalIResolvable | { [key: string]: string }stage_variablesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]stageVariablesoptionalIResolvableStageVariablesoptionalIResolvableStageVariablesoptionalinterface{}#
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#