software.amazon.awscdk.services.apigateway

Class CfnApiV2

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

All Implemented Interfaces:

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

Deprecated.

moved to package aws-apigatewayv2

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.330Z")
 @Stability(value=Deprecated)
 @Deprecated
public class CfnApiV2
extends CfnResource
implements IInspectable

(deprecated) 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.apigateway.*;
 Object body;
 Object tags;
 CfnApiV2 cfnApiV2 = CfnApiV2.Builder.create(this, "MyCfnApiV2")
         .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")
         .disableSchemaValidation(false)
         .failOnWarnings(false)
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(tags)
         .target("target")
         .version("version")
         .build();
 

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnApiV2.BodyS3LocationProperty Deprecated. moved to package aws-apigatewayv2
static class	CfnApiV2.Builder Deprecated.
static interface	CfnApiV2.CorsProperty Deprecated. moved to package aws-apigatewayv2

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 Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApiV2(Construct scope, String id) Deprecated.
	CfnApiV2(Construct scope, String id, CfnApiV2Props props) Deprecated.
protected	CfnApiV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	CfnApiV2(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getApiKeySelectionExpression() Deprecated.
String	getBasePath() Deprecated.
Object	getBody() Deprecated.
Object	getBodyS3Location() Deprecated.
protected Map<String,Object>	getCfnProperties() Deprecated.
Object	getCorsConfiguration() Deprecated.
String	getCredentialsArn() Deprecated.
String	getDescription() Deprecated.
Object	getDisableSchemaValidation() Deprecated.
Object	getFailOnWarnings() Deprecated.
String	getName() Deprecated.
String	getProtocolType() Deprecated.
String	getRouteKey() Deprecated.
String	getRouteSelectionExpression() Deprecated.
TagManager	getTags() Deprecated.
String	getTarget() Deprecated.
String	getVersion() Deprecated.
void	inspect(TreeInspector inspector) Deprecated.
protected Map<String,Object>	renderProperties(Map<String,Object> props) Deprecated.
void	setApiKeySelectionExpression(String value) Deprecated.
void	setBasePath(String value) Deprecated.
void	setBody(Object value) Deprecated.
void	setBodyS3Location(CfnApiV2.BodyS3LocationProperty value) Deprecated.
void	setBodyS3Location(IResolvable value) Deprecated.
void	setCorsConfiguration(CfnApiV2.CorsProperty value) Deprecated.
void	setCorsConfiguration(IResolvable value) Deprecated.
void	setCredentialsArn(String value) Deprecated.
void	setDescription(String value) Deprecated.
void	setDisableSchemaValidation(Boolean value) Deprecated.
void	setDisableSchemaValidation(IResolvable value) Deprecated.
void	setFailOnWarnings(Boolean value) Deprecated.
void	setFailOnWarnings(IResolvable value) Deprecated.
void	setName(String value) Deprecated.
void	setProtocolType(String value) Deprecated.
void	setRouteKey(String value) Deprecated.
void	setRouteSelectionExpression(String value) Deprecated.
void	setTarget(String value) Deprecated.
void	setVersion(String value) Deprecated.

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=Deprecated)
 @Deprecated
public static final String CFN_RESOURCE_TYPE_NAME

Deprecated.

(deprecated) The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiV2

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

Deprecated.

CfnApiV2

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

Deprecated.

CfnApiV2

@Stability(value=Deprecated)
 @Deprecated
public CfnApiV2(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @Nullable
                                                          CfnApiV2Props props)

Deprecated.

(deprecated) 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.

CfnApiV2

@Stability(value=Deprecated)
 @Deprecated
public CfnApiV2(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
public void inspect(@NotNull
                                                              TreeInspector inspector)

Deprecated.

(deprecated) 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=Deprecated)
 @Deprecated
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                                  Map<String,Object> props)

Deprecated.

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Deprecated.

Overrides:

getCfnProperties in class CfnResource

getTags

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags

getBody

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Body`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

setBody

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Body`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

getApiKeySelectionExpression

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

setApiKeySelectionExpression

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

getBasePath

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.BasePath`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

setBasePath

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.BasePath`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

getBodyS3Location

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.BodyS3Location`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

setBodyS3Location

@Stability(value=Deprecated)
 @Deprecated
public void setBodyS3Location(@Nullable
                                                                        CfnApiV2.BodyS3LocationProperty value)

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.BodyS3Location`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

setBodyS3Location

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.BodyS3Location`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

getCorsConfiguration

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.CorsConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

setCorsConfiguration

@Stability(value=Deprecated)
 @Deprecated
public void setCorsConfiguration(@Nullable
                                                                           CfnApiV2.CorsProperty value)

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.CorsConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

setCorsConfiguration

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.CorsConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

getCredentialsArn

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.CredentialsArn`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

setCredentialsArn

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.CredentialsArn`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

getDescription

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Description`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

setDescription

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Description`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

getDisableSchemaValidation

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

setDisableSchemaValidation

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

setDisableSchemaValidation

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

getFailOnWarnings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.FailOnWarnings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

setFailOnWarnings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.FailOnWarnings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

setFailOnWarnings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.FailOnWarnings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

getName

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Name`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

setName

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Name`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

getProtocolType

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.ProtocolType`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

setProtocolType

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.ProtocolType`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

getRouteKey

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.RouteKey`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

setRouteKey

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.RouteKey`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

getRouteSelectionExpression

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

setRouteSelectionExpression

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

getTarget

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Target`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

setTarget

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Target`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

getVersion

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Version`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version

setVersion

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Api.Version`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version