Table of Contents

Class CfnApiV2

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

(deprecated) A CloudFormation AWS::ApiGatewayV2::Api.

[Obsolete("moved to package aws-apigatewayv2")]
public class CfnApiV2 : CfnResource, IInspectable
Inheritance
CfnApiV2
Implements
IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var body;
             var tags;

             var cfnApiV2 = new CfnApiV2(this, "MyCfnApiV2", new CfnApiV2Props {
                 ApiKeySelectionExpression = "apiKeySelectionExpression",
                 BasePath = "basePath",
                 Body = body,
                 BodyS3Location = new BodyS3LocationProperty {
                     Bucket = "bucket",
                     Etag = "etag",
                     Key = "key",
                     Version = "version"
                 },
                 CorsConfiguration = new CorsProperty {
                     AllowCredentials = false,
                     AllowHeaders = new [] { "allowHeaders" },
                     AllowMethods = new [] { "allowMethods" },
                     AllowOrigins = new [] { "allowOrigins" },
                     ExposeHeaders = new [] { "exposeHeaders" },
                     MaxAge = 123
                 },
                 CredentialsArn = "credentialsArn",
                 Description = "description",
                 DisableSchemaValidation = false,
                 FailOnWarnings = false,
                 Name = "name",
                 ProtocolType = "protocolType",
                 RouteKey = "routeKey",
                 RouteSelectionExpression = "routeSelectionExpression",
                 Tags = tags,
                 Target = "target",
                 Version = "version"
             });

Remarks

Stability: Deprecated

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

CloudformationResource: AWS::ApiGatewayV2::Api

ExampleMetadata: fixture=_generated

Constructors

CfnApiV2(Construct, string, ICfnApiV2Props?)

(deprecated) Create a new AWS::ApiGatewayV2::Api.

[Obsolete]
public CfnApiV2(Construct scope, string id, ICfnApiV2Props? props = null)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnApiV2Props
  • resource properties.

Remarks

Stability: Deprecated

Properties

ApiKeySelectionExpression

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

[Obsolete]
public virtual string? ApiKeySelectionExpression { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

BasePath

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

[Obsolete]
public virtual string? BasePath { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

Body

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

[Obsolete]
public virtual object Body { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

BodyS3Location

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

[Obsolete]
public virtual object? BodyS3Location { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

CFN_RESOURCE_TYPE_NAME

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

[Obsolete]
public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Stability: Deprecated

CfnProperties 

[Obsolete]
protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Remarks

Stability: Deprecated

CorsConfiguration

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

[Obsolete]
public virtual object? CorsConfiguration { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

CredentialsArn

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

[Obsolete]
public virtual string? CredentialsArn { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

Description

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

[Obsolete]
public virtual string? Description { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

DisableSchemaValidation

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

[Obsolete]
public virtual object? DisableSchemaValidation { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

FailOnWarnings

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

[Obsolete]
public virtual object? FailOnWarnings { get; set; }

Property Value

object

Remarks

Stability: Deprecated

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

Name

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

[Obsolete]
public virtual string? Name { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

ProtocolType

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

[Obsolete]
public virtual string? ProtocolType { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

RouteKey

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

[Obsolete]
public virtual string? RouteKey { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

RouteSelectionExpression

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

[Obsolete]
public virtual string? RouteSelectionExpression { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

Tags

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

[Obsolete]
public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Stability: Deprecated

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

Target

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

[Obsolete]
public virtual string? Target { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

Version

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

[Obsolete]
public virtual string? Version { get; set; }

Property Value

string

Remarks

Stability: Deprecated

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

Methods

Inspect(TreeInspector)

(deprecated) Examines the CloudFormation resource and discloses attributes.

[Obsolete]
public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector
  • tree inspector to collect and process attributes.

Remarks

Stability: Deprecated

RenderProperties(IDictionary<string, object>) 

[Obsolete]
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Remarks

Stability: Deprecated