software.amazon.awscdk.services.sam

Interface CfnHttpApiProps

All Known Implementing Classes:

CfnHttpApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:27.972Z")
public interface CfnHttpApiProps

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 java.lang.Object	getAccessLogSetting() `AWS::Serverless::HttpApi.AccessLogSetting`.
default java.lang.Object	getAuth() `AWS::Serverless::HttpApi.Auth`.
default java.lang.Object	getCorsConfiguration() `AWS::Serverless::HttpApi.CorsConfiguration`.
default java.lang.Object	getDefaultRouteSettings() `AWS::Serverless::HttpApi.DefaultRouteSettings`.
default java.lang.Object	getDefinitionBody() `AWS::Serverless::HttpApi.DefinitionBody`.
default java.lang.Object	getDefinitionUri() `AWS::Serverless::HttpApi.DefinitionUri`.
default java.lang.String	getDescription() `AWS::Serverless::HttpApi.Description`.
default java.lang.Object	getDisableExecuteApiEndpoint() `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.
default java.lang.Object	getDomain() `AWS::Serverless::HttpApi.Domain`.
default java.lang.Object	getFailOnWarnings() `AWS::Serverless::HttpApi.FailOnWarnings`.
default java.lang.Object	getRouteSettings() `AWS::Serverless::HttpApi.RouteSettings`.
default java.lang.String	getStageName() `AWS::Serverless::HttpApi.StageName`.
default java.lang.Object	getStageVariables() `AWS::Serverless::HttpApi.StageVariables`.
default java.util.Map<java.lang.String,java.lang.String>	getTags() `AWS::Serverless::HttpApi.Tags`.

Method Detail

getAccessLogSetting

default java.lang.Object getAccessLogSetting()

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

getAuth

default java.lang.Object getAuth()

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

getCorsConfiguration

default java.lang.Object getCorsConfiguration()

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

getDefaultRouteSettings

default java.lang.Object getDefaultRouteSettings()

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

getDefinitionBody

default java.lang.Object getDefinitionBody()

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

getDefinitionUri

default java.lang.Object getDefinitionUri()

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

getDescription

default java.lang.String getDescription()

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

getDisableExecuteApiEndpoint

default java.lang.Object getDisableExecuteApiEndpoint()

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

getDomain

default java.lang.Object getDomain()

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

getFailOnWarnings

default java.lang.Object getFailOnWarnings()

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

getRouteSettings

default java.lang.Object getRouteSettings()

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

getStageName

default java.lang.String getStageName()

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

getStageVariables

default java.lang.Object getStageVariables()

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

getTags

default java.util.Map<java.lang.String,java.lang.String> getTags()

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

builder

static CfnHttpApiProps.Builder builder()

Returns:

a CfnHttpApiProps.Builder of CfnHttpApiProps