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.74.0 (build 6d08790)",
           date="2023-04-27T09:48:13.798Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApiProps.Builder	builder()
default Object	getAccessLogSetting() `AWS::Serverless::Api.AccessLogSetting`.
default Object	getAuth() `AWS::Serverless::Api.Auth`.
default List<String>	getBinaryMediaTypes() `AWS::Serverless::Api.BinaryMediaTypes`.
default Object	getCacheClusterEnabled() `AWS::Serverless::Api.CacheClusterEnabled`.
default String	getCacheClusterSize() `AWS::Serverless::Api.CacheClusterSize`.
default Object	getCanarySetting() `AWS::Serverless::Api.CanarySetting`.
default Object	getCors() `AWS::Serverless::Api.Cors`.
default Object	getDefinitionBody() `AWS::Serverless::Api.DefinitionBody`.
default Object	getDefinitionUri() `AWS::Serverless::Api.DefinitionUri`.
default String	getDescription() `AWS::Serverless::Api.Description`.
default Object	getDisableExecuteApiEndpoint() `AWS::Serverless::Api.DisableExecuteApiEndpoint`.
default Object	getDomain() `AWS::Serverless::Api.Domain`.
default Object	getEndpointConfiguration() `AWS::Serverless::Api.EndpointConfiguration`.
default Object	getGatewayResponses() `AWS::Serverless::Api.GatewayResponses`.
default Object	getMethodSettings() `AWS::Serverless::Api.MethodSettings`.
default Number	getMinimumCompressionSize() `AWS::Serverless::Api.MinimumCompressionSize`.
default Object	getModels() `AWS::Serverless::Api.Models`.
default String	getName() `AWS::Serverless::Api.Name`.
default String	getOpenApiVersion() `AWS::Serverless::Api.OpenApiVersion`.
String	getStageName() `AWS::Serverless::Api.StageName`.
default Map<String,String>	getTags() `AWS::Serverless::Api.Tags`.
default Object	getTracingEnabled() `AWS::Serverless::Api.TracingEnabled`.
default Object	getVariables() `AWS::Serverless::Api.Variables`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStageName

@Stability(value=Stable)
 @NotNull
String getStageName()

`AWS::Serverless::Api.StageName`.

getAccessLogSetting

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

`AWS::Serverless::Api.AccessLogSetting`.

getAuth

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

`AWS::Serverless::Api.Auth`.

getBinaryMediaTypes

@Stability(value=Stable)
 @Nullable
default List<String> getBinaryMediaTypes()

`AWS::Serverless::Api.BinaryMediaTypes`.

getCacheClusterEnabled

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

`AWS::Serverless::Api.CacheClusterEnabled`.

getCacheClusterSize

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

`AWS::Serverless::Api.CacheClusterSize`.

getCanarySetting

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

`AWS::Serverless::Api.CanarySetting`.

getCors

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

`AWS::Serverless::Api.Cors`.

getDefinitionBody

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

`AWS::Serverless::Api.DefinitionBody`.

getDefinitionUri

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

`AWS::Serverless::Api.DefinitionUri`.

getDescription

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

`AWS::Serverless::Api.Description`.

getDisableExecuteApiEndpoint

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

`AWS::Serverless::Api.DisableExecuteApiEndpoint`.

getDomain

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

`AWS::Serverless::Api.Domain`.

getEndpointConfiguration

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

`AWS::Serverless::Api.EndpointConfiguration`.

getGatewayResponses

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

`AWS::Serverless::Api.GatewayResponses`.

getMethodSettings

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

`AWS::Serverless::Api.MethodSettings`.

getMinimumCompressionSize

@Stability(value=Stable)
 @Nullable
default Number getMinimumCompressionSize()

`AWS::Serverless::Api.MinimumCompressionSize`.

getModels

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

`AWS::Serverless::Api.Models`.

getName

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

`AWS::Serverless::Api.Name`.

getOpenApiVersion

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

`AWS::Serverless::Api.OpenApiVersion`.

getTags

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

`AWS::Serverless::Api.Tags`.

getTracingEnabled

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

`AWS::Serverless::Api.TracingEnabled`.

getVariables

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

`AWS::Serverless::Api.Variables`.

builder

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

Returns:

a CfnApiProps.Builder of CfnApiProps