@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:25.642Z") public class CfnApi extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnApi.AccessLogSettingProperty
Example:
|
static interface |
CfnApi.AuthProperty
Example:
|
static 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:
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
static java.lang.String |
REQUIRED_TRANSFORM
The `Transform` a template must use in order to use this resource.
|
Modifier | Constructor and Description |
---|---|
|
CfnApi(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAccessLogSetting()
`AWS::Serverless::Api.AccessLogSetting`.
|
java.lang.Object |
getAuth()
`AWS::Serverless::Api.Auth`.
|
java.util.List<java.lang.String> |
getBinaryMediaTypes()
`AWS::Serverless::Api.BinaryMediaTypes`.
|
java.lang.Object |
getCacheClusterEnabled()
`AWS::Serverless::Api.CacheClusterEnabled`.
|
java.lang.String |
getCacheClusterSize()
`AWS::Serverless::Api.CacheClusterSize`.
|
java.lang.Object |
getCanarySetting()
`AWS::Serverless::Api.CanarySetting`.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getCors()
`AWS::Serverless::Api.Cors`.
|
java.lang.Object |
getDefinitionBody()
`AWS::Serverless::Api.DefinitionBody`.
|
java.lang.Object |
getDefinitionUri()
`AWS::Serverless::Api.DefinitionUri`.
|
java.lang.String |
getDescription()
`AWS::Serverless::Api.Description`.
|
java.lang.Object |
getDisableExecuteApiEndpoint()
`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
|
java.lang.Object |
getDomain()
`AWS::Serverless::Api.Domain`.
|
java.lang.Object |
getEndpointConfiguration()
`AWS::Serverless::Api.EndpointConfiguration`.
|
java.lang.Object |
getGatewayResponses()
`AWS::Serverless::Api.GatewayResponses`.
|
java.lang.Object |
getMethodSettings()
`AWS::Serverless::Api.MethodSettings`.
|
java.lang.Number |
getMinimumCompressionSize()
`AWS::Serverless::Api.MinimumCompressionSize`.
|
java.lang.Object |
getModels()
`AWS::Serverless::Api.Models`.
|
java.lang.String |
getName()
`AWS::Serverless::Api.Name`.
|
java.lang.String |
getOpenApiVersion()
`AWS::Serverless::Api.OpenApiVersion`.
|
java.lang.String |
getStageName()
`AWS::Serverless::Api.StageName`.
|
TagManager |
getTags()
`AWS::Serverless::Api.Tags`.
|
java.lang.Object |
getTracingEnabled()
`AWS::Serverless::Api.TracingEnabled`.
|
java.lang.Object |
getVariables()
`AWS::Serverless::Api.Variables`.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAccessLogSetting(CfnApi.AccessLogSettingProperty value)
`AWS::Serverless::Api.AccessLogSetting`.
|
void |
setAccessLogSetting(IResolvable value)
`AWS::Serverless::Api.AccessLogSetting`.
|
void |
setAuth(CfnApi.AuthProperty value)
`AWS::Serverless::Api.Auth`.
|
void |
setAuth(IResolvable value)
`AWS::Serverless::Api.Auth`.
|
void |
setBinaryMediaTypes(java.util.List<java.lang.String> value)
`AWS::Serverless::Api.BinaryMediaTypes`.
|
void |
setCacheClusterEnabled(java.lang.Boolean value)
`AWS::Serverless::Api.CacheClusterEnabled`.
|
void |
setCacheClusterEnabled(IResolvable value)
`AWS::Serverless::Api.CacheClusterEnabled`.
|
void |
setCacheClusterSize(java.lang.String value)
`AWS::Serverless::Api.CacheClusterSize`.
|
void |
setCanarySetting(CfnApi.CanarySettingProperty value)
`AWS::Serverless::Api.CanarySetting`.
|
void |
setCanarySetting(IResolvable value)
`AWS::Serverless::Api.CanarySetting`.
|
void |
setCors(CfnApi.CorsConfigurationProperty value)
`AWS::Serverless::Api.Cors`.
|
void |
setCors(IResolvable value)
`AWS::Serverless::Api.Cors`.
|
void |
setCors(java.lang.String value)
`AWS::Serverless::Api.Cors`.
|
void |
setDefinitionBody(java.lang.Object value)
`AWS::Serverless::Api.DefinitionBody`.
|
void |
setDefinitionUri(CfnApi.S3LocationProperty value)
`AWS::Serverless::Api.DefinitionUri`.
|
void |
setDefinitionUri(IResolvable value)
`AWS::Serverless::Api.DefinitionUri`.
|
void |
setDefinitionUri(java.lang.String value)
`AWS::Serverless::Api.DefinitionUri`.
|
void |
setDescription(java.lang.String value)
`AWS::Serverless::Api.Description`.
|
void |
setDisableExecuteApiEndpoint(java.lang.Boolean value)
`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
|
void |
setDisableExecuteApiEndpoint(IResolvable value)
`AWS::Serverless::Api.DisableExecuteApiEndpoint`.
|
void |
setDomain(CfnApi.DomainConfigurationProperty value)
`AWS::Serverless::Api.Domain`.
|
void |
setDomain(IResolvable value)
`AWS::Serverless::Api.Domain`.
|
void |
setEndpointConfiguration(CfnApi.EndpointConfigurationProperty value)
`AWS::Serverless::Api.EndpointConfiguration`.
|
void |
setEndpointConfiguration(IResolvable value)
`AWS::Serverless::Api.EndpointConfiguration`.
|
void |
setEndpointConfiguration(java.lang.String value)
`AWS::Serverless::Api.EndpointConfiguration`.
|
void |
setGatewayResponses(java.lang.Object value)
`AWS::Serverless::Api.GatewayResponses`.
|
void |
setMethodSettings(IResolvable value)
`AWS::Serverless::Api.MethodSettings`.
|
void |
setMethodSettings(java.util.List<java.lang.Object> value)
`AWS::Serverless::Api.MethodSettings`.
|
void |
setMinimumCompressionSize(java.lang.Number value)
`AWS::Serverless::Api.MinimumCompressionSize`.
|
void |
setModels(java.lang.Object value)
`AWS::Serverless::Api.Models`.
|
void |
setName(java.lang.String value)
`AWS::Serverless::Api.Name`.
|
void |
setOpenApiVersion(java.lang.String value)
`AWS::Serverless::Api.OpenApiVersion`.
|
void |
setStageName(java.lang.String value)
`AWS::Serverless::Api.StageName`.
|
void |
setTracingEnabled(java.lang.Boolean value)
`AWS::Serverless::Api.TracingEnabled`.
|
void |
setTracingEnabled(IResolvable value)
`AWS::Serverless::Api.TracingEnabled`.
|
void |
setVariables(IResolvable value)
`AWS::Serverless::Api.Variables`.
|
void |
setVariables(java.util.Map<java.lang.String,java.lang.String> value)
`AWS::Serverless::Api.Variables`.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
public static final java.lang.String REQUIRED_TRANSFORM
protected CfnApi(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApi(Construct scope, java.lang.String id, CfnApiProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getDefinitionBody()
public void setDefinitionBody(java.lang.Object value)
public java.lang.Object getGatewayResponses()
public void setGatewayResponses(java.lang.Object value)
public java.lang.Object getModels()
public void setModels(java.lang.Object value)
public java.lang.String getStageName()
public void setStageName(java.lang.String value)
public java.lang.Object getAccessLogSetting()
public void setAccessLogSetting(CfnApi.AccessLogSettingProperty value)
public void setAccessLogSetting(IResolvable value)
public java.lang.Object getAuth()
public void setAuth(IResolvable value)
public void setAuth(CfnApi.AuthProperty value)
public java.util.List<java.lang.String> getBinaryMediaTypes()
public void setBinaryMediaTypes(java.util.List<java.lang.String> value)
public java.lang.Object getCacheClusterEnabled()
public void setCacheClusterEnabled(java.lang.Boolean value)
public void setCacheClusterEnabled(IResolvable value)
public java.lang.String getCacheClusterSize()
public void setCacheClusterSize(java.lang.String value)
public java.lang.Object getCanarySetting()
public void setCanarySetting(IResolvable value)
public void setCanarySetting(CfnApi.CanarySettingProperty value)
public java.lang.Object getCors()
public void setCors(java.lang.String value)
public void setCors(IResolvable value)
public void setCors(CfnApi.CorsConfigurationProperty value)
public java.lang.Object getDefinitionUri()
public void setDefinitionUri(java.lang.String value)
public void setDefinitionUri(IResolvable value)
public void setDefinitionUri(CfnApi.S3LocationProperty value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getDisableExecuteApiEndpoint()
public void setDisableExecuteApiEndpoint(java.lang.Boolean value)
public void setDisableExecuteApiEndpoint(IResolvable value)
public java.lang.Object getDomain()
public void setDomain(IResolvable value)
public void setDomain(CfnApi.DomainConfigurationProperty value)
public java.lang.Object getEndpointConfiguration()
public void setEndpointConfiguration(java.lang.String value)
public void setEndpointConfiguration(IResolvable value)
public void setEndpointConfiguration(CfnApi.EndpointConfigurationProperty value)
public java.lang.Object getMethodSettings()
public void setMethodSettings(java.util.List<java.lang.Object> value)
public void setMethodSettings(IResolvable value)
public java.lang.Number getMinimumCompressionSize()
public void setMinimumCompressionSize(java.lang.Number value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getOpenApiVersion()
public void setOpenApiVersion(java.lang.String value)
public java.lang.Object getTracingEnabled()
public void setTracingEnabled(java.lang.Boolean value)
public void setTracingEnabled(IResolvable value)
public java.lang.Object getVariables()
public void setVariables(IResolvable value)
public void setVariables(java.util.Map<java.lang.String,java.lang.String> value)