Package 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-05-31T18:44:07.462Z") @Stability(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();

  • Method Details

    • getAccessLogSetting

      @Stability(Stable) @Nullable default Object getAccessLogSetting()
      `AWS::Serverless::HttpApi.AccessLogSetting`.

    • getAuth

      @Stability(Stable) @Nullable default Object getAuth()
      `AWS::Serverless::HttpApi.Auth`.

    • getCorsConfiguration

      @Stability(Stable) @Nullable default Object getCorsConfiguration()
      `AWS::Serverless::HttpApi.CorsConfiguration`.

    • getDefaultRouteSettings

      @Stability(Stable) @Nullable default Object getDefaultRouteSettings()
      `AWS::Serverless::HttpApi.DefaultRouteSettings`.

    • getDefinitionBody

      @Stability(Stable) @Nullable default Object getDefinitionBody()
      `AWS::Serverless::HttpApi.DefinitionBody`.

    • getDefinitionUri

      @Stability(Stable) @Nullable default Object getDefinitionUri()
      `AWS::Serverless::HttpApi.DefinitionUri`.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      `AWS::Serverless::HttpApi.Description`.

    • getDisableExecuteApiEndpoint

      @Stability(Stable) @Nullable default Object getDisableExecuteApiEndpoint()
      `AWS::Serverless::HttpApi.DisableExecuteApiEndpoint`.

    • getDomain

      @Stability(Stable) @Nullable default Object getDomain()
      `AWS::Serverless::HttpApi.Domain`.

    • getFailOnWarnings

      @Stability(Stable) @Nullable default Object getFailOnWarnings()
      `AWS::Serverless::HttpApi.FailOnWarnings`.

    • getRouteSettings

      @Stability(Stable) @Nullable default Object getRouteSettings()
      `AWS::Serverless::HttpApi.RouteSettings`.

    • getStageName

      @Stability(Stable) @Nullable default String getStageName()
      `AWS::Serverless::HttpApi.StageName`.

    • getStageVariables

      @Stability(Stable) @Nullable default Object getStageVariables()
      `AWS::Serverless::HttpApi.StageVariables`.

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      `AWS::Serverless::HttpApi.Tags`.

    • builder

      @Stability(Stable) static CfnHttpApiProps.Builder builder()
      Returns:
      a CfnHttpApiProps.Builder of CfnHttpApiProps