cloud config 1.0.3¶
Description¶
Documentation of the config file format for cloud (a fink tool). Note: if you want to add to the documentation please edit the openapi_cloud.yaml file
Data Structures¶
cloud - structure¶
The cloud config is organized into the following structure:
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| defaults | Yes | defaults | finetune fink tool lifecycle (override at own risk) | ||
| deployment | No | deployment | details regarding the deployment phase of the stack | ||
| parameters | No | parameters | parameters used in the cloudformation template | ||
| stack | Yes | stack | configure stack details |
stack - structure¶
Use the stack section to configure stack details.
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| NotificationARNs | No | array of arn | configure SNS recipients for stack events | ||
| RoleARN | No | string | role to use for cloudformation deployment | ||
| StackName | Yes | string | name of your cloudformation stack | ||
| TemplateBody | No | string | |||
| artifactBucket | No | arn | s3 bucket use to upload the cloudformation template to AWS |
parameters - structure¶
AWS cloudformation parameters. Parameters in the config must match the parameters used in the template!
deployment - structure¶
Stack properties specific to the deployment phase.
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| DisableStop | No | boolean | disable the cloud stop & start mechanism for this stack. |
defaults - structure¶
Default properties to finetune fink tool lifecycle (override at own risk).
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| non_config_commands | Yes | array of string | {‘default’: [‘stop’, ‘start’, ‘list’]} | cloud commands that do not require a config file. | |
| validate | Yes | boolean | {‘default’: True} | use this if you need to switch off config validation. |
arn - structure¶
| Name | Required | Type | Format | Properties | Description |
|---|---|---|---|---|---|
| arn | No | string | Amazon Resource Name |