SpecRestApiProps Struct
Props to instantiate a new SpecRestApi.
Example
const api = new apigateway.SpecRestApi(this, 'books-api', {
apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json'),
mode: apigateway.RestApiMode.MERGE
});
Properties
apiDefinitionApiDefinitionapi_definitionApiDefinitionapiDefinitionApiDefinitionApiDefinitionApiDefinitionApiDefinitionApiDefinitionrequired#binaryMediaTypesoptionalstring[]binary_media_typesoptionaltyping.List[str]binaryMediaTypesoptionalList<String>BinaryMediaTypesoptionalstring[]BinaryMediaTypesoptional*[]*string#Default: SpecRestApi supports only UTF-8-encoded text payloads.
cloudWatchRoleoptionalbooleancloud_watch_roleoptionalboolcloudWatchRoleoptionalBooleanCloudWatchRoleoptionalboolCloudWatchRoleoptional*bool#Default: false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise
cloudWatchRoleRemovalPolicyoptionalRemovalPolicycloud_watch_role_removal_policyoptionalRemovalPolicycloudWatchRoleRemovalPolicyoptionalRemovalPolicyCloudWatchRoleRemovalPolicyoptionalRemovalPolicyCloudWatchRoleRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#Requires cloudWatchRole to be enabled.
deployoptionalbooleandeployoptionalbooldeployoptionalBooleanDeployoptionalboolDeployoptional*bool= true#notes
Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.
If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.
A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
deployOptionsoptionalStageOptionsdeploy_optionsoptionalStageOptionsdeployOptionsoptionalStageOptionsDeployOptionsoptionalStageOptionsDeployOptionsoptionalStageOptions#Default: Based on defaults of StageOptions.
If deploy is disabled, this value cannot be set.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: 'Automatically created by the RestApi construct'
disableExecuteApiEndpointoptionalbooleandisable_execute_api_endpointoptionalbooldisableExecuteApiEndpointoptionalBooleanDisableExecuteApiEndpointoptionalboolDisableExecuteApiEndpointoptional*bool= false#To require that clients use a custom domain name to invoke the API, disable the default endpoint.
domainNameoptionalDomainNameOptionsdomain_nameoptionalDomainNameOptionsdomainNameoptionalDomainNameOptionsDomainNameoptionalDomainNameOptionsDomainNameoptionalDomainNameOptions#Default: no domain name is defined, use addDomainName or directly define a DomainName.
endpointConfigurationoptionalEndpointConfigurationendpoint_configurationoptionalEndpointConfigurationendpointConfigurationoptionalEndpointConfigurationEndpointConfigurationoptionalEndpointConfigurationEndpointConfigurationoptionalEndpointConfiguration= EndpointType.EDGE#endpointExportNameoptionalstringendpoint_export_nameoptionalstrendpointExportNameoptionalStringEndpointExportNameoptionalstringEndpointExportNameoptional*string#Default: when no export name is given, output will be created without export
endpointTypesoptionalEndpointType[]endpoint_typesoptionaltyping.List[EndpointType]endpointTypesoptionalList<EndpointType>EndpointTypesoptionalEndpointType[]EndpointTypesoptional*[]EndpointType= EndpointType.EDGE#Use this property when creating an API.
failOnWarningsoptionalbooleanfail_on_warningsoptionalboolfailOnWarningsoptionalBooleanFailOnWarningsoptionalboolFailOnWarningsoptional*bool= false#minCompressionSizeoptionalSizemin_compression_sizeoptionalSizeminCompressionSizeoptionalSizeMinCompressionSizeoptionalSizeMinCompressionSizeoptionalSize#Default: Compression is disabled.
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.
modeoptionalRestApiModemodeoptionalRestApiModemodeoptionalRestApiModeModeoptionalRestApiModeModeoptionalRestApiMode#Default: merge for REST APIs created after March 29, 2021, otherwise overwrite
notes
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.
parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string#Default: No parameters.
policyoptionalPolicyDocumentpolicyoptionalPolicyDocumentpolicyoptionalPolicyDocumentPolicyoptionalPolicyDocumentPolicyoptionalPolicyDocument#Default: No policy.
restApiNameoptionalstringrest_api_nameoptionalstrrestApiNameoptionalStringRestApiNameoptionalstringRestApiNameoptional*string#Default: ID of the RestApi construct.
retainDeploymentsoptionalbooleanretain_deploymentsoptionalboolretainDeploymentsoptionalBooleanRetainDeploymentsoptionalboolRetainDeploymentsoptional*bool= false#This allows manually reverting stages to point to old deployments via the AWS Console.