Interface ICfnRestApiProps

Properties for defining a CfnRestApi.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnRestApiProps

Syntax (vb)

Public Interface ICfnRestApiProps

Remarks

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;

var cfnRestApiProps = 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

Properties

ApiKeySourceType	The source of the API key for metering requests according to a usage plan.
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.
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 `execute-api` endpoint.
EndpointConfiguration	A list of the endpoint types of the API.
FailOnWarnings	A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered.
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 `RestApi` resource.
Tags	The key-value map of strings.

Properties

ApiKeySourceType

The source of the API key for metering requests according to a usage plan.

virtual string ApiKeySourceType { get; }

Property Value

System.String

Remarks

Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype

BinaryMediaTypes

The list of binary media types supported by the RestApi.

virtual string[] BinaryMediaTypes { get; }

Property Value

System.String[]

Remarks

By default, the RestApi supports only UTF-8-encoded text payloads.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes

Body

An OpenAPI specification that defines a set of RESTful APIs in JSON format.

virtual object Body { get; }

Property Value

System.Object

Remarks

For YAML templates, you can also provide the specification in YAML format.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body

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.

virtual object BodyS3Location { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location

CloneFrom

The ID of the RestApi that you want to clone from.

virtual string CloneFrom { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom

Description

The description of the RestApi.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint

EndpointConfiguration

A list of the endpoint types of the API.

virtual object EndpointConfiguration { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration

FailOnWarnings

A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

virtual object FailOnWarnings { get; }

Property Value

System.Object

Remarks

The default value is false .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings

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.

virtual Nullable<double> MinimumCompressionSize { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize

Mode

This property applies only when you use OpenAPI to define your REST API.

virtual string Mode { get; }

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode

Name

The name of the RestApi.

virtual string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name

Parameters

Custom header parameters as part of the request.

virtual object Parameters { get; }

Property Value

System.Object

Remarks

For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters

Policy

A policy document that contains the permissions for the RestApi resource.

virtual object Policy { get; }

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 "*" .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy