Table of Contents

Interface ICfnApiV2Props

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

(deprecated) Properties for defining a AWS::ApiGatewayV2::Api.

[Obsolete("moved to package aws-apigatewayv2")]
public interface ICfnApiV2Props

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 cfnApiV2Props = 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

ExampleMetadata: fixture=_generated

Properties

ApiKeySelectionExpression

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

[Obsolete]
string? ApiKeySelectionExpression { get; }

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]
string? BasePath { get; }

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]
object? Body { get; }

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]
object? BodyS3Location { get; }

Property Value

object

Remarks

Stability: Deprecated

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

CorsConfiguration

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

[Obsolete]
object? CorsConfiguration { get; }

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]
string? CredentialsArn { get; }

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]
string? Description { get; }

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]
object? DisableSchemaValidation { get; }

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]
object? FailOnWarnings { get; }

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]
string? Name { get; }

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]
string? ProtocolType { get; }

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]
string? RouteKey { get; }

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]
string? RouteSelectionExpression { get; }

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]
object? Tags { get; }

Property Value

object

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]
string? Target { get; }

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]
string? Version { get; }

Property Value

string

Remarks

Stability: Deprecated

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