Class CfnApi
The AWS::ApiGatewayV2::Api
resource creates an API.
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApi : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnApi
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html
CloudformationResource: AWS::ApiGatewayV2::Api
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(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 |
CfnApi(Construct, String, ICfnApiProps) |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnApi(Construct, String, ICfnApiProps)
public CfnApi(Construct scope, string id, ICfnApiProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnApiProps
Resource properties.
Properties
ApiKeySelectionExpression
An API key selection expression.
public virtual string ApiKeySelectionExpression { get; set; }
Property Value
System.String
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
Body
The OpenAPI definition.
public virtual object Body { get; set; }
Property Value
System.Object
BodyS3Location
The S3 location of an OpenAPI definition.
public virtual object BodyS3Location { get; set; }
Property Value
System.Object
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
CredentialsArn
This property is part of quick create.
public virtual string CredentialsArn { get; set; }
Property Value
System.String
Description
The description of the API.
public virtual string Description { get; set; }
Property Value
System.String
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
DisableSchemaValidation
Avoid validating models when creating a deployment.
public virtual object DisableSchemaValidation { get; set; }
Property Value
System.Object
FailOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.
public virtual object FailOnWarnings { get; set; }
Property Value
System.Object
Name
The name of the API.
public virtual string Name { get; set; }
Property Value
System.String
ProtocolType
The API protocol.
public virtual string ProtocolType { get; set; }
Property Value
System.String
RouteKey
This property is part of quick create.
public virtual string RouteKey { get; set; }
Property Value
System.String
RouteSelectionExpression
The route selection expression for the API.
public virtual string RouteSelectionExpression { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The collection of tags.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Target
This property is part of quick create.
public virtual string Target { get; set; }
Property Value
System.String
Version
A version identifier for the API.
public virtual string Version { get; set; }
Property Value
System.String
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>