Package software.amazon.awscdk.services.sam

Interface CfnApiProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnApiProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.587Z") @Stability(Stable) public interface CfnApiProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnApi.

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;
 Object gatewayResponses;
 Object methodSettings;
 Object models;
 CfnApiProps cfnApiProps = CfnApiProps.builder()
         .stageName("stageName")
         // the properties below are optional
         .accessLogSetting(AccessLogSettingProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .auth(AuthProperty.builder()
                 .addDefaultAuthorizerToCorsPreflight(false)
                 .authorizers(authorizers)
                 .defaultAuthorizer("defaultAuthorizer")
                 .build())
         .binaryMediaTypes(List.of("binaryMediaTypes"))
         .cacheClusterEnabled(false)
         .cacheClusterSize("cacheClusterSize")
         .canarySetting(CanarySettingProperty.builder()
                 .deploymentId("deploymentId")
                 .percentTraffic(123)
                 .stageVariableOverrides(Map.of(
                         "stageVariableOverridesKey", "stageVariableOverrides"))
                 .useStageCache(false)
                 .build())
         .cors("cors")
         .definitionBody(definitionBody)
         .definitionUri("definitionUri")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .domain(DomainConfigurationProperty.builder()
                 .certificateArn("certificateArn")
                 .domainName("domainName")
                 // the properties below are optional
                 .basePath(List.of("basePath"))
                 .endpointConfiguration("endpointConfiguration")
                 .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                         .truststoreUri("truststoreUri")
                         .truststoreVersion("truststoreVersion")
                         .build())
                 .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
                 .route53(Route53ConfigurationProperty.builder()
                         .distributedDomainName("distributedDomainName")
                         .evaluateTargetHealth(false)
                         .hostedZoneId("hostedZoneId")
                         .hostedZoneName("hostedZoneName")
                         .ipV6(false)
                         .build())
                 .securityPolicy("securityPolicy")
                 .build())
         .endpointConfiguration("endpointConfiguration")
         .gatewayResponses(gatewayResponses)
         .methodSettings(List.of(methodSettings))
         .minimumCompressionSize(123)
         .models(models)
         .name("name")
         .openApiVersion("openApiVersion")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .tracingEnabled(false)
         .variables(Map.of(
                 "variablesKey", "variables"))
         .build();

  • Method Details

    • getStageName

      @Stability(Stable) @NotNull String getStageName()
      AWS::Serverless::Api.StageName.

    • getAccessLogSetting

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

    • getAuth

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

    • getBinaryMediaTypes

      @Stability(Stable) @Nullable default List<String> getBinaryMediaTypes()
      AWS::Serverless::Api.BinaryMediaTypes.

    • getCacheClusterEnabled

      @Stability(Stable) @Nullable default Object getCacheClusterEnabled()
      AWS::Serverless::Api.CacheClusterEnabled.

    • getCacheClusterSize

      @Stability(Stable) @Nullable default String getCacheClusterSize()
      AWS::Serverless::Api.CacheClusterSize.

    • getCanarySetting

      @Stability(Stable) @Nullable default Object getCanarySetting()
      AWS::Serverless::Api.CanarySetting.

    • getCors

      @Stability(Stable) @Nullable default Object getCors()
      AWS::Serverless::Api.Cors.

    • getDefinitionBody

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

    • getDefinitionUri

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

    • getDescription

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

    • getDisableExecuteApiEndpoint

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

    • getDomain

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

    • getEndpointConfiguration

      @Stability(Stable) @Nullable default Object getEndpointConfiguration()
      AWS::Serverless::Api.EndpointConfiguration.

    • getGatewayResponses

      @Stability(Stable) @Nullable default Object getGatewayResponses()
      AWS::Serverless::Api.GatewayResponses.

    • getMethodSettings

      @Stability(Stable) @Nullable default Object getMethodSettings()
      AWS::Serverless::Api.MethodSettings.

    • getMinimumCompressionSize

      @Stability(Stable) @Nullable default Number getMinimumCompressionSize()
      AWS::Serverless::Api.MinimumCompressionSize.

    • getModels

      @Stability(Stable) @Nullable default Object getModels()
      AWS::Serverless::Api.Models.

    • getName

      @Stability(Stable) @Nullable default String getName()
      AWS::Serverless::Api.Name.

    • getOpenApiVersion

      @Stability(Stable) @Nullable default String getOpenApiVersion()
      AWS::Serverless::Api.OpenApiVersion.

    • getTags

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

    • getTracingEnabled

      @Stability(Stable) @Nullable default Object getTracingEnabled()
      AWS::Serverless::Api.TracingEnabled.

    • getVariables

      @Stability(Stable) @Nullable default Object getVariables()
      AWS::Serverless::Api.Variables.

    • builder

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