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

    cloud stringrequired

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

    description stringrequired

    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 [

    • description string

    Description is the description of the variable

    name stringrequired

    Name is the name of the variable

    options string[]

    Options are the available options for a list or string type

    sensitive boolean

    Sensitive indicates if the input is sensitive

    type string

    Type is the type of the variable

    validation

    required

    Validation is the validation of the variable

    default string

    Default is the default value of the variable

    maxLength int32

    MaxLength is the maximum length of the variable if a string

    minLength int32

    MinLength is the minimum length of the variable if a string

    pattern string

    Pattern is the pattern of the variable if a string

    required boolean

    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.

    allStages boolean
    allWorkspaces boolean
    allowedStages string[]
    allowedWorkspaces string[]

    terraform

    required

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

    moduleURL stringrequired

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

    moduleVersion stringrequired

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

    secretRef string

    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.

    version stringrequired

    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.

Loading...
Last updated