software.amazon.awscdk.services.apigatewayv2

Class CfnApi

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.apigatewayv2.CfnApi

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.840Z")
 @Stability(value=Stable)
public class CfnApi
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::Api`.

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.apigatewayv2.*;
 Object body;
 Object tags;
 CfnApi cfnApi = CfnApi.Builder.create(this, "MyCfnApi")
         .apiKeySelectionExpression("apiKeySelectionExpression")
         .basePath("basePath")
         .body(body)
         .bodyS3Location(BodyS3LocationProperty.builder()
                 .bucket("bucket")
                 .etag("etag")
                 .key("key")
                 .version("version")
                 .build())
         .corsConfiguration(CorsProperty.builder()
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .allowOrigins(List.of("allowOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(123)
                 .build())
         .credentialsArn("credentialsArn")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .disableSchemaValidation(false)
         .failOnWarnings(false)
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(tags)
         .target("target")
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnApi.BodyS3LocationProperty Example:
static class	CfnApi.Builder A fluent builder for CfnApi.
static interface	CfnApi.CorsProperty Example:

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
	CfnApi(software.constructs.Construct scope, String id) Create a new `AWS::ApiGatewayV2::Api`.
	CfnApi(software.constructs.Construct scope, String id, CfnApiProps props) Create a new `AWS::ApiGatewayV2::Api`.
protected	CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApiKeySelectionExpression() `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
String	getAttrApiEndpoint()
String	getBasePath() `AWS::ApiGatewayV2::Api.BasePath`.
Object	getBody() `AWS::ApiGatewayV2::Api.Body`.
Object	getBodyS3Location() `AWS::ApiGatewayV2::Api.BodyS3Location`.
protected Map<String,Object>	getCfnProperties()
Object	getCorsConfiguration() `AWS::ApiGatewayV2::Api.CorsConfiguration`.
String	getCredentialsArn() `AWS::ApiGatewayV2::Api.CredentialsArn`.
String	getDescription() `AWS::ApiGatewayV2::Api.Description`.
Object	getDisableExecuteApiEndpoint() `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
Object	getDisableSchemaValidation() `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
Object	getFailOnWarnings() `AWS::ApiGatewayV2::Api.FailOnWarnings`.
String	getName() `AWS::ApiGatewayV2::Api.Name`.
String	getProtocolType() `AWS::ApiGatewayV2::Api.ProtocolType`.
String	getRouteKey() `AWS::ApiGatewayV2::Api.RouteKey`.
String	getRouteSelectionExpression() `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
TagManager	getTags() `AWS::ApiGatewayV2::Api.Tags`.
String	getTarget() `AWS::ApiGatewayV2::Api.Target`.
String	getVersion() `AWS::ApiGatewayV2::Api.Version`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiKeySelectionExpression(String value) `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
void	setBasePath(String value) `AWS::ApiGatewayV2::Api.BasePath`.
void	setBody(Object value) `AWS::ApiGatewayV2::Api.Body`.
void	setBodyS3Location(CfnApi.BodyS3LocationProperty value) `AWS::ApiGatewayV2::Api.BodyS3Location`.
void	setBodyS3Location(IResolvable value) `AWS::ApiGatewayV2::Api.BodyS3Location`.
void	setCorsConfiguration(CfnApi.CorsProperty value) `AWS::ApiGatewayV2::Api.CorsConfiguration`.
void	setCorsConfiguration(IResolvable value) `AWS::ApiGatewayV2::Api.CorsConfiguration`.
void	setCredentialsArn(String value) `AWS::ApiGatewayV2::Api.CredentialsArn`.
void	setDescription(String value) `AWS::ApiGatewayV2::Api.Description`.
void	setDisableExecuteApiEndpoint(Boolean value) `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
void	setDisableExecuteApiEndpoint(IResolvable value) `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
void	setDisableSchemaValidation(Boolean value) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
void	setDisableSchemaValidation(IResolvable value) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
void	setFailOnWarnings(Boolean value) `AWS::ApiGatewayV2::Api.FailOnWarnings`.
void	setFailOnWarnings(IResolvable value) `AWS::ApiGatewayV2::Api.FailOnWarnings`.
void	setName(String value) `AWS::ApiGatewayV2::Api.Name`.
void	setProtocolType(String value) `AWS::ApiGatewayV2::Api.ProtocolType`.
void	setRouteKey(String value) `AWS::ApiGatewayV2::Api.RouteKey`.
void	setRouteSelectionExpression(String value) `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
void	setTarget(String value) `AWS::ApiGatewayV2::Api.Target`.
void	setVersion(String value) `AWS::ApiGatewayV2::Api.Version`.

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

CfnApi

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

CfnApi

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

CfnApi

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

Create a new `AWS::ApiGatewayV2::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.

CfnApi

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

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

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.

getApiKeySelectionExpression

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

`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

setApiKeySelectionExpression

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

`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

getAttrApiEndpoint

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

getBasePath

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

`AWS::ApiGatewayV2::Api.BasePath`.

setBasePath

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

`AWS::ApiGatewayV2::Api.BasePath`.

getBody

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

`AWS::ApiGatewayV2::Api.Body`.

setBody

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

`AWS::ApiGatewayV2::Api.Body`.

getBodyS3Location

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

`AWS::ApiGatewayV2::Api.BodyS3Location`.

setBodyS3Location

@Stability(value=Stable)
public void setBodyS3Location(@Nullable
                                                       CfnApi.BodyS3LocationProperty value)

`AWS::ApiGatewayV2::Api.BodyS3Location`.

setBodyS3Location

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

`AWS::ApiGatewayV2::Api.BodyS3Location`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCorsConfiguration

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

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

setCorsConfiguration

@Stability(value=Stable)
public void setCorsConfiguration(@Nullable
                                                          CfnApi.CorsProperty value)

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

setCorsConfiguration

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

`AWS::ApiGatewayV2::Api.CorsConfiguration`.

getCredentialsArn

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

`AWS::ApiGatewayV2::Api.CredentialsArn`.

setCredentialsArn

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

`AWS::ApiGatewayV2::Api.CredentialsArn`.

getDescription

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

`AWS::ApiGatewayV2::Api.Description`.

setDescription

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

`AWS::ApiGatewayV2::Api.Description`.

getDisableExecuteApiEndpoint

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

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

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

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

setDisableExecuteApiEndpoint

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

`AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.

getDisableSchemaValidation

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

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

setDisableSchemaValidation

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

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

setDisableSchemaValidation

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

`AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

getFailOnWarnings

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

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

setFailOnWarnings

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

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

setFailOnWarnings

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

`AWS::ApiGatewayV2::Api.FailOnWarnings`.

getName

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

`AWS::ApiGatewayV2::Api.Name`.

setName

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

`AWS::ApiGatewayV2::Api.Name`.

getProtocolType

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

`AWS::ApiGatewayV2::Api.ProtocolType`.

setProtocolType

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

`AWS::ApiGatewayV2::Api.ProtocolType`.

getRouteKey

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

`AWS::ApiGatewayV2::Api.RouteKey`.

setRouteKey

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

`AWS::ApiGatewayV2::Api.RouteKey`.

getRouteSelectionExpression

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

`AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

setRouteSelectionExpression

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

`AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

getTags

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

`AWS::ApiGatewayV2::Api.Tags`.

getTarget

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

`AWS::ApiGatewayV2::Api.Target`.

setTarget

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

`AWS::ApiGatewayV2::Api.Target`.

getVersion

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

`AWS::ApiGatewayV2::Api.Version`.

setVersion

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

`AWS::ApiGatewayV2::Api.Version`.