software.amazon.awscdk.services.apigateway

Class CfnRestApi

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.apigateway.CfnRestApi

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.840Z")
 @Stability(value=Stable)
public class CfnRestApi
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::RestApi`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRestApi.Builder A fluent builder for CfnRestApi.
static interface	CfnRestApi.EndpointConfigurationProperty
static interface	CfnRestApi.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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRestApi(software.constructs.Construct scope, String id) Create a new `AWS::ApiGateway::RestApi`.
	CfnRestApi(software.constructs.Construct scope, String id, CfnRestApiProps props) Create a new `AWS::ApiGateway::RestApi`.
protected	CfnRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRestApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApiKeySourceType() `AWS::ApiGateway::RestApi.ApiKeySourceType`.
String	getAttrRootResourceId()
List<String>	getBinaryMediaTypes() `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
Object	getBody() `AWS::ApiGateway::RestApi.Body`.
Object	getBodyS3Location() `AWS::ApiGateway::RestApi.BodyS3Location`.
protected Map<String,Object>	getCfnProperties()
String	getCloneFrom() `AWS::ApiGateway::RestApi.CloneFrom`.
String	getDescription() `AWS::ApiGateway::RestApi.Description`.
Object	getDisableExecuteApiEndpoint() `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
Object	getEndpointConfiguration() `AWS::ApiGateway::RestApi.EndpointConfiguration`.
Object	getFailOnWarnings() `AWS::ApiGateway::RestApi.FailOnWarnings`.
Number	getMinimumCompressionSize() `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
String	getName() `AWS::ApiGateway::RestApi.Name`.
Object	getParameters() `AWS::ApiGateway::RestApi.Parameters`.
Object	getPolicy() `AWS::ApiGateway::RestApi.Policy`.
TagManager	getTags() `AWS::ApiGateway::RestApi.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiKeySourceType(String value) `AWS::ApiGateway::RestApi.ApiKeySourceType`.
void	setBinaryMediaTypes(List<String> value) `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
void	setBody(Object value) `AWS::ApiGateway::RestApi.Body`.
void	setBodyS3Location(CfnRestApi.S3LocationProperty value) `AWS::ApiGateway::RestApi.BodyS3Location`.
void	setBodyS3Location(IResolvable value) `AWS::ApiGateway::RestApi.BodyS3Location`.
void	setCloneFrom(String value) `AWS::ApiGateway::RestApi.CloneFrom`.
void	setDescription(String value) `AWS::ApiGateway::RestApi.Description`.
void	setDisableExecuteApiEndpoint(Boolean value) `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
void	setDisableExecuteApiEndpoint(IResolvable value) `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
void	setEndpointConfiguration(CfnRestApi.EndpointConfigurationProperty value) `AWS::ApiGateway::RestApi.EndpointConfiguration`.
void	setEndpointConfiguration(IResolvable value) `AWS::ApiGateway::RestApi.EndpointConfiguration`.
void	setFailOnWarnings(Boolean value) `AWS::ApiGateway::RestApi.FailOnWarnings`.
void	setFailOnWarnings(IResolvable value) `AWS::ApiGateway::RestApi.FailOnWarnings`.
void	setMinimumCompressionSize(Number value) `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
void	setName(String value) `AWS::ApiGateway::RestApi.Name`.
void	setParameters(IResolvable value) `AWS::ApiGateway::RestApi.Parameters`.
void	setParameters(Map<String,String> value) `AWS::ApiGateway::RestApi.Parameters`.
void	setPolicy(Object value) `AWS::ApiGateway::RestApi.Policy`.

Methods inherited from class software.amazon.awscdk.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.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 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.

Constructor Detail

CfnRestApi

protected CfnRestApi(software.amazon.jsii.JsiiObjectRef objRef)

CfnRestApi

protected CfnRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRestApi

@Stability(value=Stable)
public CfnRestApi(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           CfnRestApiProps props)

Create a new `AWS::ApiGateway::RestApi`.

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.

CfnRestApi

@Stability(value=Stable)
public CfnRestApi(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)

Create a new `AWS::ApiGateway::RestApi`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

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

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.

getAttrRootResourceId

@Stability(value=Stable)
 @NotNull
public String getAttrRootResourceId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ApiGateway::RestApi.Tags`.

getBody

@Stability(value=Stable)
 @NotNull
