Class CfnApi
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sam.CfnApi
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:16.740Z")
@Stability(Stable)
public class CfnApi
extends CfnResource
implements IInspectable, ITaggable
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi.
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()) .alwaysDeploy(false) .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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Example:static interface
Example:static final class
A fluent builder forCfnApi
.static interface
Example:static interface
Example:static interface
Example:static interface
Example:static interface
Example:static interface
Example:static interface
Example:Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
CfnApi
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnApi
(software.amazon.jsii.JsiiObjectRef objRef) CfnApi
(software.constructs.Construct scope, String id, CfnApiProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetAuth()
getCors()
getName()
getTags()
Tag Manager which manages the tags for this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAccessLogSetting
(IResolvable value) void
void
setAlwaysDeploy
(Boolean value) void
setAlwaysDeploy
(IResolvable value) void
setAuth
(IResolvable value) void
setAuth
(CfnApi.AuthProperty value) void
setBinaryMediaTypes
(List<String> value) void
setCacheClusterEnabled
(Boolean value) void
void
setCacheClusterSize
(String value) void
setCanarySetting
(IResolvable value) void
void
void
setCors
(IResolvable value) void
void
setDefinitionBody
(Object value) void
setDefinitionUri
(String value) void
setDefinitionUri
(IResolvable value) void
void
setDescription
(String value) void
void
void
setDomain
(IResolvable value) void
void
setEndpointConfiguration
(String value) void
void
void
setGatewayResponses
(Object value) void
setMethodSettings
(List<Object> value) void
setMethodSettings
(IResolvable value) void
setMinimumCompressionSize
(Number value) void
void
void
setOpenApiVersion
(String value) void
setStageName
(String value) void
setTagsRaw
(Map<String, String> value) void
setTracingEnabled
(Boolean value) void
setTracingEnabled
(IResolvable value) void
setVariables
(Map<String, String> value) void
setVariables
(IResolvable value) Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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
The CloudFormation resource type name for this resource class. -
REQUIRED_TRANSFORM
TheTransform
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.constructs.Construct scope, @NotNull String id, @NotNull CfnApiProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getStageName
-
setStageName
-
getAccessLogSetting
-
setAccessLogSetting
-
setAccessLogSetting
-
getAlwaysDeploy
-
setAlwaysDeploy
-
setAlwaysDeploy
-
getAuth
-
setAuth
-
setAuth
-
getBinaryMediaTypes
-
setBinaryMediaTypes
-
getCacheClusterEnabled
-
setCacheClusterEnabled
-
setCacheClusterEnabled
-
getCacheClusterSize
-
setCacheClusterSize
-
getCanarySetting
-
setCanarySetting
-
setCanarySetting
-
getCors
-
setCors
-
setCors
-
setCors
-
getDefinitionBody
-
setDefinitionBody
-
getDefinitionUri
-
setDefinitionUri
-
setDefinitionUri
-
setDefinitionUri
-
getDescription
-
setDescription
-
getDisableExecuteApiEndpoint
-
setDisableExecuteApiEndpoint
-
setDisableExecuteApiEndpoint
-
getDomain
-
setDomain
-
setDomain
-
getEndpointConfiguration
-
setEndpointConfiguration
-
setEndpointConfiguration
-
setEndpointConfiguration
@Stability(Stable) public void setEndpointConfiguration(@Nullable CfnApi.EndpointConfigurationProperty value) -
getGatewayResponses
-
setGatewayResponses
-
getMethodSettings
-
setMethodSettings
-
setMethodSettings
-
getMinimumCompressionSize
-
setMinimumCompressionSize
-
getModels
-
setModels
-
getName
-
setName
-
getOpenApiVersion
-
setOpenApiVersion
-
getTagsRaw
-
setTagsRaw
-
getTracingEnabled
-
setTracingEnabled
-
setTracingEnabled
-
getVariables
-
setVariables
-
setVariables
-