Interface ICfnApiProps
Properties for defining a CfnApi
.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface ICfnApiProps
Syntax (vb)
Public Interface ICfnApiProps
Remarks
Link: 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,
Name = "name",
ProtocolType = "protocolType",
RouteKey = "routeKey",
RouteSelectionExpression = "routeSelectionExpression",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Target = "target",
Version = "version"
};
Synopsis
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 |
DisableSchemaValidation | Avoid validating models when creating a deployment. |
FailOnWarnings | Specifies whether to rollback the API creation when a warning is encountered. |
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. |
Properties
ApiKeySelectionExpression
An API key selection expression.
virtual string ApiKeySelectionExpression { get; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs. See API Key Selection Expressions .
BasePath
Specifies how to interpret the base path of the API during import.
virtual string BasePath { get; }
Property Value
System.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.
Body
The OpenAPI definition.
virtual object Body { get; }
Property Value
System.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.
BodyS3Location
The S3 location of an OpenAPI definition.
virtual object BodyS3Location { get; }
Property Value
System.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.
CorsConfiguration
A CORS configuration.
virtual object CorsConfiguration { get; }
Property Value
System.Object
Remarks
Supported only for HTTP APIs. See Configuring CORS for more information.
CredentialsArn
This property is part of quick create.
virtual string CredentialsArn { get; }
Property Value
System.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.
Description
The description of the API.
virtual string Description { get; }
Property Value
System.String
Remarks
DisableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api
endpoint.
virtual object DisableExecuteApiEndpoint { get; }
Property Value
System.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.
DisableSchemaValidation
Avoid validating models when creating a deployment.
virtual object DisableSchemaValidation { get; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
FailOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.
virtual object FailOnWarnings { get; }
Property Value
System.Object
Remarks
By default, API creation continues if a warning is encountered.
Name
The name of the API.
virtual string Name { get; }
Property Value
System.String
Remarks
Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
ProtocolType
The API protocol.
virtual string ProtocolType { get; }
Property Value
System.String
Remarks
Valid values are WEBSOCKET
or HTTP
. Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
RouteKey
This property is part of quick create.
virtual string RouteKey { get; }
Property Value
System.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.
RouteSelectionExpression
The route selection expression for the API.
virtual string RouteSelectionExpression { get; }
Property Value
System.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.
Tags
The collection of tags.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Each tag element is associated with a given resource.
Target
This property is part of quick create.
virtual string Target { get; }
Property Value
System.String
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.
Version
A version identifier for the API.
virtual string Version { get; }
Property Value
System.String