Returns a specific cloud resource plan
Returns a specific cloud resource plan
Path Parameters
The name of the cloud resource plan you wish to retrieve
Responses
- 200
- 401
- 403
- 404
- 500
Contains the cloud resource plan definition
- application/json
- Schema
- Example (from schema)
Schema
property name*
stringproperty name*
stringproperty name*
string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
spec
CloudResourcePlanSpec defines a plan for a cloud resource.
allocation
inputDefinitions undefined[]
InoutDefinitions provides more detail about the inputs that the terraform module represented by this plan has.
inputsFrom undefined[]
InputsFrom is a optional collection of values which are injected into the rendered output of the resource.
resource
Resource is used to filter on and extract the details from a managed resource in Wayfinder.
labels object
outputs undefined[]
Outputs is a list of available outputs from the revision of the terraform module represented by this plan.
policies undefined[]
template
Template represents the configuration values for a specific revision of the cloud resource.
status
CloudResourcePlanStatus defines the status of a cloud resource plan.
conditions undefined[]
lastReconcile
lastSuccess
obsoleteResources undefined[]
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"clusterName": "string",
"creationTimestamp": "string",
"deletionGracePeriodSeconds": 0,
"deletionTimestamp": "string",
"finalizers": [
"string"
],
"generateName": "string",
"generation": 0,
"labels": {},
"managedFields": [
{
"apiVersion": "string",
"fieldsType": "string",
"fieldsV1": "string",
"manager": "string",
"operation": "string",
"subresource": "string",
"time": "string"
}
],
"name": "string",
"namespace": "string",
"ownerReferences": [
{
"apiVersion": "string",
"blockOwnerDeletion": true,
"controller": true,
"kind": "string",
"name": "string",
"uid": "string"
}
],
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"allocation": {
"type": "string",
"workspaces": [
"string"
]
},
"cloud": "string",
"description": "string",
"enableTemplateAutoUpgrade": true,
"enableWatch": true,
"inputDefinitions": [
{
"default": "string",
"description": "string",
"name": "string",
"required": true,
"sensitive": true,
"type": "string"
}
],
"inputsFrom": [
{
"kind": "string",
"name": "string",
"resource": {
"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"srcPath": "string",
"valuePrefix": "string",
"valueSuffix": "string",
"version": "string"
}
}
],
"labels": {},
"outputs": [
{
"description": "string",
"name": "string",
"sensitive": true,
"userFacing": true
}
],
"policies": [
{
"editable": true,
"enum": [
"string"
],
"max": 0,
"min": 0,
"path": "string",
"pattern": "string",
"summary": "string"
}
],
"template": {
"revision": "string",
"source": "string",
"variables": {}
}
},
"status": {
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"detail": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"status": "string",
"wayfinderVersion": "string"
}
}
If not authenticated
If authenticated but not authorized
the cloud resource plan with the given name doesn't exist
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}