class CfnRestApi (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.CfnRestApi |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnRestApi |
 Java | software.amazon.awscdk.services.apigateway.CfnRestApi |
 Python | aws_cdk.aws_apigateway.CfnRestApi |
 TypeScript | aws-cdk-lib » aws_apigateway » CfnRestApi |
Implements
IConstruct, IDependable, IInspectable, 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.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const body: any;
declare const policy: any;
const cfnRestApi = new apigateway.CfnRestApi(this, 'MyCfnRestApi', /* all optional props */ {
apiKeySourceType: 'apiKeySourceType',
binaryMediaTypes: ['binaryMediaTypes'],
body: body,
bodyS3Location: {
bucket: 'bucket',
eTag: 'eTag',
key: 'key',
version: 'version',
},
cloneFrom: 'cloneFrom',
description: 'description',
disableExecuteApiEndpoint: false,
endpointConfiguration: {
types: ['types'],
vpcEndpointIds: ['vpcEndpointIds'],
},
failOnWarnings: false,
minimumCompressionSize: 123,
mode: 'mode',
name: 'name',
parameters: {
parametersKey: 'parameters',
},
policy: policy,
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnRestApi(scope: Construct, id: string, props?: CfnRestApiProps)
Parameters
- scope
Construct— Scope in which this resource is defined. - id
string— Construct identifier for this resource (unique in its scope). - props
Cfn— Resource properties.Rest Api Props
Construct Props
| Name | Type | Description |
|---|---|---|
| api | string | The source of the API key for metering requests according to a usage plan. |
| binary | string[] | The list of binary media types supported by the RestApi. |
| body? | any | An OpenAPI specification that defines a set of RESTful APIs in JSON format. |
| body | IResolvable | S3 | 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. |
| clone | string | The ID of the RestApi that you want to clone from. |
| description? | string | The description of the RestApi. |
| disable | boolean | IResolvable | Specifies whether clients can invoke your API by using the default execute-api endpoint. |
| endpoint | IResolvable | Endpoint | A list of the endpoint types of the API. |
| fail | boolean | IResolvable | A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered. |
| minimum | number | 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? | string | This property applies only when you use OpenAPI to define your REST API. |
| name? | string | The name of the RestApi. |
| parameters? | IResolvable | { [string]: string } | Custom header parameters as part of the request. |
| policy? | any | A policy document that contains the permissions for the RestApi resource. |
| tags? | Cfn[] | The key-value map of strings. |
apiKeySourceType?
Type:
string
(optional)
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.
binaryMediaTypes?
Type:
string[]
(optional)
The list of binary media types supported by the RestApi.
By default, the RestApi supports only UTF-8-encoded text payloads.
body?
Type:
any
(optional)
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.
bodyS3Location?
Type:
IResolvable | S3
(optional)
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?
Type:
string
(optional)
The ID of the RestApi that you want to clone from.
description?
Type:
string
(optional)
The description of the RestApi.
disableExecuteApiEndpoint?
Type:
boolean | IResolvable
(optional)
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
endpointConfiguration?
Type:
IResolvable | Endpoint
(optional)
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.
failOnWarnings?
Type:
boolean | IResolvable
(optional)
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 .
minimumCompressionSize?
Type:
number
(optional)
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.
mode?
Type:
string
(optional)
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.
name?
Type:
string
(optional)
The name of the RestApi.
A name is required if the REST API is not based on an OpenAPI specification.
parameters?
Type:
IResolvable | { [string]: string }
(optional)
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' .
policy?
Type:
any
(optional)
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 "*" .
tags?
Type:
Cfn[]
(optional)
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.
Properties
| Name | Type | Description |
|---|---|---|
| attr | string | The string identifier of the associated RestApi. |
| attr | string | The root resource ID for a RestApi resource, such as a0bc123d4e . |
| cfn | ICfn | Options for this resource, such as condition, update policy etc. |
| cfn | { [string]: any } | |
| cfn | string | AWS resource type. |
| creation | string[] | |
| logical | string | The logical ID for this CloudFormation stack element. |
| node | Node | The tree node. |
| ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
| stack | Stack | The stack in which this element is defined. |
| tags | Tag | Tag Manager which manages the tags for this resource. |
| api | string | The source of the API key for metering requests according to a usage plan. |
| binary | string[] | The list of binary media types supported by the RestApi. |
| body? | any | An OpenAPI specification that defines a set of RESTful APIs in JSON format. |
| body | IResolvable | S3 | 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. |
| clone | string | The ID of the RestApi that you want to clone from. |
| description? | string | The description of the RestApi. |
| disable | boolean | IResolvable | Specifies whether clients can invoke your API by using the default execute-api endpoint. |
| endpoint | IResolvable | Endpoint | A list of the endpoint types of the API. |
| fail | boolean | IResolvable | A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered. |
| minimum | number | 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? | string | This property applies only when you use OpenAPI to define your REST API. |
| name? | string | The name of the RestApi. |
| parameters? | IResolvable | { [string]: string } | Custom header parameters as part of the request. |
| policy? | any | A policy document that contains the permissions for the RestApi resource. |
| tags | Cfn[] | The key-value map of strings. |
| static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrRestApiId
Type:
string
The string identifier of the associated RestApi.
attrRootResourceId
Type:
string
The root resource ID for a RestApi resource, such as a0bc123d4e .
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
apiKeySourceType?
Type:
string
(optional)
The source of the API key for metering requests according to a usage plan.
binaryMediaTypes?
Type:
string[]
(optional)
The list of binary media types supported by the RestApi.
body?
Type:
any
(optional)
An OpenAPI specification that defines a set of RESTful APIs in JSON format.
bodyS3Location?
Type:
IResolvable | S3
(optional)
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?
Type:
string
(optional)
The ID of the RestApi that you want to clone from.
description?
Type:
string
(optional)
The description of the RestApi.
disableExecuteApiEndpoint?
Type:
boolean | IResolvable
(optional)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
endpointConfiguration?
Type:
IResolvable | Endpoint
(optional)
A list of the endpoint types of the API.
failOnWarnings?
Type:
boolean | IResolvable
(optional)
A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.
minimumCompressionSize?
Type:
number
(optional)
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?
Type:
string
(optional)
This property applies only when you use OpenAPI to define your REST API.
name?
Type:
string
(optional)
The name of the RestApi.
parameters?
Type:
IResolvable | { [string]: string }
(optional)
Custom header parameters as part of the request.
policy?
Type:
any
(optional)
A policy document that contains the permissions for the RestApi resource.
tagsRaw?
Type:
Cfn[]
(optional)
The key-value map of strings.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
| Name | Description |
|---|---|
| add | Syntactic sugar for addOverride(path, undefined). |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Add a value to the CloudFormation Resource Metadata. |
| add | Adds an override to the synthesized CloudFormation resource. |
| add | Adds an override that deletes the value of a property from the resource definition. |
| add | Adds an override to a resource property. |
| apply | Sets the deletion policy of the resource based on the removal policy specified. |
| get | Returns a token for an runtime attribute of this resource. |
| get | Retrieve a value value from the CloudFormation Resource Metadata. |
| inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
| obtain | Retrieves an array of resources this resource depends on. |
| obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
| override | Overrides the auto-generated logical ID with a specific ID. |
| remove | Indicates that this resource no longer depends on another resource. |
| replace | Replaces one dependency with another. |
| to | Returns a string representation of this construct. |
| protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined).
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string - value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string— - The path of the property, you can use dot notation to override values in complex types. - value
any— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
\ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string— The path of the property. - value
any— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
RemovalPolicy - options
RemovalPolicy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string— The name of the attribute. - typeHint
ResolutionType Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack|CfnResource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn— The dependency to replace.Resource - newTarget
Cfn— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }