Package software.amazon.awscdk.services.apigateway

Interface CfnRestApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T10:47:11.472Z")
@Stability(Stable)
public interface CfnRestApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRestApi.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Object body;
 Object policy;
 CfnRestApiProps cfnRestApiProps = CfnRestApiProps.builder()
         .apiKeySourceType("apiKeySourceType")
         .binaryMediaTypes(List.of("binaryMediaTypes"))
         .body(body)
         .bodyS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .eTag("eTag")
                 .key("key")
                 .version("version")
                 .build())
         .cloneFrom("cloneFrom")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .endpointAccessMode("endpointAccessMode")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .ipAddressType("ipAddressType")
                 .types(List.of("types"))
                 .vpcEndpointIds(List.of("vpcEndpointIds"))
                 .build())
         .failOnWarnings(false)
         .minimumCompressionSize(123)
         .mode("mode")
         .name("name")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .policy(policy)
         .securityPolicy("securityPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRestApiProps.Builder	A builder for CfnRestApiProps
static final class	CfnRestApiProps.Jsii$Proxy	An implementation for CfnRestApiProps

Method Summary

Modifier and Type	Method	Description
static CfnRestApiProps.Builder	builder()
default String	getApiKeySourceType()	The source of the API key for metering requests according to a usage plan.
default List<String>	getBinaryMediaTypes()	The list of binary media types supported by the RestApi.
default Object	getBody()	An OpenAPI specification that defines a set of RESTful APIs in JSON format.
default Object	getBodyS3Location()	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.
default Object	getCloneFrom()	The ID of the RestApi that you want to clone from.
default String	getDescription()	The description of the RestApi.
default Object	getDisableExecuteApiEndpoint()	Specifies whether clients can invoke your API by using the default execute-api endpoint.
default String	getEndpointAccessMode()	The endpoint access mode for your RestApi.
default Object	getEndpointConfiguration()	A list of the endpoint types and IP address types of the API.
default Object	getFailOnWarnings()	A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.
default Number	getMinimumCompressionSize()	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.
default String	getMode()	This property applies only when you use OpenAPI to define your REST API.
default String	getName()	The name of the RestApi.
default Object	getParameters()	Custom header parameters as part of the request.
default Object	getPolicy()	A policy document that contains the permissions for the RestApi resource.
default String	getSecurityPolicy()	The Transport Layer Security (TLS) version + cipher suite for this RestApi.
default List<CfnTag>	getTags()	The key-value map of strings.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeySourceType

@Stability(Stable)
@Nullable
default String getApiKeySourceType()

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

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.

See Also:

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

getBinaryMediaTypes

@Stability(Stable)
@Nullable
default List<String> getBinaryMediaTypes()

The list of binary media types supported by the RestApi.

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

See Also:

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

getBody

@Stability(Stable)
@Nullable
default Object getBody()

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

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

See Also:

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

getBodyS3Location

@Stability(Stable)
@Nullable
default Object getBodyS3Location()

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.

Returns union: either IResolvable or CfnRestApi.S3LocationProperty

See Also:

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

getCloneFrom

@Stability(Stable)
@Nullable
default Object getCloneFrom()

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

Returns union: either String or IRestApiRef

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the RestApi.

See Also:

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

getDisableExecuteApiEndpoint

@Stability(Stable)
@Nullable
default Object getDisableExecuteApiEndpoint()

Specifies whether clients can invoke your API by using the default execute-api endpoint.

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

Returns union: either Boolean or IResolvable

See Also:

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

getEndpointAccessMode

@Stability(Stable)
@Nullable
default String getEndpointAccessMode()

The endpoint access mode for your RestApi.

See Also:

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

getEndpointConfiguration

@Stability(Stable)
@Nullable
default Object getEndpointConfiguration()

A list of the endpoint types and IP address types of the API.

Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.

Returns union: either IResolvable or CfnRestApi.EndpointConfigurationProperty

See Also:

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

getFailOnWarnings

@Stability(Stable)
@Nullable
default Object getFailOnWarnings()

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

The default value is false .

Returns union: either Boolean or IResolvable

See Also:

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

getMinimumCompressionSize

@Stability(Stable)
@Nullable
default Number getMinimumCompressionSize()

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.

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.

See Also:

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

getMode

@Stability(Stable)
@Nullable
default String getMode()

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

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 is merged with the existing API.

If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite . For REST APIs created after March 29, 2021, 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 the default mode 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.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the RestApi.

A name is required if the REST API is not based on an OpenAPI specification.

See Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

Custom header parameters as part of the request.

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' .

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getPolicy

@Stability(Stable)
@Nullable
default Object getPolicy()

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

To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*" .

See Also:

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

getSecurityPolicy

@Stability(Stable)
@Nullable
default String getSecurityPolicy()

The Transport Layer Security (TLS) version + cipher suite for this RestApi.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The key-value map of strings.

The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

See Also:

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

builder

@Stability(Stable)
static CfnRestApiProps.Builder builder()

Returns:

a CfnRestApiProps.Builder of CfnRestApiProps