SpecRestApiProps
- class aws_cdk.aws_apigateway.SpecRestApiProps(*, cloud_watch_role=None, deploy=None, deploy_options=None, disable_execute_api_endpoint=None, domain_name=None, endpoint_export_name=None, endpoint_types=None, fail_on_warnings=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None, api_definition)
Bases:
RestApiBaseProps
Props to instantiate a new SpecRestApi.
- Parameters
cloud_watch_role (
Optional
[bool
]) – Automatically configure an AWS CloudWatch role for API Gateway. Default: truedeploy (
Optional
[bool
]) – Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. 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 theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: truedeploy_options (
Union
[StageOptions
,Dict
[str
,Any
],None
]) – Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled. Ifdeploy
is disabled, this value cannot be set. Default: - Based on defaults ofStageOptions
.disable_execute_api_endpoint (
Optional
[bool
]) – Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: falsedomain_name (
Union
[DomainNameOptions
,Dict
[str
,Any
],None
]) – Configure a custom domain name and map it to this API. Default: - no domain name is defined, useaddDomainName
or directly define aDomainName
.endpoint_export_name (
Optional
[str
]) – Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without exportendpoint_types (
Optional
[Sequence
[EndpointType
]]) – A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGEfail_on_warnings (
Optional
[bool
]) – Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: falseparameters (
Optional
[Mapping
[str
,str
]]) – Custom header parameters for the request. Default: - No parameters.policy (
Optional
[PolicyDocument
]) – A policy document that contains the permissions for this RestApi. Default: - No policy.rest_api_name (
Optional
[str
]) – A name for the API Gateway RestApi resource. Default: - ID of the RestApi construct.retain_deployments (
Optional
[bool
]) – Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. Default: falseapi_definition (
ApiDefinition
) – An OpenAPI definition compatible with API Gateway.
- ExampleMetadata
infused
Example:
# integration: apigateway.Integration api = apigateway.SpecRestApi(self, "books-api", api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json") ) books_resource = api.root.add_resource("books") books_resource.add_method("GET", integration)
Attributes
- api_definition
An OpenAPI definition compatible with API Gateway.
- cloud_watch_role
Automatically configure an AWS CloudWatch role for API Gateway.
- Default
true
- deploy
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
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 theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property.A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
- Default
true
- deploy_options
Options for the API Gateway stage that will always point to the latest deployment when
deploy
is enabled.If
deploy
is disabled, this value cannot be set.- Default
Based on defaults of
StageOptions
.
- disable_execute_api_endpoint
Specifies whether clients can invoke the API using the default execute-api endpoint.
To require that clients use a custom domain name to invoke the API, disable the default endpoint.
- domain_name
Configure a custom domain name and map it to this API.
- Default
no domain name is defined, use
addDomainName
or directly define aDomainName
.
- endpoint_export_name
Export name for the CfnOutput containing the API endpoint.
- Default
when no export name is given, output will be created without export
- endpoint_types
A list of the endpoint types of the API.
Use this property when creating an API.
- Default
EndpointType.EDGE
- fail_on_warnings
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
- Default
false
- parameters
Custom header parameters for the request.
- Default
No parameters.
- See
https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
- policy
A policy document that contains the permissions for this RestApi.
- Default
No policy.
- rest_api_name
A name for the API Gateway RestApi resource.
- Default
ID of the RestApi construct.
- retain_deployments
Retains old deployment resources when the API changes.
This allows manually reverting stages to point to old deployments via the AWS Console.
- Default
false