Class CfnApi
A CloudFormation AWS::ApiGatewayV2::Api
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnApi : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApi
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::Api
resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.
CloudformationResource: AWS::ApiGatewayV2::Api
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 cfnApi = new CfnApi(this, "MyCfnApi", 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
Constructors
CfnApi(Construct, String, ICfnApiProps) | Create a new |
CfnApi(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApi(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiKeySelectionExpression | An API key selection expression. |
AttrApiEndpoint | The default endpoint for an API. |
AttrApiId | The API identifier. |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApi(Construct, String, ICfnApiProps)
Create a new AWS::ApiGatewayV2::Api
.
public CfnApi(Construct scope, string id, ICfnApiProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApiProps
- resource properties.
CfnApi(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApi(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApi(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApi(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiKeySelectionExpression
An API key selection expression.
public virtual string ApiKeySelectionExpression { get; set; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs. See API Key Selection Expressions .
AttrApiEndpoint
The default endpoint for an API.
public virtual string AttrApiEndpoint { get; }
Property Value
System.String
Remarks
For example: https://abcdef.execute-api.us-west-2.amazonaws.com
.
CloudformationAttribute: ApiEndpoint
AttrApiId
The API identifier.
public virtual string AttrApiId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiId
BasePath
Specifies how to interpret the base path of the API during import.
public virtual string BasePath { get; set; }
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.
public virtual object Body { get; set; }
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.
public virtual object BodyS3Location { get; set; }
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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CorsConfiguration
A CORS configuration.
public virtual object CorsConfiguration { get; set; }
Property Value
System.Object
Remarks
Supported only for HTTP APIs. See Configuring CORS for more information.
CredentialsArn
This property is part of quick create.
public virtual string CredentialsArn { get; set; }
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.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DisableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api
endpoint.
public virtual object DisableExecuteApiEndpoint { get; set; }
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.
public virtual object DisableSchemaValidation { get; set; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
FailOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.
public virtual object FailOnWarnings { get; set; }
Property Value
System.Object
Remarks
By default, API creation continues if a warning is encountered.
Name
The name of the API.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
ProtocolType
The API protocol.
public virtual string ProtocolType { get; set; }
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.
public virtual string RouteKey { get; set; }
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.
public virtual string RouteSelectionExpression { get; set; }
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.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag element is associated with a given resource.
Target
This property is part of quick create.
public virtual string Target { get; set; }
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.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>