Package software.amazon.awscdk.services.apigateway

Class CfnRestApi

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigateway.CfnRestApi
All Implemented Interfaces:
IInspectable, ITaggable, IRestApiRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:04.075Z") @Stability(Stable) public class CfnRestApi extends CfnResource implements IInspectable, IRestApiRef, ITaggable
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.

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;
 CfnRestApi cfnRestApi = CfnRestApi.Builder.create(this, "MyCfnRestApi")
         .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)
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRestApi

      protected CfnRestApi(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRestApi

      protected CfnRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRestApi

      @Stability(Stable) public CfnRestApi(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnRestApiProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnRestApi

      @Stability(Stable) public CfnRestApi(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromRestApiId

      @Stability(Stable) @NotNull public static IRestApiRef fromRestApiId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String restApiId)
      Creates a new IRestApiRef from a restApiId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      restApiId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRestApiId

      @Stability(Stable) @NotNull public String getAttrRestApiId()
      The string identifier of the associated RestApi.

    • getAttrRootResourceId

      @Stability(Stable) @NotNull public String getAttrRootResourceId()
      The root resource ID for a RestApi resource, such as a0bc123d4e .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRestApiRef

      @Stability(Stable) @NotNull public RestApiReference getRestApiRef()
      A reference to a RestApi resource.
      Specified by:
      getRestApiRef in interface IRestApiRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getApiKeySourceType

      @Stability(Stable) @Nullable public String getApiKeySourceType()
      The source of the API key for metering requests according to a usage plan.

    • setApiKeySourceType

      @Stability(Stable) public void setApiKeySourceType(@Nullable String value)
      The source of the API key for metering requests according to a usage plan.

    • getBinaryMediaTypes

      @Stability(Stable) @Nullable public List<String> getBinaryMediaTypes()
      The list of binary media types supported by the RestApi.

    • setBinaryMediaTypes

      @Stability(Stable) public void setBinaryMediaTypes(@Nullable List<String> value)
      The list of binary media types supported by the RestApi.

    • getBody

      @Stability(Stable) @Nullable public Object getBody()
      An OpenAPI specification that defines a set of RESTful APIs in JSON format.

    • setBody

      @Stability(Stable) public void setBody(@Nullable Object value)
      An OpenAPI specification that defines a set of RESTful APIs in JSON format.

    • getBodyS3Location

      @Stability(Stable) @Nullable public 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.

    • setBodyS3Location

      @Stability(Stable) public void setBodyS3Location(@Nullable IResolvable value)
      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.

    • setBodyS3Location

      @Stability(Stable) public void setBodyS3Location(@Nullable CfnRestApi.S3LocationProperty value)
      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.

    • getCloneFrom

      @Stability(Stable) @Nullable public String getCloneFrom()
      The ID of the RestApi that you want to clone from.

    • setCloneFrom

      @Stability(Stable) public void setCloneFrom(@Nullable String value)
      The ID of the RestApi that you want to clone from.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the RestApi.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the RestApi.

    • getDisableExecuteApiEndpoint

      @Stability(Stable) @Nullable public Object getDisableExecuteApiEndpoint()
      Specifies whether clients can invoke your API by using the default execute-api endpoint.

    • setDisableExecuteApiEndpoint

      @Stability(Stable) public void setDisableExecuteApiEndpoint(@Nullable Boolean value)
      Specifies whether clients can invoke your API by using the default execute-api endpoint.

    • setDisableExecuteApiEndpoint

      @Stability(Stable) public void setDisableExecuteApiEndpoint(@Nullable IResolvable value)
      Specifies whether clients can invoke your API by using the default execute-api endpoint.

    • getEndpointConfiguration

      @Stability(Stable) @Nullable public Object getEndpointConfiguration()
      A list of the endpoint types and IP address types of the API.

    • setEndpointConfiguration

      @Stability(Stable) public void setEndpointConfiguration(@Nullable IResolvable value)
      A list of the endpoint types and IP address types of the API.

    • setEndpointConfiguration

      @Stability(Stable) public void setEndpointConfiguration(@Nullable CfnRestApi.EndpointConfigurationProperty value)
      A list of the endpoint types and IP address types of the API.

    • getFailOnWarnings

      @Stability(Stable) @Nullable public Object getFailOnWarnings()
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

    • setFailOnWarnings

      @Stability(Stable) public void setFailOnWarnings(@Nullable Boolean value)
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

    • setFailOnWarnings

      @Stability(Stable) public void setFailOnWarnings(@Nullable IResolvable value)
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

    • getMinimumCompressionSize

      @Stability(Stable) @Nullable public 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.

    • setMinimumCompressionSize

      @Stability(Stable) public void setMinimumCompressionSize(@Nullable Number value)
      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.

    • getMode

      @Stability(Stable) @Nullable public String getMode()
      This property applies only when you use OpenAPI to define your REST API.

    • setMode

      @Stability(Stable) public void setMode(@Nullable String value)
      This property applies only when you use OpenAPI to define your REST API.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the RestApi.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the RestApi.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      Custom header parameters as part of the request.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Map<String,String> value)
      Custom header parameters as part of the request.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      Custom header parameters as part of the request.

    • getPolicy

      @Stability(Stable) @Nullable public Object getPolicy()
      A policy document that contains the permissions for the RestApi resource.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable Object value)
      A policy document that contains the permissions for the RestApi resource.

    • getSecurityPolicy

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

    • setSecurityPolicy

      @Stability(Stable) public void setSecurityPolicy(@Nullable String value)

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The key-value map of strings.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The key-value map of strings.