cloudresources.appvia.io/v2beta2
Package v2beta2 contains API Schema definitions for the cloudresources v2beta1 API group
Exported Resource Types
CloudResourcePlan
CloudResourcePlan represents a deployable cloud resource for an application, such as a database or storage bucket.
| Field | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion | cloudresources.appvia.io/v2beta2 | ||||||||||||
kind | CloudResourcePlan | ||||||||||||
| metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the metadata field. | ||||||||||||
| spec CloudResourcePlanSpec |
| ||||||||||||
| status CloudResourcePlanStatus |
|
Internal Resource Types
- CloudResourcePlanSpec
- CloudResourcePlanStatus
- InputDefinition
- InputValidationDefinition
- OutputDefinition
- TerraformDefinition
CloudResourcePlanSpec
(Appears on: CloudResourcePlan)
CloudResourcePlanSpec defines a plan for a cloud resource.
| Field | Description |
|---|---|
| version ObjectVersion | Must be a valid semver in the format X.Y.Z without a ‘v’ prefix. An optional -suffix can be provided; note in semver that 1.0.0 is after 1.0.0-1. |
| cloud string | Cloud refers to the cloud provider of the resource (azure, gcp, aws). |
| description string | Description provides a short summary for the cloud resource plan. |
| inputs []InputDefinition | Inputs is a collection of inputs that are required for the cloud resource plan. These are used to control what users are permitted to provide inputs for |
| scope Scope | Scope is the scope of the cloud resource plan, and whom the cloudresource plan is intended for. |
| terraform TerraformDefinition | Terraform provides all the configuration for the terraform module that is used to create the cloud resource. |
CloudResourcePlanStatus
(Appears on: CloudResourcePlan)
CloudResourcePlanStatus defines the status of a cloud resource plan.
| Field | Description |
|---|---|
| CommonStatus CommonStatus | (Members of CommonStatus are embedded into this type.) |
| outputs []OutputDefinition | Outputs is a list of available outputs from the revision of the terraform module represented by this plan. |
InputDefinition
(Appears on: CloudResourcePlanSpec)
InputDefinition defines an input to a terraform plan.
| Field | Description |
|---|---|
| description string | Description is the description of the variable |
| name string | Name is the name of the variable |
| sensitive bool | Sensitive indicates if the input is sensitive |
| type string | Type is the type of the variable |
| options []string | Options are the available options for a list or string type |
| validation InputValidationDefinition | Validation is the validation of the variable |
InputValidationDefinition
(Appears on: InputDefinition)
InputValidationDefinitions defines the validation of an input
| Field | Description |
|---|---|
| default k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1.JSON | Default is the default value of the variable |
| minLength int | MinLength is the minimum length of the variable if a string |
| maxLength int | MaxLength is the maximum length of the variable if a string |
| pattern string | Pattern is the pattern of the variable if a string |
| required bool | Required is true if the variable is required |
OutputDefinition
(Appears on: CloudResourcePlanStatus)
OutputDefinition defines a required output from a terraform plan once applied.
| Field | Description |
|---|---|
| name string | Name is the name of the output |
| description string | Description is the description of the output |
| sensitive bool | Sensitive indicates if the output is sensitive |
TerraformDefinition
(Appears on: CloudResourcePlanSpec)
TerraformDefinition provides the configuration for the terraform module that is used to create the cloud resource.
| Field | Description |
|---|---|
| moduleURL string | ModuleURL is the URL of the terraform module that is used to create the cloud resource. |
| moduleVersion string | ModuleVersion is the version of the terraform module that is used to create the cloud resource. |
| secretRef PlatformSecretRef | SecretRef is a reference to a platform secret that contains the credentials required to access the terraform module source. |
| tfVarsTemplate string | TFVarsTemplate is the terraform vars template that is used to create the cloud resource. |