Class CfnRestApi
The AWS::ApiGateway::RestApi
resource creates a REST API.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRestApi : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnRestApi
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
CloudformationResource: AWS::ApiGateway::RestApi
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;
var 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(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 |
CfnRestApi(Construct, String, ICfnRestApiProps) |
Properties
ApiKeySourceType | The source of the API key for metering requests according to a usage plan. |
AttrRestApiId | The string identifier of the associated RestApi. |
AttrRootResourceId | The root resource ID for a |
BinaryMediaTypes | The list of binary media types supported by the RestApi. |
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 RestApi that you want to clone from. |
Description | The description of the RestApi. |
DisableExecuteApiEndpoint | Specifies whether clients can invoke your API by using the default |
EndpointConfiguration | A list of the endpoint types of the API. |
FailOnWarnings | A query parameter to indicate whether to rollback the API update ( |
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 | The name of the RestApi. |
Parameters | Custom header parameters as part of the request. |
Policy | A policy document that contains the permissions for the |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The key-value map of strings. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnRestApi(Construct, String, ICfnRestApiProps)
public CfnRestApi(Construct scope, string id, ICfnRestApiProps 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 ICfnRestApiProps
Resource properties.
Properties
ApiKeySourceType
The source of the API key for metering requests according to a usage plan.
public virtual string ApiKeySourceType { get; set; }
Property Value
System.String
AttrRestApiId
The string identifier of the associated RestApi.
public virtual string AttrRestApiId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RestApiId
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 supported by the RestApi.
public virtual string[] BinaryMediaTypes { get; set; }
Property Value
System.String[]
Body
An OpenAPI specification that defines a set of RESTful APIs in JSON format.
public virtual object Body { get; set; }
Property Value
System.Object
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
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 that you want to clone from.
public virtual string CloneFrom { get; set; }
Property Value
System.String
Description
The description of the RestApi.
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
EndpointConfiguration
A list of the endpoint types of the API.
public virtual object EndpointConfiguration { get; set; }
Property Value
System.Object
FailOnWarnings
A query parameter to indicate whether to rollback the API update ( true
) or not ( false
) when a warning is encountered.
public virtual object FailOnWarnings { get; set; }
Property Value
System.Object
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>
Mode
This property applies only when you use OpenAPI to define your REST API.
public virtual string Mode { get; set; }
Property Value
System.String
Name
The name of the RestApi.
public virtual string Name { get; set; }
Property Value
System.String
Parameters
Custom header parameters as part of the request.
public virtual object Parameters { get; set; }
Property Value
System.Object
Policy
A policy document that contains the permissions for the RestApi
resource.
public virtual object Policy { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The key-value map of strings.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>