software.amazon.awscdk.services.sam

Interface CfnHttpApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHttpApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-04-20T17:18:03.345Z")
 @Stability(value=Stable)
public interface CfnHttpApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnHttpApi`.

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnHttpApiProps.Builder A builder for CfnHttpApiProps
static class	CfnHttpApiProps.Jsii$Proxy An implementation for CfnHttpApiProps

Method Summary

Modifier and Type	Method and Description
static CfnHttpApiProps.Builder	builder()
default Object	getAccessLogSetting() `AWS::Serverless::HttpApi.AccessLogSetting`.
default Object	getAuth() `AWS::Serverless::HttpApi.Auth`.
default Object	getCorsConfiguration() `AWS::Serverless::HttpApi.CorsConfiguration`.
default Object	getDefaultRouteSettings() `AWS::Serverless::HttpApi.DefaultRouteSettings`.
default Object	getDefinitionBody() `AWS::Serverless::HttpApi.DefinitionBody`.
default Object	getDefinitionUri() `AWS::Serverless::HttpApi.DefinitionUri`.
default String	getDescription() `AWS::Serverless::HttpApi.Description`.
default Object	getDisableExecuteApiEndpoint() `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
default Object	getDomain() `AWS::Serverless::HttpApi.Domain`.
default Object	getFailOnWarnings() `AWS::Serverless::HttpApi.FailOnWarnings`.
default Object	getRouteSettings() `AWS::Serverless::HttpApi.RouteSettings`.
default String	getStageName() `AWS::Serverless::HttpApi.StageName`.
default Object	getStageVariables() `AWS::Serverless::HttpApi.StageVariables`.
default Map<String,String>	getTags() `AWS::Serverless::HttpApi.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessLogSetting

@Stability(value=Stable)
 @Nullable
default Object getAccessLogSetting()

`AWS::Serverless::HttpApi.AccessLogSetting`.

getAuth

@Stability(value=Stable)
 @Nullable
default Object getAuth()

`AWS::Serverless::HttpApi.Auth`.

getCorsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getCorsConfiguration()

`AWS::Serverless::HttpApi.CorsConfiguration`.

getDefaultRouteSettings

@Stability(value=Stable)
 @Nullable
default Object getDefaultRouteSettings()

`AWS::Serverless::HttpApi.DefaultRouteSettings`.

getDefinitionBody

@Stability(value=Stable)
 @Nullable
default Object getDefinitionBody()

`AWS::Serverless::HttpApi.DefinitionBody`.

getDefinitionUri

@Stability(value=Stable)
 @Nullable
default Object getDefinitionUri()

`AWS::Serverless::HttpApi.DefinitionUri`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Serverless::HttpApi.Description`.

getDisableExecuteApiEndpoint

@Stability(value=Stable)
 @Nullable
default Object getDisableExecuteApiEndpoint()

`AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.

getDomain

@Stability(value=Stable)
 @Nullable
default Object getDomain()

`AWS::Serverless::HttpApi.Domain`.

getFailOnWarnings

@Stability(value=Stable)
 @Nullable
default Object getFailOnWarnings()

`AWS::Serverless::HttpApi.FailOnWarnings`.

getRouteSettings

@Stability(value=Stable)
 @Nullable
default Object getRouteSettings()

`AWS::Serverless::HttpApi.RouteSettings`.

getStageName

@Stability(value=Stable)
 @Nullable
default String getStageName()

`AWS::Serverless::HttpApi.StageName`.

getStageVariables

@Stability(value=Stable)
 @Nullable
default Object getStageVariables()

`AWS::Serverless::HttpApi.StageVariables`.

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

`AWS::Serverless::HttpApi.Tags`.

builder

@Stability(value=Stable)
static CfnHttpApiProps.Builder builder()

Returns:

a CfnHttpApiProps.Builder of CfnHttpApiProps