CfnRestApi

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.apigateway.CfnRestApi

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.540Z")
public class CfnRestApi
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::RestApi`.

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()
                 .types(List.of("types"))
                 .vpcEndpointIds(List.of("vpcEndpointIds"))
                 .build())
         .failOnWarnings(false)
         .minimumCompressionSize(123)
         .mode("mode")
         .name("name")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .policy(policy)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnRestApi.Builder` A fluent builder for `CfnRestApi`.
`static interface`	`CfnRestApi.EndpointConfigurationProperty` The `EndpointConfiguration` property type specifies the endpoint types of a REST API.
`static interface`	`CfnRestApi.S3LocationProperty` `S3Location` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnRestApi(Construct scope, java.lang.String id)` Create a new `AWS::ApiGateway::RestApi`.
	`CfnRestApi(Construct scope, java.lang.String id, CfnRestApiProps props)` Create a new `AWS::ApiGateway::RestApi`.
`protected`	`CfnRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnRestApi(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApiKeySourceType()` The source of the API key for metering requests according to a usage plan.
`java.lang.String`	`getAttrRestApiId()` The string identifier of the associated RestApi.
`java.lang.String`	`getAttrRootResourceId()` The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
`java.util.List<java.lang.String>`	`getBinaryMediaTypes()` The list of binary media types supported by the RestApi.
`java.lang.Object`	`getBody()` An OpenAPI specification that defines a set of RESTful APIs in JSON format.
`java.lang.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.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getCloneFrom()` The ID of the RestApi that you want to clone from.
`java.lang.String`	`getDescription()` The description of the RestApi.
`java.lang.Object`	`getDisableExecuteApiEndpoint()` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`java.lang.Object`	`getEndpointConfiguration()` A list of the endpoint types of the API.
`java.lang.Object`	`getFailOnWarnings()` A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered.
`java.lang.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.
`java.lang.String`	`getMode()` This property applies only when you use OpenAPI to define your REST API.
`java.lang.String`	`getName()` The name of the RestApi.
`java.lang.Object`	`getParameters()` Custom header parameters as part of the request.
`java.lang.Object`	`getPolicy()` A policy document that contains the permissions for the `RestApi` resource.
`TagManager`	`getTags()` The key-value map of strings.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setApiKeySourceType(java.lang.String value)` The source of the API key for metering requests according to a usage plan.
`void`	`setBinaryMediaTypes(java.util.List<java.lang.String> value)` The list of binary media types supported by the RestApi.
`void`	`setBody(java.lang.Object value)` An OpenAPI specification that defines a set of RESTful APIs in JSON format.
`void`	`setBodyS3Location(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.
`void`	`setBodyS3Location(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.
`void`	`setCloneFrom(java.lang.String value)` The ID of the RestApi that you want to clone from.
`void`	`setDescription(java.lang.String value)` The description of the RestApi.
`void`	`setDisableExecuteApiEndpoint(java.lang.Boolean value)` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`void`	`setDisableExecuteApiEndpoint(IResolvable value)` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`void`	`setEndpointConfiguration(CfnRestApi.EndpointConfigurationProperty value)` A list of the endpoint types of the API.
`void`	`setEndpointConfiguration(IResolvable value)` A list of the endpoint types of the API.
`void`	`setFailOnWarnings(java.lang.Boolean value)` A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered.
`void`	`setFailOnWarnings(IResolvable value)` A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered.
`void`	`setMinimumCompressionSize(java.lang.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.
`void`	`setMode(java.lang.String value)` This property applies only when you use OpenAPI to define your REST API.
`void`	`setName(java.lang.String value)` The name of the RestApi.
`void`	`setParameters(IResolvable value)` Custom header parameters as part of the request.
`void`	`setParameters(java.util.Map<java.lang.String,java.lang.String> value)` Custom header parameters as part of the request.
`void`	`setPolicy(java.lang.Object value)` A policy document that contains the permissions for the `RestApi` resource.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnRestApi
```
protected CfnRestApi(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnRestApi
```
protected CfnRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnRestApi
```
public CfnRestApi(Construct scope,
                  java.lang.String id,
                  CfnRestApiProps props)
```
    Create a new `AWS::ApiGateway::RestApi`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnRestApi
```
public CfnRestApi(Construct scope,
                  java.lang.String id)
```
    Create a new `AWS::ApiGateway::RestApi`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrRestApiId
```
public java.lang.String getAttrRestApiId()
```
    The string identifier of the associated RestApi.
  - getAttrRootResourceId
```
public java.lang.String getAttrRootResourceId()
```
    The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager 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.
  - getBody
```
public java.lang.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.
  - setBody
```
public void setBody(java.lang.Object value)
```
    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.
  - getPolicy
```
public java.lang.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 "*" .
  - setPolicy
```
public void setPolicy(java.lang.Object value)
```
    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 "*" .
  - getApiKeySourceType
```
public java.lang.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.
  - setApiKeySourceType
```
public void setApiKeySourceType(java.lang.String value)
```
    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.
  - getBinaryMediaTypes
```
public java.util.List<java.lang.String> getBinaryMediaTypes()
```
    The list of binary media types supported by the RestApi.
    By default, the RestApi supports only UTF-8-encoded text payloads.
  - setBinaryMediaTypes
```
public void setBinaryMediaTypes(java.util.List<java.lang.String> value)
```
    The list of binary media types supported by the RestApi.
    By default, the RestApi supports only UTF-8-encoded text payloads.
  - getBodyS3Location
```
public java.lang.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
```
public void setBodyS3Location(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
```
public void setBodyS3Location(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
```
public java.lang.String getCloneFrom()
```
    The ID of the RestApi that you want to clone from.
  - setCloneFrom
```
public void setCloneFrom(java.lang.String value)
```
    The ID of the RestApi that you want to clone from.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the RestApi.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the RestApi.
  - getDisableExecuteApiEndpoint
```
public java.lang.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
  - setDisableExecuteApiEndpoint
```
public void setDisableExecuteApiEndpoint(java.lang.Boolean value)
```
    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
  - setDisableExecuteApiEndpoint
```
public void setDisableExecuteApiEndpoint(IResolvable value)
```
    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
  - getEndpointConfiguration
```
public java.lang.Object getEndpointConfiguration()
```
    A list of the endpoint 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.
  - setEndpointConfiguration
```
public void setEndpointConfiguration(IResolvable value)
```
    A list of the endpoint 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.
  - setEndpointConfiguration
```
public void setEndpointConfiguration(CfnRestApi.EndpointConfigurationProperty value)
```
    A list of the endpoint 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.
  - getFailOnWarnings
```
public java.lang.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 .
  - setFailOnWarnings
```
public void setFailOnWarnings(java.lang.Boolean value)
```
    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 .
  - setFailOnWarnings
```
public void setFailOnWarnings(IResolvable value)
```
    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 .
  - getMinimumCompressionSize
```
public java.lang.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.
  - setMinimumCompressionSize
```
public void setMinimumCompressionSize(java.lang.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.
    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.
  - getMode
```
public java.lang.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 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 .
  - setMode
```
public void setMode(java.lang.String value)
```
    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 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 .
  - getName
```
public java.lang.String getName()
```
    The name of the RestApi.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the RestApi.
  - getParameters
```
public java.lang.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' .
  - setParameters
```
public void setParameters(IResolvable value)
```
    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' .
  - setParameters
```
public void setParameters(java.util.Map<java.lang.String,java.lang.String> value)
```
    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' .

Class CfnRestApi

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnRestApi

CfnRestApi

CfnRestApi

CfnRestApi

Method Detail

inspect

renderProperties

getAttrRestApiId

getAttrRootResourceId

getCfnProperties

getTags

getBody

setBody

getPolicy

setPolicy

getApiKeySourceType

setApiKeySourceType

getBinaryMediaTypes

setBinaryMediaTypes

getBodyS3Location

setBodyS3Location

setBodyS3Location

getCloneFrom

setCloneFrom

getDescription

setDescription

getDisableExecuteApiEndpoint

setDisableExecuteApiEndpoint

setDisableExecuteApiEndpoint

getEndpointConfiguration

setEndpointConfiguration

setEndpointConfiguration

getFailOnWarnings

setFailOnWarnings

setFailOnWarnings

getMinimumCompressionSize

setMinimumCompressionSize

getMode

setMode

getName

setName

getParameters

setParameters

setParameters