Package software.amazon.awscdk.services.sam

Class CfnApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sam.CfnApi

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:07.369Z")
@Stability(Stable)
public class CfnApi
extends software.amazon.awscdk.core.CfnResource
implements software.amazon.awscdk.core.IInspectable

A CloudFormation `AWS::Serverless::Api`.

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;
 CfnApi cfnApi = CfnApi.Builder.create(this, "MyCfnApi")
         .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	Class	Description
static interface	CfnApi.AccessLogSettingProperty	Example:
static interface	CfnApi.AuthProperty	Example:
static final class	CfnApi.Builder	A fluent builder for CfnApi.
static interface	CfnApi.CanarySettingProperty	Example:
static interface	CfnApi.CorsConfigurationProperty	Example:
static interface	CfnApi.DomainConfigurationProperty	Example:
static interface	CfnApi.EndpointConfigurationProperty	Example:
static interface	CfnApi.MutualTlsAuthenticationProperty	Example:
static interface	CfnApi.Route53ConfigurationProperty	Example:
static interface	CfnApi.S3LocationProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

software.amazon.awscdk.core.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
static final String	REQUIRED_TRANSFORM	The `Transform` a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApi(software.amazon.awscdk.core.Construct scope, String id, CfnApiProps props)	Create a new `AWS::Serverless::Api`.
protected	CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Object	getAccessLogSetting()	`AWS::Serverless::Api.AccessLogSetting`.
Object	getAuth()	`AWS::Serverless::Api.Auth`.
List<String>	getBinaryMediaTypes()	`AWS::Serverless::Api.BinaryMediaTypes`.
Object	getCacheClusterEnabled()	`AWS::Serverless::Api.CacheClusterEnabled`.
String	getCacheClusterSize()	`AWS::Serverless::Api.CacheClusterSize`.
Object	getCanarySetting()	`AWS::Serverless::Api.CanarySetting`.
protected Map<String,Object>	getCfnProperties()
Object	getCors()	`AWS::Serverless::Api.Cors`.
Object	getDefinitionBody()	`AWS::Serverless::Api.DefinitionBody`.
Object	getDefinitionUri()	`AWS::Serverless::Api.DefinitionUri`.
String	getDescription()	`AWS::Serverless::Api.Description`.
Object	getDisableExecuteApiEndpoint()	`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
Object	getDomain()	`AWS::Serverless::Api.Domain`.
Object	getEndpointConfiguration()	`AWS::Serverless::Api.EndpointConfiguration`.
Object	getGatewayResponses()	`AWS::Serverless::Api.GatewayResponses`.
Object	getMethodSettings()	`AWS::Serverless::Api.MethodSettings`.
Number	getMinimumCompressionSize()	`AWS::Serverless::Api.MinimumCompressionSize`.
Object	getModels()	`AWS::Serverless::Api.Models`.
String	getName()	`AWS::Serverless::Api.Name`.
String	getOpenApiVersion()	`AWS::Serverless::Api.OpenApiVersion`.
String	getStageName()	`AWS::Serverless::Api.StageName`.
software.amazon.awscdk.core.TagManager	getTags()	`AWS::Serverless::Api.Tags`.
Object	getTracingEnabled()	`AWS::Serverless::Api.TracingEnabled`.
Object	getVariables()	`AWS::Serverless::Api.Variables`.
void	inspect(software.amazon.awscdk.core.TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessLogSetting(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.AccessLogSetting`.
void	setAccessLogSetting(CfnApi.AccessLogSettingProperty value)	`AWS::Serverless::Api.AccessLogSetting`.
void	setAuth(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.Auth`.
void	setAuth(CfnApi.AuthProperty value)	`AWS::Serverless::Api.Auth`.
void	setBinaryMediaTypes(List<String> value)	`AWS::Serverless::Api.BinaryMediaTypes`.
void	setCacheClusterEnabled(Boolean value)	`AWS::Serverless::Api.CacheClusterEnabled`.
void	setCacheClusterEnabled(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.CacheClusterEnabled`.
void	setCacheClusterSize(String value)	`AWS::Serverless::Api.CacheClusterSize`.
void	setCanarySetting(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.CanarySetting`.
void	setCanarySetting(CfnApi.CanarySettingProperty value)	`AWS::Serverless::Api.CanarySetting`.
void	setCors(String value)	`AWS::Serverless::Api.Cors`.
void	setCors(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.Cors`.
void	setCors(CfnApi.CorsConfigurationProperty value)	`AWS::Serverless::Api.Cors`.
void	setDefinitionBody(Object value)	`AWS::Serverless::Api.DefinitionBody`.
void	setDefinitionUri(String value)	`AWS::Serverless::Api.DefinitionUri`.
void	setDefinitionUri(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.DefinitionUri`.
void	setDefinitionUri(CfnApi.S3LocationProperty value)	`AWS::Serverless::Api.DefinitionUri`.
void	setDescription(String value)	`AWS::Serverless::Api.Description`.
void	setDisableExecuteApiEndpoint(Boolean value)	`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
void	setDisableExecuteApiEndpoint(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
void	setDomain(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.Domain`.
void	setDomain(CfnApi.DomainConfigurationProperty value)	`AWS::Serverless::Api.Domain`.
void	setEndpointConfiguration(String value)	`AWS::Serverless::Api.EndpointConfiguration`.
void	setEndpointConfiguration(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.EndpointConfiguration`.
void	setEndpointConfiguration(CfnApi.EndpointConfigurationProperty value)	`AWS::Serverless::Api.EndpointConfiguration`.
void	setGatewayResponses(Object value)	`AWS::Serverless::Api.GatewayResponses`.
void	setMethodSettings(List<Object> value)	`AWS::Serverless::Api.MethodSettings`.
void	setMethodSettings(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.MethodSettings`.
void	setMinimumCompressionSize(Number value)	`AWS::Serverless::Api.MinimumCompressionSize`.
void	setModels(Object value)	`AWS::Serverless::Api.Models`.
void	setName(String value)	`AWS::Serverless::Api.Name`.
void	setOpenApiVersion(String value)	`AWS::Serverless::Api.OpenApiVersion`.
void	setStageName(String value)	`AWS::Serverless::Api.StageName`.
void	setTracingEnabled(Boolean value)	`AWS::Serverless::Api.TracingEnabled`.
void	setTracingEnabled(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.TracingEnabled`.
void	setVariables(Map<String,String> value)	`AWS::Serverless::Api.Variables`.
void	setVariables(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::Api.Variables`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(Stable)
public static final String REQUIRED_TRANSFORM

The `Transform` a template must use in order to use this resource.

Constructor Details

CfnApi

protected CfnApi(software.amazon.jsii.JsiiObjectRef objRef)

CfnApi

protected CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApi

@Stability(Stable)
public CfnApi(@NotNull
 software.amazon.awscdk.core.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApiProps props)

Create a new `AWS::Serverless::Api`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 software.amazon.awscdk.core.TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface software.amazon.awscdk.core.IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class software.amazon.awscdk.core.CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class software.amazon.awscdk.core.CfnResource

getTags

@Stability(Stable)
@NotNull
public software.amazon.awscdk.core.TagManager getTags()

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

getDefinitionBody

@Stability(Stable)
@NotNull
public Object getDefinitionBody()

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

setDefinitionBody

@Stability(Stable)
public void setDefinitionBody(@NotNull
 Object value)

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

getGatewayResponses

@Stability(Stable)
@NotNull
public Object getGatewayResponses()

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

setGatewayResponses

@Stability(Stable)
public void setGatewayResponses(@NotNull
 Object value)

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

getModels

@Stability(Stable)
@NotNull
public Object getModels()

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

setModels

@Stability(Stable)
public void setModels(@NotNull
 Object value)

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

getStageName

@Stability(Stable)
@NotNull
public String getStageName()

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

setStageName

@Stability(Stable)
public void setStageName(@NotNull
 String value)

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

getAccessLogSetting

@Stability(Stable)
@Nullable
public Object getAccessLogSetting()

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

setAccessLogSetting

@Stability(Stable)
public void setAccessLogSetting(@Nullable
 CfnApi.AccessLogSettingProperty value)

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

setAccessLogSetting

@Stability(Stable)
public void setAccessLogSetting(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

getAuth

@Stability(Stable)
@Nullable
public Object getAuth()

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

setAuth

@Stability(Stable)
public void setAuth(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setAuth

@Stability(Stable)
public void setAuth(@Nullable
 CfnApi.AuthProperty value)

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

getBinaryMediaTypes

@Stability(Stable)
@Nullable
public List<String> getBinaryMediaTypes()

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

setBinaryMediaTypes

@Stability(Stable)
public void setBinaryMediaTypes(@Nullable
 List<String> value)

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

getCacheClusterEnabled

@Stability(Stable)
@Nullable
public Object getCacheClusterEnabled()

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

setCacheClusterEnabled

@Stability(Stable)
public void setCacheClusterEnabled(@Nullable
 Boolean value)

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

setCacheClusterEnabled

@Stability(Stable)
public void setCacheClusterEnabled(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

getCacheClusterSize

@Stability(Stable)
@Nullable
public String getCacheClusterSize()

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

setCacheClusterSize

@Stability(Stable)
public void setCacheClusterSize(@Nullable
 String value)

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

getCanarySetting

@Stability(Stable)
@Nullable
public Object getCanarySetting()

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

setCanarySetting

@Stability(Stable)
public void setCanarySetting(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setCanarySetting

@Stability(Stable)
public void setCanarySetting(@Nullable
 CfnApi.CanarySettingProperty value)

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

getCors

@Stability(Stable)
@Nullable
public Object getCors()

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

setCors

@Stability(Stable)
public void setCors(@Nullable
 String value)

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

setCors

@Stability(Stable)
public void setCors(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setCors

@Stability(Stable)
public void setCors(@Nullable
 CfnApi.CorsConfigurationProperty value)

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

getDefinitionUri

@Stability(Stable)
@Nullable
public Object getDefinitionUri()

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

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 String value)

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

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 CfnApi.S3LocationProperty value)

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

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

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

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

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

getDisableExecuteApiEndpoint

@Stability(Stable)
@Nullable
public Object getDisableExecuteApiEndpoint()

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

setDisableExecuteApiEndpoint

@Stability(Stable)
public void setDisableExecuteApiEndpoint(@Nullable
 Boolean value)

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

setDisableExecuteApiEndpoint

@Stability(Stable)
public void setDisableExecuteApiEndpoint(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

getDomain

@Stability(Stable)
@Nullable
public Object getDomain()

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

setDomain

@Stability(Stable)
public void setDomain(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setDomain

@Stability(Stable)
public void setDomain(@Nullable
 CfnApi.DomainConfigurationProperty value)

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

getEndpointConfiguration

@Stability(Stable)
@Nullable
public Object getEndpointConfiguration()

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

setEndpointConfiguration

@Stability(Stable)
public void setEndpointConfiguration(@Nullable
 String value)

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

setEndpointConfiguration

@Stability(Stable)
public void setEndpointConfiguration(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setEndpointConfiguration

@Stability(Stable)
public void setEndpointConfiguration(@Nullable
 CfnApi.EndpointConfigurationProperty value)

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

getMethodSettings

@Stability(Stable)
@Nullable
public Object getMethodSettings()

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

setMethodSettings

@Stability(Stable)
public void setMethodSettings(@Nullable
 List<Object> value)

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

setMethodSettings

@Stability(Stable)
public void setMethodSettings(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

getMinimumCompressionSize

@Stability(Stable)
@Nullable
public Number getMinimumCompressionSize()

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

setMinimumCompressionSize

@Stability(Stable)
public void setMinimumCompressionSize(@Nullable
 Number value)

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

getName

@Stability(Stable)
@Nullable
public String getName()

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

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

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

getOpenApiVersion

@Stability(Stable)
@Nullable
public String getOpenApiVersion()

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

setOpenApiVersion

@Stability(Stable)
public void setOpenApiVersion(@Nullable
 String value)

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

getTracingEnabled

@Stability(Stable)
@Nullable
public Object getTracingEnabled()

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

setTracingEnabled

@Stability(Stable)
public void setTracingEnabled(@Nullable
 Boolean value)

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

setTracingEnabled

@Stability(Stable)
public void setTracingEnabled(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

getVariables

@Stability(Stable)
@Nullable
public Object getVariables()

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

setVariables

@Stability(Stable)
public void setVariables(@Nullable
 software.amazon.awscdk.core.IResolvable value)

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

setVariables

@Stability(Stable)
public void setVariables(@Nullable
 Map<String,String> value)

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