api tool config 1.0.1¶
Description¶
Documentation of the config file format for api (a fink tool). Note: if you want to add to the documentation please edit the openapi_api_gateway.yaml file!
Data Structures¶
api - structure¶
The api tool config is organized into the following structure:
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| api | Yes | api_def | |||
| customDomain | No | customDomain | |||
| lambda | No | lambda |
api_def - structure¶
Use the api section to configure API Gateway details.
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| apiKey | Yes | string | |||
| cacheClusterEnabled | No | boolean | Enables a cache cluster for the Stage resource specified in the input | ||
| cacheClusterSize | No | string | Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled (defaults to ‘0.5’) | ||
| description | Yes | string | The description for the Deployment resource to create | ||
| methodSettings | No | methodSettings | A map that defines the method settings for a Stage resource | ||
| name | Yes | string | The name of the Stage resource for the Deployment resource to create | ||
| targetStage | Yes | string | The name of the Stage resource for the Deployment resource to create |
Methodsettings schema:
A map that defines the method settings for a Stage resource
customDomain - structure¶
Configuration necessary to setup a custom domain for the api.
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| basePath | Yes | string | |||
| certificateArn | Yes | arn | The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source | ||
| certificateName | Yes | string | The user-friendly name of the certificate | ||
| domainName | Yes | string | The name of the DomainName resource | ||
| hostedDomainZoneId | Yes | string | |||
| route53Record | Yes | string |
entries - structure¶
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| alias | Yes | string | |||
| name | Yes | string | |||
| swaggerRef | No | string |
arn - structure¶
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| arn | No | string | Amazon Resource Name |