CfnApi (software.amazon.awscdk:sam 1.19.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - 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:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable
```
@Generated(value="jsii-pacmak/0.20.11 (build d4fd44f)",
           date="2019-12-17T13:05:38.346Z")
 @Stability(value=External)
public class CfnApi
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::Serverless::Api`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnApi.AccessLogSettingProperty`
`static interface`	`CfnApi.AuthProperty`
`static class`	`CfnApi.Builder` A fluent builder for `CfnApi`.
`static interface`	`CfnApi.CorsConfigurationProperty`
`static interface`	`CfnApi.S3LocationProperty`

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.IInspectable
IInspectable.Jsii$Proxy

Field Summary

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnApi(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getCors()` `AWS::Serverless::Api.Cors`.
`Object`	`getDefinitionBody()` `AWS::Serverless::Api.DefinitionBody`.
`Object`	`getDefinitionUri()` `AWS::Serverless::Api.DefinitionUri`.
`String`	`getEndpointConfiguration()` `AWS::Serverless::Api.EndpointConfiguration`.
`Object`	`getMethodSettings()` `AWS::Serverless::Api.MethodSettings`.
`String`	`getName()` `AWS::Serverless::Api.Name`.
`String`	`getStageName()` `AWS::Serverless::Api.StageName`.
`Object`	`getTracingEnabled()` `AWS::Serverless::Api.TracingEnabled`.
`Object`	`getVariables()` `AWS::Serverless::Api.Variables`.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,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(List<String> value)` `AWS::Serverless::Api.BinaryMediaTypes`.
`void`	`setCacheClusterEnabled(Boolean value)` `AWS::Serverless::Api.CacheClusterEnabled`.
`void`	`setCacheClusterEnabled(IResolvable value)` `AWS::Serverless::Api.CacheClusterEnabled`.
`void`	`setCacheClusterSize(String value)` `AWS::Serverless::Api.CacheClusterSize`.
`void`	`setCors(CfnApi.CorsConfigurationProperty value)` `AWS::Serverless::Api.Cors`.
`void`	`setCors(IResolvable value)` `AWS::Serverless::Api.Cors`.
`void`	`setCors(String value)` `AWS::Serverless::Api.Cors`.
`void`	`setDefinitionBody(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(String value)` `AWS::Serverless::Api.DefinitionUri`.
`void`	`setEndpointConfiguration(String value)` `AWS::Serverless::Api.EndpointConfiguration`.
`void`	`setMethodSettings(IResolvable value)` `AWS::Serverless::Api.MethodSettings`.
`void`	`setMethodSettings(List<Object> value)` `AWS::Serverless::Api.MethodSettings`.
`void`	`setName(String value)` `AWS::Serverless::Api.Name`.
`void`	`setStageName(String value)` `AWS::Serverless::Api.StageName`.
`void`	`setTracingEnabled(Boolean value)` `AWS::Serverless::Api.TracingEnabled`.
`void`	`setTracingEnabled(IResolvable value)` `AWS::Serverless::Api.TracingEnabled`.
`void`	`setVariables(IResolvable value)` `AWS::Serverless::Api.Variables`.
`void`	`setVariables(Map<String,String> value)` `AWS::Serverless::Api.Variables`.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, 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, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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 Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=External)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
  - REQUIRED_TRANSFORM
```
@Stability(value=External)
public static final String REQUIRED_TRANSFORM
```
    The `Transform` a template must use in order to use this resource.
- Constructor Detail
  - CfnApi
```
protected CfnApi(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnApi
```
protected CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnApi
```
@Stability(value=External)
public CfnApi(Construct scope,
                                         String id,
                                         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 Detail
  - inspect
```
@Stability(value=Experimental)
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes. EXPERIMENTAL
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=External)
protected Map<String,Object> renderProperties(Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Stability(value=External)
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getDefinitionBody
```
@Stability(value=External)
public Object getDefinitionBody()
```
    `AWS::Serverless::Api.DefinitionBody`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setDefinitionBody
```
@Stability(value=External)
public void setDefinitionBody(Object value)
```
    `AWS::Serverless::Api.DefinitionBody`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getStageName
```
@Stability(value=External)
public String getStageName()
```
    `AWS::Serverless::Api.StageName`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setStageName
```
@Stability(value=External)
public void setStageName(String value)
```
    `AWS::Serverless::Api.StageName`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getAccessLogSetting
```
@Stability(value=External)
public Object getAccessLogSetting()
```
    `AWS::Serverless::Api.AccessLogSetting`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setAccessLogSetting
```
@Stability(value=External)
public void setAccessLogSetting(IResolvable value)
```
    `AWS::Serverless::Api.AccessLogSetting`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setAccessLogSetting
```
@Stability(value=External)
public void setAccessLogSetting(CfnApi.AccessLogSettingProperty value)
```
    `AWS::Serverless::Api.AccessLogSetting`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getAuth
```
@Stability(value=External)
public Object getAuth()
```
    `AWS::Serverless::Api.Auth`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setAuth
```
@Stability(value=External)
public void setAuth(IResolvable value)
```
    `AWS::Serverless::Api.Auth`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setAuth
```
@Stability(value=External)
public void setAuth(CfnApi.AuthProperty value)
```
    `AWS::Serverless::Api.Auth`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getBinaryMediaTypes
```
@Stability(value=External)
public List<String> getBinaryMediaTypes()
```
    `AWS::Serverless::Api.BinaryMediaTypes`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setBinaryMediaTypes
```
@Stability(value=External)
public void setBinaryMediaTypes(List<String> value)
```
    `AWS::Serverless::Api.BinaryMediaTypes`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getCacheClusterEnabled
```
@Stability(value=External)
public Object getCacheClusterEnabled()
```
    `AWS::Serverless::Api.CacheClusterEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCacheClusterEnabled
```
@Stability(value=External)
public void setCacheClusterEnabled(Boolean value)
```
    `AWS::Serverless::Api.CacheClusterEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCacheClusterEnabled
```
@Stability(value=External)
public void setCacheClusterEnabled(IResolvable value)
```
    `AWS::Serverless::Api.CacheClusterEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getCacheClusterSize
```
@Stability(value=External)
public String getCacheClusterSize()
```
    `AWS::Serverless::Api.CacheClusterSize`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCacheClusterSize
```
@Stability(value=External)
public void setCacheClusterSize(String value)
```
    `AWS::Serverless::Api.CacheClusterSize`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getCors
```
@Stability(value=External)
public Object getCors()
```
    `AWS::Serverless::Api.Cors`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCors
```
@Stability(value=External)
public void setCors(String value)
```
    `AWS::Serverless::Api.Cors`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCors
```
@Stability(value=External)
public void setCors(IResolvable value)
```
    `AWS::Serverless::Api.Cors`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setCors
```
@Stability(value=External)
public void setCors(CfnApi.CorsConfigurationProperty value)
```
    `AWS::Serverless::Api.Cors`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getDefinitionUri
```
@Stability(value=External)
public Object getDefinitionUri()
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setDefinitionUri
```
@Stability(value=External)
public void setDefinitionUri(String value)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setDefinitionUri
```
@Stability(value=External)
public void setDefinitionUri(IResolvable value)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setDefinitionUri
```
@Stability(value=External)
public void setDefinitionUri(CfnApi.S3LocationProperty value)
```
    `AWS::Serverless::Api.DefinitionUri`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getEndpointConfiguration
```
@Stability(value=External)
public String getEndpointConfiguration()
```
    `AWS::Serverless::Api.EndpointConfiguration`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setEndpointConfiguration
```
@Stability(value=External)
public void setEndpointConfiguration(String value)
```
    `AWS::Serverless::Api.EndpointConfiguration`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getMethodSettings
```
@Stability(value=External)
public Object getMethodSettings()
```
    `AWS::Serverless::Api.MethodSettings`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setMethodSettings
```
@Stability(value=External)
public void setMethodSettings(List<Object> value)
```
    `AWS::Serverless::Api.MethodSettings`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setMethodSettings
```
@Stability(value=External)
public void setMethodSettings(IResolvable value)
```
    `AWS::Serverless::Api.MethodSettings`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getName
```
@Stability(value=External)
public String getName()
```
    `AWS::Serverless::Api.Name`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setName
```
@Stability(value=External)
public void setName(String value)
```
    `AWS::Serverless::Api.Name`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getTracingEnabled
```
@Stability(value=External)
public Object getTracingEnabled()
```
    `AWS::Serverless::Api.TracingEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setTracingEnabled
```
@Stability(value=External)
public void setTracingEnabled(Boolean value)
```
    `AWS::Serverless::Api.TracingEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setTracingEnabled
```
@Stability(value=External)
public void setTracingEnabled(IResolvable value)
```
    `AWS::Serverless::Api.TracingEnabled`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - getVariables
```
@Stability(value=External)
public Object getVariables()
```
    `AWS::Serverless::Api.Variables`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setVariables
```
@Stability(value=External)
public void setVariables(IResolvable value)
```
    `AWS::Serverless::Api.Variables`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
  - setVariables
```
@Stability(value=External)
public void setVariables(Map<String,String> value)
```
    `AWS::Serverless::Api.Variables`.
    
    See Also:
    
    https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Class CfnApi

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

REQUIRED_TRANSFORM

Constructor Detail

CfnApi

CfnApi

CfnApi

Method Detail

inspect

renderProperties

getCfnProperties

getDefinitionBody

setDefinitionBody

getStageName

setStageName

getAccessLogSetting

setAccessLogSetting

setAccessLogSetting

getAuth

setAuth

setAuth

getBinaryMediaTypes

setBinaryMediaTypes

getCacheClusterEnabled

setCacheClusterEnabled

setCacheClusterEnabled

getCacheClusterSize

setCacheClusterSize

getCors

setCors

setCors

setCors

getDefinitionUri

setDefinitionUri

setDefinitionUri

setDefinitionUri

getEndpointConfiguration

setEndpointConfiguration

getMethodSettings

setMethodSettings

setMethodSettings

getName

setName

getTracingEnabled

setTracingEnabled

setTracingEnabled

getVariables

setVariables

setVariables