public Object getBody()

`AWS::ApiGateway::RestApi.Body`.

setBody

@Stability(value=Stable)
public void setBody(@NotNull
                                             Object value)

`AWS::ApiGateway::RestApi.Body`.

getPolicy

@Stability(value=Stable)
 @NotNull
public Object getPolicy()

`AWS::ApiGateway::RestApi.Policy`.

setPolicy

@Stability(value=Stable)
public void setPolicy(@NotNull
                                               Object value)

`AWS::ApiGateway::RestApi.Policy`.

getApiKeySourceType

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

`AWS::ApiGateway::RestApi.ApiKeySourceType`.

setApiKeySourceType

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

`AWS::ApiGateway::RestApi.ApiKeySourceType`.

getBinaryMediaTypes

@Stability(value=Stable)
 @Nullable
public List<String> getBinaryMediaTypes()

`AWS::ApiGateway::RestApi.BinaryMediaTypes`.

setBinaryMediaTypes

@Stability(value=Stable)
public void setBinaryMediaTypes(@Nullable
                                                         List<String> value)

`AWS::ApiGateway::RestApi.BinaryMediaTypes`.

getBodyS3Location

@Stability(value=Stable)
 @Nullable
public Object getBodyS3Location()

`AWS::ApiGateway::RestApi.BodyS3Location`.

setBodyS3Location

@Stability(value=Stable)
public void setBodyS3Location(@Nullable
                                                       CfnRestApi.S3LocationProperty value)

`AWS::ApiGateway::RestApi.BodyS3Location`.

setBodyS3Location

@Stability(value=Stable)
public void setBodyS3Location(@Nullable
                                                       IResolvable value)

`AWS::ApiGateway::RestApi.BodyS3Location`.

getCloneFrom

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

`AWS::ApiGateway::RestApi.CloneFrom`.

setCloneFrom

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

`AWS::ApiGateway::RestApi.CloneFrom`.

getDescription

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

`AWS::ApiGateway::RestApi.Description`.

setDescription

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

`AWS::ApiGateway::RestApi.Description`.

getDisableExecuteApiEndpoint

@Stability(value=Stable)
 @Nullable
public Object getDisableExecuteApiEndpoint()

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

@Stability(value=Stable)
public void setDisableExecuteApiEndpoint(@Nullable
                                                                  Boolean value)

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

@Stability(value=Stable)
public void setDisableExecuteApiEndpoint(@Nullable
                                                                  IResolvable value)

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

getEndpointConfiguration

@Stability(value=Stable)
 @Nullable
public Object getEndpointConfiguration()

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

setEndpointConfiguration

@Stability(value=Stable)
public void setEndpointConfiguration(@Nullable
                                                              CfnRestApi.EndpointConfigurationProperty value)

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

setEndpointConfiguration

@Stability(value=Stable)
public void setEndpointConfiguration(@Nullable
                                                              IResolvable value)

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

getFailOnWarnings

@Stability(value=Stable)
 @Nullable
public Object getFailOnWarnings()

`AWS::ApiGateway::RestApi.FailOnWarnings`.

setFailOnWarnings

@Stability(value=Stable)
public void setFailOnWarnings(@Nullable
                                                       Boolean value)

`AWS::ApiGateway::RestApi.FailOnWarnings`.

setFailOnWarnings

@Stability(value=Stable)
public void setFailOnWarnings(@Nullable
                                                       IResolvable value)

`AWS::ApiGateway::RestApi.FailOnWarnings`.

getMinimumCompressionSize

@Stability(value=Stable)
 @Nullable
public Number getMinimumCompressionSize()

`AWS::ApiGateway::RestApi.MinimumCompressionSize`.

setMinimumCompressionSize

@Stability(value=Stable)
public void setMinimumCompressionSize(@Nullable
                                                               Number value)

`AWS::ApiGateway::RestApi.MinimumCompressionSize`.

getName

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

`AWS::ApiGateway::RestApi.Name`.

setName

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

`AWS::ApiGateway::RestApi.Name`.

getParameters

@Stability(value=Stable)
 @Nullable
public Object getParameters()

`AWS::ApiGateway::RestApi.Parameters`.

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   IResolvable value)

`AWS::ApiGateway::RestApi.Parameters`.

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   Map<String,String> value)

`AWS::ApiGateway::RestApi.Parameters`.