Skip to main content

Prepares a skeleton cloud resource plan from a specific version of a terraform module repository

GET 
/api/v2/terraform/repository/cloudresourceplan

Prepares a skeleton cloud resource plan from a specific version of a terraform module repository

Request​

Query Parameters

    url string

    The URL of the Terraform module repository

    version string

    Version of module to retrieve

    authSecretRef string

    Name of a platform secret to use for authentication

Responses​

Skeleton CloudResourcePlan for module

Schema

    cloudstringrequired

    Cloud refers to the cloud provider of the resource (azure, gcp, aws).

    descriptionstringrequired

    Description provides a short summary for the cloud resource plan.

    inputs

    undefined[]

    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

  • Array [

    • descriptionstring

    Description is the description of the variable

    namestringrequired

    Name is the name of the variable

    optionsstring[]

    Options are the available options for a list or string type

    sensitiveboolean

    Sensitive indicates if the input is sensitive

    typestring

    Type is the type of the variable

    validation

    required

    Validation is the validation of the variable

    defaultstring

    Default is the default value of the variable

    maxLengthint32

    MaxLength is the maximum length of the variable if a string

    minLengthint32

    MinLength is the minimum length of the variable if a string

    patternstring

    Pattern is the pattern of the variable if a string

    requiredboolean

    Required is true if the variable is required

  • ]

    • scope

    required

    Scope is the scope of the cloud resource plan, and whom the cloudresource plan is intended for.

    allStagesboolean
    allWorkspacesboolean
    allowedStagesstring[]
    allowedWorkspacesstring[]

    terraform

    required

    Terraform provides all the configuration for the terraform module that is used to create the cloud resource.

    moduleURLstringrequired

    ModuleURL is the URL of the terraform module that is used to create the cloud resource.

    moduleVersionstringrequired

    ModuleVersion is the version of the terraform module that is used to create the cloud resource.

    secretRefstring

    SecretRef is a reference to a platform secret that contains the credentials required to access the terraform module source.

    tfVarsTemplatestring

    TFVarsTemplate is the terraform vars template that is used to create the cloud resource.

    versionstringrequired

    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.

Last updated on