@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:29:00.472Z")
public interface CfnApiProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnApiProps.Builder
A builder for
CfnApiProps |
static class |
CfnApiProps.Jsii$Proxy
An implementation for
CfnApiProps |
Modifier and Type | Method and Description |
---|---|
static CfnApiProps.Builder |
builder() |
default java.lang.Object |
getAccessLogSetting()
`AWS::Serverless::Api.AccessLogSetting`.
|
default java.lang.Object |
getAuth()
`AWS::Serverless::Api.Auth`.
|
default java.util.List<java.lang.String> |
getBinaryMediaTypes()
`AWS::Serverless::Api.BinaryMediaTypes`.
|
default java.lang.Object |
getCacheClusterEnabled()
`AWS::Serverless::Api.CacheClusterEnabled`.
|
default java.lang.String |
getCacheClusterSize()
`AWS::Serverless::Api.CacheClusterSize`.
|
default java.lang.Object |
getCanarySetting()
`AWS::Serverless::Api.CanarySetting`.
|
default java.lang.Object |
getCors()
`AWS::Serverless::Api.Cors`.
|
default java.lang.Object |
getDefinitionBody()
`AWS::Serverless::Api.DefinitionBody`.
|
default java.lang.Object |
getDefinitionUri()
`AWS::Serverless::Api.DefinitionUri`.
|
default java.lang.String |
getDescription()
`AWS::Serverless::Api.Description`.
|
default java.lang.Object |
getDisableExecuteApiEndpoint()
`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
|
default java.lang.Object |
getDomain()
`AWS::Serverless::Api.Domain`.
|
default java.lang.Object |
getEndpointConfiguration()
`AWS::Serverless::Api.EndpointConfiguration`.
|
default java.lang.Object |
getGatewayResponses()
`AWS::Serverless::Api.GatewayResponses`.
|
default java.lang.Object |
getMethodSettings()
`AWS::Serverless::Api.MethodSettings`.
|
default java.lang.Number |
getMinimumCompressionSize()
`AWS::Serverless::Api.MinimumCompressionSize`.
|
default java.lang.Object |
getModels()
`AWS::Serverless::Api.Models`.
|
default java.lang.String |
getName()
`AWS::Serverless::Api.Name`.
|
default java.lang.String |
getOpenApiVersion()
`AWS::Serverless::Api.OpenApiVersion`.
|
java.lang.String |
getStageName()
`AWS::Serverless::Api.StageName`.
|
default java.util.Map<java.lang.String,java.lang.String> |
getTags()
`AWS::Serverless::Api.Tags`.
|
default java.lang.Object |
getTracingEnabled()
`AWS::Serverless::Api.TracingEnabled`.
|
default java.lang.Object |
getVariables()
`AWS::Serverless::Api.Variables`.
|
java.lang.String getStageName()
default java.lang.Object getAccessLogSetting()
default java.lang.Object getAuth()
default java.util.List<java.lang.String> getBinaryMediaTypes()
default java.lang.Object getCacheClusterEnabled()
default java.lang.String getCacheClusterSize()
default java.lang.Object getCanarySetting()
default java.lang.Object getCors()
default java.lang.Object getDefinitionBody()
default java.lang.Object getDefinitionUri()
default java.lang.String getDescription()
default java.lang.Object getDisableExecuteApiEndpoint()
default java.lang.Object getDomain()
default java.lang.Object getEndpointConfiguration()
default java.lang.Object getGatewayResponses()
default java.lang.Object getMethodSettings()
default java.lang.Number getMinimumCompressionSize()
default java.lang.Object getModels()
default java.lang.String getName()
default java.lang.String getOpenApiVersion()
default java.util.Map<java.lang.String,java.lang.String> getTags()
default java.lang.Object getTracingEnabled()
default java.lang.Object getVariables()
static CfnApiProps.Builder builder()
CfnApiProps.Builder
of CfnApiProps