Class CfnApiProps

Properties for defining a CfnApi.

Inheritance

object

CfnApiProps

Implements

ICfnApiProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApiProps : ICfnApiProps

Syntax (vb)

Public Class CfnApiProps Implements ICfnApiProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

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

             var body;

             var cfnApiProps = new CfnApiProps {
                 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",
                 DisableExecuteApiEndpoint = false,
                 DisableSchemaValidation = false,
                 FailOnWarnings = false,
                 IpAddressType = "ipAddressType",
                 Name = "name",
                 ProtocolType = "protocolType",
                 RouteKey = "routeKey",
                 RouteSelectionExpression = "routeSelectionExpression",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Target = "target",
                 Version = "version"
             };

Synopsis

Constructors

CfnApiProps()

Properties for defining a CfnApi.

Properties

ApiKeySelectionExpression	An API key selection expression.
BasePath	Specifies how to interpret the base path of the API during import.
Body	The OpenAPI definition.
BodyS3Location	The S3 location of an OpenAPI definition.
CorsConfiguration	A CORS configuration.
CredentialsArn	This property is part of quick create.
Description	The description of the API.
DisableExecuteApiEndpoint	Specifies whether clients can invoke your API by using the default execute-api endpoint.
DisableSchemaValidation	Avoid validating models when creating a deployment.
FailOnWarnings	Specifies whether to rollback the API creation when a warning is encountered.
IpAddressType	The IP address types that can invoke the API.
Name	The name of the API.
ProtocolType	The API protocol.
RouteKey	This property is part of quick create.
RouteSelectionExpression	The route selection expression for the API.
Tags	The collection of tags.
Target	This property is part of quick create.
Version	A version identifier for the API.

Constructors

CfnApiProps()

Properties for defining a CfnApi.

public CfnApiProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

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

             var body;

             var cfnApiProps = new CfnApiProps {
                 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",
                 DisableExecuteApiEndpoint = false,
                 DisableSchemaValidation = false,
                 FailOnWarnings = false,
                 IpAddressType = "ipAddressType",
                 Name = "name",
                 ProtocolType = "protocolType",
                 RouteKey = "routeKey",
                 RouteSelectionExpression = "routeSelectionExpression",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Target = "target",
                 Version = "version"
             };

Properties

ApiKeySelectionExpression

An API key selection expression.

public string? ApiKeySelectionExpression { get; set; }

Property Value

string

Remarks

Supported only for WebSocket APIs. See API Key Selection Expressions .

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

BasePath

Specifies how to interpret the base path of the API during import.

public string? BasePath { get; set; }

Property Value

string

Remarks

Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.

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

Body

The OpenAPI definition.

public object? Body { get; set; }

Property Value

object

Remarks

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

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

BodyS3Location

The S3 location of an OpenAPI definition.

public object? BodyS3Location { get; set; }

Property Value

object

Remarks

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

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

Type union: either IResolvable or CfnApi.IBodyS3LocationProperty

CorsConfiguration

A CORS configuration.

public object? CorsConfiguration { get; set; }

Property Value

object

Remarks

Supported only for HTTP APIs. See Configuring CORS for more information.

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

Type union: either IResolvable or CfnApi.ICorsProperty

CredentialsArn

This property is part of quick create.

public string? CredentialsArn { get; set; }

Property Value

string

Remarks

It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/ . To use resource-based permissions on supported AWS services, specify null . Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

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

Description

The description of the API.

public string? Description { get; set; }

Property Value

string

Remarks

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

DisableExecuteApiEndpoint

Specifies whether clients can invoke your API by using the default execute-api endpoint.

public object? DisableExecuteApiEndpoint { get; set; }

Property Value

object

Remarks

By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

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

Type union: either bool or IResolvable

DisableSchemaValidation

Avoid validating models when creating a deployment.

public object? DisableSchemaValidation { get; set; }

Property Value

object

Remarks

Supported only for WebSocket APIs.

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

Type union: either bool or IResolvable

FailOnWarnings

Specifies whether to rollback the API creation when a warning is encountered.

public object? FailOnWarnings { get; set; }

Property Value

object

Remarks

By default, API creation continues if a warning is encountered.

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

Type union: either bool or IResolvable

IpAddressType

The IP address types that can invoke the API.

public string? IpAddressType { get; set; }

Property Value

string

Remarks

Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API.

Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.

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

Name

The name of the API.

public string? Name { get; set; }

Property Value

string

Remarks

Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

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

ProtocolType

The API protocol.

public string? ProtocolType { get; set; }

Property Value

string

Remarks

Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

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

RouteKey

This property is part of quick create.

public string? RouteKey { get; set; }

Property Value

string

Remarks

If you don't specify a routeKey , a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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

RouteSelectionExpression

The route selection expression for the API.

public string? RouteSelectionExpression { get; set; }

Property Value

string

Remarks

For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path} . If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

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

Tags

The collection of tags.

public IDictionary<string, string>? Tags { get; set; }

Property Value

IDictionary<string, string>

Remarks

Each tag element is associated with a given resource.

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

Target

This property is part of quick create.

public object? Target { get; set; }

Property Value

object

Remarks

Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

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

Type union: either string or IFunctionRef

Version

A version identifier for the API.

public string? Version { get; set; }

Property Value

string

Remarks

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

Implements

ICfnApiProps