Class CfnRestApi
A CloudFormation AWS::ApiGateway::RestApi
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class CfnRestApi : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRestApi
Inherits CfnResource
Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGateway::RestApi
resource creates a REST API. For more information, see restapi:create in the Amazon API Gateway REST API Reference .
On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.
CloudformationResource: AWS::ApiGateway::RestApi
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.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.APIGateway;
var body;
var policy;
CfnRestApi cfnRestApi = new CfnRestApi(this, "MyCfnRestApi", new CfnRestApiProps {
ApiKeySourceType = "apiKeySourceType",
BinaryMediaTypes = new [] { "binaryMediaTypes" },
Body = body,
BodyS3Location = new S3LocationProperty {
Bucket = "bucket",
ETag = "eTag",
Key = "key",
Version = "version"
},
CloneFrom = "cloneFrom",
Description = "description",
DisableExecuteApiEndpoint = false,
EndpointConfiguration = new EndpointConfigurationProperty {
Types = new [] { "types" },
VpcEndpointIds = new [] { "vpcEndpointIds" }
},
FailOnWarnings = false,
MinimumCompressionSize = 123,
Mode = "mode",
Name = "name",
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
Policy = policy,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnRestApi(Construct, String, ICfnRestApiProps) | Create a new |
CfnRestApi(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRestApi(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiKeySourceType | The source of the API key for metering requests according to a usage plan. Valid values are:. |
AttrRootResourceId | The root resource ID for a |
BinaryMediaTypes | The list of binary media types that are supported by the |
Body | An OpenAPI specification that defines a set of RESTful APIs in JSON format. |
BodyS3Location | The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CloneFrom | The ID of the |
Description | A description of the |
DisableExecuteApiEndpoint | Specifies whether clients can invoke your API by using the default |
EndpointConfiguration | A list of the endpoint types of the API. |
FailOnWarnings | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the |
MinimumCompressionSize | A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. |
Mode | This property applies only when you use OpenAPI to define your REST API. |
Name | A name for the |
Parameters | Custom header parameters for the request. |
Policy | A policy document that contains the permissions for the |
Tags | An array of arbitrary tags (key-value pairs) to associate with the API. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRestApi(Construct, String, ICfnRestApiProps)
Create a new AWS::ApiGateway::RestApi
.
public CfnRestApi(Construct scope, string id, ICfnRestApiProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRestApiProps
- resource properties.
CfnRestApi(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRestApi(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRestApi(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRestApi(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiKeySourceType
The source of the API key for metering requests according to a usage plan. Valid values are:.
public virtual string ApiKeySourceType { get; set; }
Property Value
System.String
Remarks
AttrRootResourceId
The root resource ID for a RestApi
resource, such as a0bc123d4e
.
public virtual string AttrRootResourceId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RootResourceId
BinaryMediaTypes
The list of binary media types that are supported by the RestApi
resource.
public virtual string[] BinaryMediaTypes { get; set; }
Property Value
System.String[]
Remarks
Use ~1
instead of /
in the media types, for example image~1png
or application~1octet-stream
. By default, RestApi
supports only UTF-8-encoded text payloads. Duplicates are not allowed. For more information, see Enable Support for Binary Payloads in API Gateway in the API Gateway Developer Guide .
Body
An OpenAPI specification that defines a set of RESTful APIs in JSON format.
public virtual object Body { get; set; }
Property Value
System.Object
Remarks
For YAML templates, you can also provide the specification in YAML format.
BodyS3Location
The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
public virtual object BodyS3Location { get; set; }
Property Value
System.Object
Remarks
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
CloneFrom
The ID of the RestApi
resource that you want to clone.
public virtual string CloneFrom { get; set; }
Property Value
System.String
Remarks
Description
A description of the RestApi
resource.
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.
EndpointConfiguration
A list of the endpoint types of the API.
public virtual object EndpointConfiguration { get; set; }
Property Value
System.Object
Remarks
Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters
property.
FailOnWarnings
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi
resource.
public virtual object FailOnWarnings { get; set; }
Property Value
System.Object
Remarks
MinimumCompressionSize
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.
public virtual Nullable<double> MinimumCompressionSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Mode
This property applies only when you use OpenAPI to define your REST API.
public virtual string Mode { get; set; }
Property Value
System.String
Remarks
The Mode
determines how API Gateway handles resource updates.
Valid values are overwrite
or merge
.
For overwrite
, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge
, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use merge
to define top-level RestApi
properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite
. Otherwise, the default value is merge
.
Name
A name for the RestApi
resource.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Parameters
Custom header parameters for the request.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
Policy
A policy document that contains the permissions for the RestApi
resource.
public virtual object Policy { get; set; }
Property Value
System.Object
Remarks
To set the ARN for the policy, use the !Join
intrinsic function with ""
as delimiter and values of "execute-api:/"
and "*"
.
Tags
An array of arbitrary tags (key-value pairs) to associate with the API.
public virtual TagManager Tags { get; }
Property Value
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>