Documentation
¶
Index ¶
Constants ¶
const ( SettingsKindMarkdownDoc = `` /* 3302-byte string literal not displayed */ SettingsConfig = "Configuration settings for the connector's secrets" SettingsConfigRoleArn = "The Amazon Resource Name (ARN) of the role that the caller is assuming." SettingsConfigExternalId = `` /* 190-byte string literal not displayed */ SettingsConfigDurationSeconds = "The duration, in seconds, of the role session. Default is 3600 seconds (1 hour)." SettingsConfigInstallationId = "The installation ID for GitHub applications." SettingsConfigGithubAppId = "The application ID for the GitHub app." SettingsConfigGithubAppWebhookSecret = "Webhook secret for the GitHub app." SettingsConfigGithubApiUrl = "Base URL for the GitHub API." SettingsConfigGithubHttpUrl = "HTTP URL for accessing the GitHub repository." SettingsConfigGithubAppClientId = "Client ID for the GitHub app." SettingsConfigGithubAppClientSecret = "Client secret for the GitHub app." SettingsConfigGithubAppPemFileContent = "Content of the PEM file for the GitHub app." SettingsConfigGithubAppWebhookUrl = "Webhook URL for the GitHub app." SettingsConfigGitlabCreds = "Credentials for GitLab integration." SettingsConfigGitlabHttpUrl = "HTTP URL for accessing the GitLab repository." SettingsConfigGitlabApiUrl = "Base URL for the GitLab API." SettingsConfigAzureCreds = "Credentials for Azure integration." SettingsConfigAzureDevopsHttpUrl = "HTTP URL for accessing Azure DevOps services." SettingsConfigAzureDevopsApiUrl = "Base URL for Azure DevOps API." SettingsConfigBitbucketCreds = "Credentials for Bitbucket integration." SettingsConfigAwsAccessKeyId = "AWS access key ID for authentication." SettingsConfigAwsSecretAccessKey = "AWS secret access key for authentication." SettingsConfigAwsDefaultRegion = "Default AWS region for resource operations." SettingsConfigArmTenantId = "Azure Resource Manager tenant ID." SettingsConfigArmSubscriptionId = "Azure Resource Manager subscription ID." SettingsConfigArmClientId = "Client ID for Azure Resource Manager." SettingsConfigArmClientSecret = "Client secret for Azure Resource Manager." SettingsConfigGcpConfigFileContent = "Content of the GCP configuration file." DiscoverySettings = "Settings for discovery insights related to the connector." DiscoverySettingsBenchmarks = "Statistics for various StackGuardian resources." DiscoverySettingsBenchmarksChecks = "List of checks performed during discovery." DiscoverySettingsBenchmarksDescription = "A description of the benchmark. It must be less than 256 characters." DiscoverySettingsBenchmarksLabel = "Label associated with the discovery." DiscoverySettingsBenchmarksRuntimeSource = "Source configuration type and settings definition" DiscoverySettingsBenchmarksRuntimeSourceSourceConfigDestKind = "" /* 249-byte string literal not displayed */ DiscoverySettingsBenchmarksRuntimeSourceConfig = "Specific configuration settings for runtime source." DiscoverySettingsBenchmarksRuntimeSourceConfigIncludeSubModule = "Indicates whether to include sub-modules." DiscoverySettingsBenchmarksRuntimeSourceConfigRef = "Reference identifier for the repository." DiscoverySettingsBenchmarksRuntimeSourceConfigGitCoreAutoCRLF = "Indicates if core.autocrlf should be enabled." DiscoverySettingsBenchmarksRuntimeSourceConfigAuth = "" /* 266-byte string literal not displayed */ DiscoverySettingsBenchmarksRuntimeSourceConfigWorkingDir = "Working directory for operations." DiscoverySettingsBenchmarksRuntimeSourceConfigRepo = "Repository name or URL." DiscoverySettingsBenchmarksRuntimeSourceConfigIsPrivate = "Indicates if the repository is private." DiscoverySettingsBenchmarksSummaryDescription = "A brief summary of the discovery." DiscoverySettingsBenchmarksSummaryTitle = "Title for the discovery summary." DiscoverySettingsBenchmarksDiscoveryInterval = "Interval for the discovery process." DiscoverySettingsBenchmarksIsCustomCheck = "Indicates if the discovery is a custom check." DiscoverySettingsBenchmarksActive = "Indicates if the discovery is active." DiscoverySettingsBenchmarksRegions = "Regions associated with the discovery." DiscoverySettingsBenchmarksRegionsEmails = "List of emails to notify about the discovery." )
Connector
const ( AllowedPermissions = "A map of permissions assigned to the role." AllowedPermissionsName = "The name of the permission." AllowedPermissionsPaths = "" /* 341-byte string literal not displayed */ )
Role
const ( UserId = `` /* 238-byte string literal not displayed */ EntityType = `` /* 163-byte string literal not displayed */ Role = "StackGuardian role name. <span style='color: #e53835;'>(Deprecated)</span> Use `roles` instead." Roles = "StackGuardian roles. Use to assign one or multiple roles." )
Role Assignment
const ( Approvers = "Who can approve a run that this policy holds for approval. " + ApproverFormats + " Applies only to `policy_type = \"GENERAL\"`." NumberOfApprovalsRequired = "How many approvals release a run that this policy holds for approval. Defaults to `0`. " + ApprovalsRequired EnforcedOn = "" /* 524-byte string literal not displayed */ PolicyType = "" /* 418-byte string literal not displayed */ PolicyConfig = "Policy configuration" PolicyConfigSkip = "Enable or disable the policy check" PolicyConfigOnFail = "" /* 294-byte string literal not displayed */ PolicyConfigOnPass = "" /* 336-byte string literal not displayed */ PolicyConfigInputData = "Policy definition" PolicyConfigInputDataSchemaType = "" /* 605-byte string literal not displayed */ PolicyConfigInputDataData = "Policy body" PolicyVCSConfig = "Configuration to import policy from version control" PolicyVCSConfigMarketplaceTemplate = "Name of the template from marketplace" PolicyVCSConfigTemplateId = "" /* 385-byte string literal not displayed */ PolicyVCSConfigCustomSource = DiscoverySettingsBenchmarksRuntimeSource PolicyVCSConfigCustomSourceSourceConfigDestKind = DiscoverySettingsBenchmarksRuntimeSourceSourceConfigDestKind PolicyVCSConfigCustomSourceSourceConfigKind = `` /* 187-byte string literal not displayed */ PolicyVCSConfigCustomSourceConfig = DiscoverySettingsBenchmarksRuntimeSourceConfig PolicyVCSConfigCustomSourceRef = DiscoverySettingsBenchmarksRuntimeSourceConfigRef PolicyVCSConfigCustomSourceGitCoreAutoCRLF = DiscoverySettingsBenchmarksRuntimeSourceConfigGitCoreAutoCRLF PolicyVCSConfigCustomSourceGitSparseCheckoutConfig = "Configuration for git sparse checkout" PolicyVCSConfigCustomSourceAuth = DiscoverySettingsBenchmarksRuntimeSourceConfigAuth PolicyVCSConfigCustomSourceWorkingDir = DiscoverySettingsBenchmarksRuntimeSourceConfigWorkingDir PolicyVCSConfigCustomSourceRepo = DiscoverySettingsBenchmarksRuntimeSourceConfigRepo PolicyVCSConfigCustomSourceIsPrivate = DiscoverySettingsBenchmarksRuntimeSourceConfigIsPrivate PolicyVCSConfigCustomSourceIncludeSubmodule = DiscoverySettingsBenchmarksRuntimeSourceConfigIncludeSubModule PolicyVCSConfigAdditionalConfig = "Additional configuration for the policy" )
Policy
const ( RunnerToken = "Private token of the runner group" MaxNumberOfRunners = "Maximum number of runners allowed in a runner group" DockerImage = "Docker image to used to execute workflows" DockerRegistryUsername = "Username for docker register" )
Runner Group
const ( SendEmail = "Enable or disable email notification to the user on creation." Alias = "Alias to easily identify SSO Groups. Only applicable for `GROUP` entityType." )
Role Assignment or User
const ( ResourceName = "" /* 174-byte string literal not displayed */ Id = "" /* 625-byte string literal not displayed */ Description = "A brief description of the %s. Must be less than 256 characters." Tags = "A list of tags associated with the %s. A maximum of 10 tags are allowed." StorageBackendConfig = "Configuration for storing runner logs" RunnerGroupType = `` /* 185-byte string literal not displayed */ AzureBlobStorageAccountName = "Name of your Azure Blob Storage account." AzureBlobStorageAccessKey = "Access key for your Azure Blob Storage account." S3BucketName = "Name of the S3 bucket used to store runner logs." AWSRegion = "AWS region where the bucket is placed" Auth = "Authentication required by the runner to access the backend storage. Required only for type \"aws_s3\"" IntegrationId = "" /* 197-byte string literal not displayed */ Deprecation = "Deprecation information for this resource. Revision can only be deprecated once it is published." DeprecationEffectiveDate = "Effective date when this resource will be deprecated and no longer available for use." )
Common
const ( WfApprovers = "Who can approve a workflow run that is waiting for approval. " + ApproverFormats WfNumberOfApprovals = "How many approvals release a workflow run that is waiting for approval. " + ApprovalsRequired WfUserJobCPU = "Limits to set user job CPU." WfUserJobMemory = "Limits to set user job memory." WfMiniSteps = "Actions that are required to be performed once workflow execution is complete" WfUserSchedules = "Configuration for scheduling runs for the workflows." WfStepsConfig = "Workflow steps configuration. Valid for custom workflow types." WfEnvironmentVariables = "Environment variables made available to the workflow during its runs." WfDeploymentPlatformConfig = "Deployment platform configuration." )
Common Workflow and Workflow Template Revision attributes
const ( DatasourceId = "" /* 219-byte string literal not displayed */ StackguardianStack = "Stackguardian stack name" StackguardianWorkflow = "Stackguardian workflow name" StackguardianWorkflowGroup = "Stackguardian workflow group name" DataSourceDataJson = "Raw JSON body" DataSourceData = "Map of k/v pairs with value as JSON string" DatasourceResourceNameDeprecation = "" /* 167-byte string literal not displayed */ )
Common
const ( RunnerGroupToken = "Runner Group token" RunnerGroupId = "" /* 166-byte string literal not displayed */ )
api token
const ( StackTemplateSourceConfigKindCommon = "" /* 378-byte string literal not displayed */ StackTemplateIsPublicCommon = `` /* 213-byte string literal not displayed */ )
Stack Template - Common documentation
const ( StackTemplateName = "Name of the stack template. Must be less than 100 characters." StackTemplateOwnerOrg = "Organization that owns the stack template." StackTemplateDescription = "A brief description of the stack template." StackTemplateTags = "A list of tags associated with the stack template." StackTemplateContextTags = "Contextual key-value tags that provide additional context to the main tags." )
Stack Template Resource documentation
const ( StackTemplateRevisionId = "Identifier of the revision, in the form `<template-id>:<revision>` (e.g. `my-stack-template:1`)." StackTemplateRevisionTemplateId = "" /* 143-byte string literal not displayed */ StackTemplateRevisionIacTemplateId = "" /* 390-byte string literal not displayed */ StackTemplateRevisionAlias = "Human-readable alias for the revision (e.g., `v1.0.0`)." StackTemplateRevisionNotes = "Release notes or changelog for this revision." StackTemplateRevisionDescription = "Long description for the stack template revision." StackTemplateRevisionTags = "A list of tags associated with the revision." StackTemplateRevisionContextTags = "Contextual key-value tags for the revision." StackTemplateRevisionWorkflowsConfig = "JSON-encoded workflows configuration for the stack template revision." StackTemplateRevisionActions = "JSON-encoded map of actions for the stack template revision." StackTemplateRevisionActionDefault = "" /* 164-byte string literal not displayed */ StackTemplateRevisionIacInputData = "" /* 329-byte string literal not displayed */ )
Stack Template Revision Resource documentation
const ( StackActionDefault = "" /* 344-byte string literal not displayed */ StackIacInputData = "" /* 251-byte string literal not displayed */ StackTerraformBinPath = "" /* 221-byte string literal not displayed */ StackTemplateGroupId = "" /* 407-byte string literal not displayed */ )
Stack Resource documentation
const ( TemplateRevisionAlias string = "Alias for the template revision" TemplateRevisionNotes string = "Notes for the revision" TemplateRevisionIsPublic string = `Whether this **revision** is published and available to be referenced. Distinct from ` + "`is_public`" + ` on the parent template, which controls cross-organization sharing. Once set to ` + "`\"1\"`" + `, only ` + "`description`, `alias`, `notes`, and `deprecation`" + ` may still be changed — every other attribute is rejected by the API. Options: <span style="background-color: #eff0f0; color: #e53835;">"1"</span>, <span style="background-color: #eff0f0; color: #e53835;">"0"</span>` TemplateRevisionDeprecation string = "Marking a template revision for deprecation" TemplateRevisionDeprecationEffectiveDate string = "Effective date for after which revision will be deprecated" TemplateRevisionDeprecationMessage string = "" /* 130-byte string literal not displayed */ DeprecationMessage string = "" /* 130-byte string literal not displayed */ )
common template attributes
const ( SourceConfigKind string = "" /* 489-byte string literal not displayed */ ContextTags string = "Context tags for %s" )
Common attributes shared between workflow template and revision
const ( WorkflowTemplateName = "Name of the workflow template." WorkflowTemplateOwnerOrg = "Organization the template belongs to" WorkflowTemplateIsPublic = `Whether this **template** is shared with other organizations. Distinct from ` + "`is_public`" + ` on a revision, which controls whether that revision is published for use. Available values: <span style="background-color: #eff0f0; color: #e53835;">"0"</span> or <span style="background-color: #eff0f0; color: #e53835;">"1"</span>` )
Workflow Template attributes
const ( WorkflowTemplateRevisionId = "Identifier of the revision, in the form `<template-id>:<revision>` (e.g. `my-terraform-template:1`)." WorkflowTemplateRevisionTemplateId = "" /* 274-byte string literal not displayed */ WorkflowTemplateRevisionInputSchemas = "JSONSchema Form representation of input JSON data" // WorkflowTemplateRevisionWfStepsConfig documents a rule validated at plan time — see // wfStepsConfigNotAllowedForTerraformDiagnostics in // internal/resource/workflow_template_revision/validation.go. Deliberately not shared // with workflow_from_template/workflow_git's own wf_steps_config attributes, which have // no such client-side check. WorkflowTemplateRevisionWfStepsConfig = "" /* 253-byte string literal not displayed */ )
Workflow Template Revision attributes
const ( RuntimeSource = "Runtime source configuration for the %s." RuntimeSourceDestKind = "" /* 1084-byte string literal not displayed */ RuntimeSourceConfig = "Configuration for the runtime environment." RuntimeSourceConfigAuth = "" /* 410-byte string literal not displayed */ RuntimeSourceConfigGitCoreCRLF = "Whether to automatically handle CRLF line endings." RuntimeSourceConfigGitSparse = "Git sparse checkout command line git cli options." RuntimeSourceConfigIncludeSubmodule = "Whether to include git submodules." RuntimeSourceConfigIsPrivate = "Whether the repository is private. Auth is required if the repository is private" RuntimeSourceConfigRef = "Git reference (branch, tag, or commit hash)." RuntimeSourceConfigRepo = "Git repository URL." RuntimeSourceConfigWorkingDir = "Working directory within the repository." )
Runtime Source attributes (shared)
const ( WorkflowTemplateRuntimeSourceDestKind = RuntimeSourceDestKind + " `GIT_OTHER` is the only kind that may omit `auth` for a public repository; every other kind requires it regardless of `is_private`." WorkflowTemplateRuntimeSourceConfigAuth = "" /* 482-byte string literal not displayed */ WorkflowTemplateRuntimeSourceConfigIsPrivate = "" /* 268-byte string literal not displayed */ WorkflowTemplateRuntimeSourceConfigRepo = "Git repository URL. **Cannot be changed** after creation." )
Runtime Source attributes specific to workflow templates and revisions. Unlike the shared Runtime Source attributes above (used by workflow_git and stack_template_revision, where no such rule is enforced), the is_private/auth combination here is validated at plan time — see ValidateRuntimeSourceAuth in internal/resource/workflow_template/validation.go.
const ( VCSTriggers = "Webhook triggers for this workflow. Supported when the repository is on `GITHUB_COM`, `GITHUB_APP_CUSTOM` or `GITLAB_COM`.<br><br>**Requires** `vcs_config.iac_vcs_config.custom_source.config.is_private` to be `true` and `...config.auth` to name a `stackguardian_connector` with access — StackGuardian has to authenticate to register the webhook. See the [VCS connector docs](https://docs.stackguardian.io/docs/connectors/vcs/)." + "`source_config_dest_kind`" + ` is <span style="background-color: #eff0f0; color: #e53835;">GITHUB_COM</span>, <span style="background-color: #eff0f0; color: #e53835;">GITHUB_APP_CUSTOM</span>, or <span style="background-color: #eff0f0; color: #e53835;">GITLAB_COM</span>. **Requires** ` + "`vcs_config.iac_vcs_config.custom_source.config.is_private`" + ` to be ` + "`true`" + ` and ` + "`vcs_config.iac_vcs_config.custom_source.config.auth`" + ` to be set with a valid connector ID.` VCSTriggersTrackedBranch = "" /* 431-byte string literal not displayed */ VCSTriggersApprovalPreApply = "" /* 268-byte string literal not displayed */ VCSTriggersPlanOnly = "" /* 300-byte string literal not displayed */ VCSTriggersFileTriggersEnabled = "" /* 365-byte string literal not displayed */ VCSTriggersFileTriggerPatterns = "" /* 340-byte string literal not displayed */ VCSTriggersGlHookId = "" /* 133-byte string literal not displayed */ VCSTriggersBbHookId = "" /* 136-byte string literal not displayed */ VCSTriggersGhWebhookUrl = "" /* 135-byte string literal not displayed */ VCSTriggersAdoHooksId = "" /* 192-byte string literal not displayed */ VCSTriggersAllPullRequests = "" /* 453-byte string literal not displayed */ VCSTriggersPullRequestOpened = "" /* 393-byte string literal not displayed */ VCSTriggersPullRequestModified = "" /* 415-byte string literal not displayed */ VCSTriggersCreateTagAction = "" /* 332-byte string literal not displayed */ VCSTriggersActionEnabled = "Whether this trigger action is active. When `false` the event is received but no workflow run is created." VCSTriggersPush = "" /* 357-byte string literal not displayed */ )
VCS Triggers attributes
const ( EnvVarConfig = "Configuration for the environment variable." EnvVarConfigVarName = "Name of the variable." EnvVarConfigSecretId = "Not used. To reference a secret, set `config.text_value` instead — see the [Runtime References guide](" + RuntimeReferencesGuide + ")." EnvVarConfigTextValue = "Value written inline, and visible in configuration and state. " + RuntimeReferenceNote EnvVarKind = "Where the variable's value comes from. Must be `PLAIN_TEXT` — the value is written inline in `config.text_value`. It is visible in configuration and state, so reference a credential rather than writing it literally: see the [Runtime References guide](" + RuntimeReferencesGuide + ")." )
Environment Variables attributes
const ( InputSchemaName = "Name of the input schema." InputSchemaType = "Type of the schema." InputSchemaEncodedData = "JSON schema for the Form in templates. The schema needs to be base64 encoded." InputSchemaUISchemaData = "Schema for how the JSON schema is to be visualized. The schema needs to be base64 encoded." )
Input Schemas attributes
const ( MiniStepsNotifications = "Configuration for notifications to be sent on workflow completion" MiniStepsNotificationsEmail = `` /* 493-byte string literal not displayed */ MiniStepsNotificationsRecipients = "List of emails" MiniStepsWebhooks = `` /* 482-byte string literal not displayed */ MiniStepsWebhookName = "Webhook name" MiniStepsWebhookURL = "Webhook URL" MiniStepsWebhookSecret = "Secret to be sent with API request to webhook url" MiniStepsWorkflowChaining = `` /* 255-byte string literal not displayed */ MiniStepsWfChainingWorkflowGroupId = "" /* 134-byte string literal not displayed */ MiniStepsWfChainingStackId = "Stack to trigger, as a bare name within `workflow_group_id`." MiniStepsWfChainingStackPayload = "JSON string specifying overrides for the stack to be triggered" MiniStepsWfChainingWorkflowId = "Workflow to trigger, as a bare name within `workflow_group_id`." MiniStepsWfChainingWorkflowPayload = "JSON string specifying overrides for the workflow to be triggered" )
Mini Steps attributes
const ( RunnerConstraintsType = `` /* 176-byte string literal not displayed */ RunnerConstraintsNames = "" /* 255-byte string literal not displayed */ )
Runner Constraints attributes
const ( UserScheduleCron = `` /* 161-byte string literal not displayed */ UserScheduleState = `` /* 177-byte string literal not displayed */ UserScheduleDesc = "Description of the schedule." UserScheduleName = "Name of the schedule." UserScheduleInputs = "Run inputs used when this schedule triggers a workflow run." UserScheduleInputsTerraformAction = "" /* 127-byte string literal not displayed */ UserScheduleInputsTerraformActionAction = "Action to run. One of `apply`, `destroy`, `plan`, `plan-destroy`, `plan-without-policy` or `refresh`." UserScheduleInputsEnableChaining = "Whether the scheduled run triggers the workflows and stacks chained to it. Set by StackGuardian; read-only." UserScheduleInputsVcsConfig = "VCS configuration for the scheduled run." UserScheduleInputsIacInputData = "IaC input data for the scheduled run." UserScheduleInputsIacInputDataSchemaType = "How the value in `data` is formatted. One of `RAW_JSON` or `FORM_JSONSCHEMA`." )
User Schedules attributes
const ( DeploymentPlatformKind = "" /* 724-byte string literal not displayed */ DeploymentPlatformConfigDetails = "Deployment platform configuration details." DeploymentPlatformIntegrationId = "" /* 223-byte string literal not displayed */ DeploymentPlatformProfileName = "Profile name for the deployment platform." )
Deployment Platform Config attributes
const ( MountPointSource = "Source path for mount point." MountPointTarget = "Target path for mount point." MountPointReadOnly = "If the directory is to be mounted as read only or not" )
Mount Point attributes
const ( WfStepName = "Step name." WfStepEnvVars = "Environment variables for the workflow steps." WfStepApproval = "Enable approval for the workflow step." WfStepTimeout = "Workflow step execution timeout in seconds." WfStepCmdOverride = "Override command for the step." WfStepMountPoints = "Mount points for the step." WfStepTemplateId = "" /* 233-byte string literal not displayed */ TerraformWfStepTemplateRevisionId = "" /* 167-byte string literal not displayed */ WfStepInputData = "Workflow step input data (JSON string)" WfStepInputDataSchemaType = "" /* 131-byte string literal not displayed */ WfStepInputDataData = "Input data (JSON). " + RuntimeReferenceNote )
Workflow Steps Config attributes
const ( TerraformConfig = "Terraform configuration. Valid only for terraform type template" TerraformVersion = "" /* 496-byte string literal not displayed */ TerraformDriftCheck = "Enable drift check." TerraformDriftCron = "Cron expression for drift check." TerraformManagedState = "Enable stackguardian managed terraform state." TerraformApprovalPreApply = "Require approval before apply." TerraformPlanOptions = "Additional options for terraform plan." TerraformInitOptions = "Additional options for terraform init." TerraformBinPath = "Mount points for terraform binary." TerraformTimeout = "Timeout for terraform operations in seconds." TerraformPostApplyWfSteps = "Workflow steps configuration to run after apply." TerraformPreApplyWfSteps = "Workflow steps configuration to run before apply." TerraformPrePlanWfSteps = "Workflow steps configuration to run before plan." TerraformPostPlanWfSteps = "Workflow steps configuration to run after plan." TerraformPreInitHooks = "Hooks to run before init." TerraformPrePlanHooks = "Hooks to run before plan." TerraformPostPlanHooks = "Hooks to run after plan." TerraformPreApplyHooks = "Hooks to run before apply." TerraformPostApplyHooks = "Hooks to run after apply." TerraformRunPreInitHooksOnDrift = "Run pre-init hooks on drift detection." TerraformRunPrePlanHooksOnDrift = "Run pre-plan hooks on drift detection." TerraformRunPostPlanHooksOnDrift = "Run post-plan hooks on drift detection." )
Terraform Config attributes
const ( WorkflowTemplateRevisionRunPreInitHooksOnDrift = TerraformRunPreInitHooksOnDrift + " Defaults to `false`." WorkflowTemplateRevisionRunPrePlanHooksOnDrift = TerraformRunPrePlanHooksOnDrift + " Defaults to `false`." WorkflowTemplateRevisionRunPostPlanHooksOnDrift = TerraformRunPostPlanHooksOnDrift + " Defaults to `false`." )
The run_*_hooks_on_drift flags on stackguardian_workflow_template_revision default to false; workflow_git and workflow_from_template have no default and keep the plain descriptions above.
const ( GithubCom = "GITHUB_COM" GithubAppCustom = "GITHUB_APP_CUSTOM" GitOther = "GIT_OTHER" BitbucketOrg = "BITBUCKET_ORG" GitlabCom = "GITLAB_COM" AzureDevops = "AZURE_DEVOPS" AzureDevopsSp = "AZURE_DEVOPS_SP" )
SourceConfigDestKind enum values for VCS providers. Used in runtime_source, vcs_config, and vcs_triggers across workflow, workflow_template, and workflow_template_revision resources.
const ( WorkflowWorkflowGroupId = "" /* 151-byte string literal not displayed */ // WorkflowFromTemplateWorkflowGroupId is workflow_group_id for the workflow_from_template // resource, where it is immutable (changing it forces recreation). WorkflowFromTemplateWorkflowGroupId = "" /* 305-byte string literal not displayed */ WorkflowType = "" /* 455-byte string literal not displayed */ WorkflowRunnerConstraints = "Runner constraints to control which runner executes the workflow." WorkflowVcsConfig = "VCS configuration for the workflow." WorkflowIacVcsConfig = "IaC VCS configuration for the workflow." WorkflowUseMarketplaceTemplate = "Whether to use a marketplace template." WorkflowIacTemplateId = "" /* 588-byte string literal not displayed */ WorkflowCustomSource = "Custom VCS source configuration." WorkflowIacInputData = "IaC input data for the workflow." WorkflowIacInputDataSchemaId = "Schema ID for the input data." WorkflowIacInputDataSchemaType = "" /* 524-byte string literal not displayed */ WorkflowIacInputDataData = "Input data as a JSON string. " + RuntimeReferenceNote )
Workflow resource attributes
const ( WorkflowStepTemplateSourceConfigKindCommon = "" /* 142-byte string literal not displayed */ WorkflowStepTemplateIsPublicCommon = `` /* 221-byte string literal not displayed */ WorkflowStepTemplateRuntimeSourceDestKindCommon = "" /* 216-byte string literal not displayed */ WorkflowStepTemplateRuntimeSourceConfigIsPrivateCommon = "Indicates whether the container registry or repository is private." WorkflowStepTemplateRuntimeSourceConfigAuthCommon = "" /* 230-byte string literal not displayed */ WorkflowStepTemplateRuntimeSourceConfigDockerImageCommon = "Docker image URI to be used for template execution. Example: `ubuntu:latest`, `myregistry.azurecr.io/myapp:v1.0`" WorkflowStepTemplateRuntimeSourceConfigDockerRegistryUsernameCommon = "Username for authentication with the Docker registry (if using private registries)." WorkflowStepTemplateRuntimeSourceConfigLocalWorkspaceDirCommon = "Working directory path inside the workspace, relative to the repository root." )
Workflow Step Template - Common documentation
const ( WorkflowStepTemplateName = "Name of the workflow step template. Must be less than 100 characters." WorkflowStepTemplateDescription = "A brief description of the workflow step template. Must be less than 256 characters." WorkflowStepTemplateType = "" /* 536-byte string literal not displayed */ WorkflowStepTemplateIsPublic = `` /* 221-byte string literal not displayed */ WorkflowStepTemplateTags = "A list of tags associated with the workflow step template. A maximum of 10 tags are allowed." WorkflowStepTemplateContextTags = "Contextual key-value tags that provide additional context to the main tags." WorkflowStepTemplateSourceConfigKind = "" /* 142-byte string literal not displayed */ WorkflowStepTemplateLatestRevision = "Latest revision number of the template." WorkflowStepTemplateNextRevision = "Next revision number that will be used for the template." WorkflowStepTemplateRuntimeSource = "Runtime source configuration that defines where and how the template code is stored and executed." WorkflowStepTemplateRuntimeSourceDestKind = "" /* 216-byte string literal not displayed */ WorkflowStepTemplateRuntimeSourceAdditionalConfig = "Additional configuration settings for the runtime source as key-value pairs." WorkflowStepTemplateRuntimeSourceConfig = "Specific configuration settings for the runtime source." WorkflowStepTemplateRuntimeSourceConfigIsPrivate = "Indicates whether the container registry or repository is private." WorkflowStepTemplateRuntimeSourceConfigAuth = "Authentication credentials or method for accessing the private registry or repository. (Sensitive)" WorkflowStepTemplateRuntimeSourceConfigDockerImage = "Docker image URI to be used for template execution. Example: `ubuntu:latest`, `myregistry.azurecr.io/myapp:v1.0`" WorkflowStepTemplateRuntimeSourceConfigDockerRegistryUsername = "Username for authentication with the Docker registry (if using private registries)." )
Workflow Step Template Resource documentation
const ( WorkflowStepTemplateRevisionId = "ID of the revision in the format `templateId:revisionNumber`." WorkflowStepTemplateRevisionTemplateId = "Parent workflow step template, as its bare `template_name` (which is also its `id`) — not a path." WorkflowStepTemplateRevisionAlias = "Alias for the revision to easily identify it." WorkflowStepTemplateRevisionNotes = "Notes or changelog information for this revision." WorkflowStepTemplateRevisionDescription = "A brief description of the workflow step template revision. Must be less than 256 characters." WorkflowStepTemplateRevisionType = "" /* 344-byte string literal not displayed */ WorkflowStepTemplateRevisionSourceConfigKind = "" /* 142-byte string literal not displayed */ WorkflowStepTemplateRevisionIsPublic = `` /* 207-byte string literal not displayed */ WorkflowStepTemplateRevisionTags = "A list of tags associated with the revision. A maximum of 10 tags are allowed." WorkflowStepTemplateRevisionContextTags = "Contextual key-value tags that provide additional context to the main tags." WorkflowStepTemplateRevisionRuntimeSource = "Runtime source configuration for the revision." WorkflowStepTemplateRevisionRuntimeSourceDestKind = "" /* 216-byte string literal not displayed */ WorkflowStepTemplateRevisionRuntimeSourceAdditionalConfig = "Additional configuration settings for the runtime source as key-value pairs." WorkflowStepTemplateRevisionRuntimeSourceConfig = "Specific configuration settings for the runtime source." WorkflowStepTemplateRevisionRuntimeSourceConfigIsPrivate = "Indicates whether the container registry or repository is private." WorkflowStepTemplateRevisionRuntimeSourceConfigAuth = "Authentication credentials or method for accessing the private registry or repository. (Sensitive)" WorkflowStepTemplateRevisionRuntimeSourceConfigDockerImage = "Docker image URI to be used for revision execution." WorkflowStepTemplateRevisionRuntimeSourceConfigDockerRegistryUsername = "Username for authentication with the Docker registry (if using private registries)." )
Workflow Step Template Revision Resource documentation
const ApprovalsRequired = "" /* 579-byte string literal not displayed */
Shared by every `number_of_approvals_required` attribute.
const ApproverFormats = "" /* 620-byte string literal not displayed */
Shared by every `approvers` attribute so the accepted forms cannot drift.
const RuntimeReferenceNote = "May contain a reference the platform resolves at run time. See the [Runtime References guide](" + RuntimeReferencesGuide + ")."
RuntimeReferenceNote is appended to every attribute whose value the platform resolves at run time. The forms themselves are stated once, in the guide, so an attribute description cannot drift from them.
const RuntimeReferencesGuide = "https://registry.terraform.io/providers/StackGuardian/stackguardian/latest/docs/guides/RuntimeReferences"
RuntimeReferencesGuide is the guide documenting every `${...}` form the platform resolves at run time -- secrets, external secrets, workflow outputs and stack template outputs -- along with the `$$` escaping Terraform requires.
const (
WorkflowGroupResourceName = "" /* 189-byte string literal not displayed */
)
Workflow Group
Variables ¶
var MaxTerraformVersion = version.Must(version.NewVersion("1.16.4"))
MaxTerraformVersion is the newest Terraform CLI release CI exercises.
This is not an upper bound on support — the provider imposes no ceiling — it is the newest version we have actually proven the provider against. Bump it when a new Terraform minor ships.
var MinTerraformVersion = version.Must(version.NewVersion("1.5.7"))
MinTerraformVersion is the oldest Terraform CLI release this provider supports.
The provider refuses to configure below it (internal/provider/version_check.go) and the acceptance tests fail — rather than silently skip — below it (acctest.VersionChecks).
Raising it is a breaking change for users: bump the provider's major/minor version alongside it and note it in CHANGELOG.md.
var SupportedTerraformVersions = []string{
"1.5.7",
"1.6.6",
"1.7.5",
"1.8.5",
"1.9.8",
"1.10.5",
"1.11.4",
"1.12.2",
"1.13.5",
"1.14.9",
"1.15.9",
"1.16.4",
}
SupportedTerraformVersions is the exact Terraform matrix CI runs: the support floor, the newest tested release, and the latest patch of every minor series in between. Testing the newest patch of each minor is what gives coverage of the whole supported range without running every patch release ever published.
The same list is hardcoded into the matrix of .github/workflows/compat.yaml. test.yaml runs acceptance tests on MinTerraformVersion and MaxTerraformVersion only. TestTerraformMatrixMatchesWorkflows fails if compat.yaml drifts, so this stays the one place to edit when the range changes.
Functions ¶
This section is empty.
Types ¶
This section is empty.