software.amazon.awscdk.services.sam

Class CfnApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sam.CfnApi

All Implemented Interfaces:

software.amazon.awscdk.IConstruct, software.amazon.awscdk.IDependable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.10.3 (build 6bbf743)",
           date="2019-04-24T21:03:06.583Z")
public class CfnApi
extends software.amazon.awscdk.CfnResource

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.AuthProperty
static interface	CfnApi.S3LocationProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getApiName()
CfnApiProps	getPropertyOverrides()
protected Map<String,Object>	renderProperties(Object properties)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, attribute, attribute, getAtt, getOptions, getProperties, getResourceType, getUntypedPropertyOverrides, isCfnResource, isTaggable

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef, getReferenceToken

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStackTrace, getLogicalId, getStackPath, isCfnElement, overrideLogicalId, prepare

Methods inherited from class software.amazon.awscdk.Construct

getDependencyRoots, getNode, isConstruct, toString, 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

REQUIRED_TRANSFORM

public static final String REQUIRED_TRANSFORM

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

RESOURCE_TYPE_NAME

public static final String RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApi

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

CfnApi

public CfnApi(software.amazon.awscdk.Construct scope,
              String id,
              CfnApiProps props)

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

Parameters:

scope - - scope in which this resource is defined.

id - - scoped id of the resource.

props - - resource properties.

Method Detail

renderProperties

protected Map<String,Object> renderProperties(@Nullable
                                              Object properties)

Overrides:

renderProperties in class software.amazon.awscdk.CfnResource

getApiName

public String getApiName()

getPropertyOverrides

public CfnApiProps getPropertyOverrides()