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:

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

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2021-01-28T16:32:48.868Z")
 @Stability(value=Stable)
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$Default, IInspectable.Jsii$Proxy

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

IConstruct.Jsii$Default

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

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	getOpenApiVersion() `AWS::Serverless::Api.OpenApiVersion`.
String	getStageName() `AWS::Serverless::Api.StageName`.
Object	getTracingEnabled() `AWS::Serverless::Api.TracingEnabled`.
Object	getVariables() `AWS::Serverless::Api.Variables`.
void	inspect(TreeInspector inspector) (experimental) 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	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(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, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(value=Stable)
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=Stable)
public CfnApi(@NotNull
                                       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 Detail

inspect

@Stability(value=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDefinitionBody

@Stability(value=Stable)
 @NotNull
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=Stable)
public void setDefinitionBody(@NotNull
                                                       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=Stable)
 @NotNull
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=Stable)
public void setStageName(@NotNull
                                                  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=Stable)
 @Nullable
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=Stable)
public void setAccessLogSetting(@Nullable
                                                         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=Stable)
public void setAccessLogSetting(@Nullable
                                                         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=Stable)
 @Nullable
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=Stable)
public void setAuth(@Nullable
                                             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=Stable)
public void setAuth(@Nullable
                                             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=Stable)
 @Nullable
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=Stable)
public void setBinaryMediaTypes(@Nullable
                                                         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=Stable)
 @Nullable
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=Stable)
public void setCacheClusterEnabled(@Nullable
                                                            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=Stable)
public void setCacheClusterEnabled(@Nullable
                                                            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=Stable)
 @Nullable
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=Stable)
public void setCacheClusterSize(@Nullable
                                                         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=Stable)
 @Nullable
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=Stable)
public void setCors(@Nullable
                                             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=Stable)
public void setCors(@Nullable
                                             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=Stable)
public void setCors(@Nullable
                                             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=Stable)
 @Nullable
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=Stable)
public void setDefinitionUri(@Nullable
                                                      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=Stable)
public void setDefinitionUri(@Nullable
                                                      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=Stable)
public void setDefinitionUri(@Nullable
                                                      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=Stable)
 @Nullable
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=Stable)
public void setEndpointConfiguration(@Nullable
                                                              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=Stable)
 @Nullable
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=Stable)
public void setMethodSettings(@Nullable
                                                       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=Stable)
public void setMethodSettings(@Nullable
                                                       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=Stable)
 @Nullable
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=Stable)
public void setName(@Nullable
                                             String value)

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

See Also:

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

getOpenApiVersion

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

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

See Also:

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

setOpenApiVersion

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

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

See Also:

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

getTracingEnabled

@Stability(value=Stable)
 @Nullable
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=Stable)
public void setTracingEnabled(@Nullable
                                                       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=Stable)
public void setTracingEnabled(@Nullable
                                                       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=Stable)
 @Nullable
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=Stable)
public void setVariables(@Nullable
                                                  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=Stable)
public void setVariables(@Nullable
                                                  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