Documentation
¶
Index ¶
Constants ¶
const ( SettingsKindMarkdownDoc = `` /* 3257-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 = "Kind of the source configuration destination. Valid examples include eg:- AWS_RBAC, AZURE_STATIC." 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 = "Authentication method for accessing the repository." 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 = "A map of resource paths to which this permission is scoped." )
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 = "List of stackguardian users" NumberOfApprovalsRequired = "Number of approvals required for a policy check to pass" EnforcedOn = "List of Resource path on which this policy is to be applied on" PolicyType = "Type of policy created \"GENERAL\" or \"FILTER.INSIGHT\"" PolicyConfig = "Policy configuration" PolicyConfigSkip = "Enable or disable the policy check" PolicyConfigOnFail = `` /* 355-byte string literal not displayed */ PolicyConfigOnPass = `` /* 352-byte string literal not displayed */ PolicyConfigInputData = "Policy definition" PolicyConfigInputDataSchemaType = `` /* 356-byte string literal not displayed */ PolicyConfigInputDataData = "Policy body" PolicyVCSConfig = "Configuration to import policy from version control" PolicyVCSConfigMarketplaceTemplate = "Name of the template from marketplace" PolicyVCSConfigTemplateId = "ID of the template from marketplace" 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 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 = "Name of the %s. Must be less than 100 characters. Allowed characters are ^[a-zA-Z0-9_]+$" Id = "" /* 258-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 = "Account of your azure blob storage" AzureBlobStorageAccessKey = "Access key for you blob storage account" S3BucketName = "S3 buckget name" 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 = "SG Connector Id. Required only for type \"aws_s3\" eg: /integrations/test-connector" Deprecation = "Deprecation information for this resource." DeprecationEffectiveDate = "Effective date when this resource will be deprecated and no longer available for use." )
Common
const ( DatasourceId = "ID of the resource. Should be used to import the resource." 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 = "Runner group ID" )
api token
const ( TemplateRevisionAlias string = "Alias for the template revision" TemplateRevisionNotes string = "Notes for the revision" TemplateRevisionIsPublic string = `` /* 189-byte string literal not displayed */ TemplateRevisionDeprecation string = "Marking a template revision for deprecation" TemplateRevisionDeprecationEffectiveDate string = "Effective date for after which revision will be deprecated" TemplateRevisionDeprecationMessage string = "Deprecation message" DeprecationMessage string = "Deprecation message" )
common template attributes
const ( SourceConfigKind string = `` /* 560-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 = `` /* 204-byte string literal not displayed */ )
Workflow Template attributes
const ( WorkflowTemplateRevisionTemplateId = "Resource ID of the parent workflow template." WorkflowTemplateRevisionApprovers = "List of approvers for approvals during workflow execution." WorkflowTemplateRevisionNumberOfApprovals = "Number of approvals required." WorkflowTemplateRevisionUserJobCPU = "Limits to set user job CPU." WorkflowTemplateRevisionUserJobMemory = "Limits to set user job memory." WorkflowTemplateRevisionEnvironmentVariables = "List of environment variables for the revision." WorkflowTemplateRevisionInputSchemas = "JSONSchema Form representation of input JSON data" WorkflowTemplateRevisionMiniSteps = "Actions that are required to be performed once workflow execution is complete" WorkflowTemplateRevisionUserSchedules = "Configuration for scheduling runs for the workflows." WorkflowTemplateRevisionDeploymentPlatformConfig = "Deployment platform configuration for the revision." WorkflowTemplateRevisionWfStepsConfig = "Workflow steps configuration. Valid for custom workflow types." )
Workflow Template Revision attributes
const ( RuntimeSource = "Runtime source configuration for the %s." RuntimeSourceDestKind = `` /* 449-byte string literal not displayed */ RuntimeSourceConfig = "Configuration for the runtime environment." RuntimeSourceConfigAuth = "Connector id to access private git repository" 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 ( VCSTriggers = "VCS trigger configuration for the workflow." VCSTriggersType = `` /* 343-byte string literal not displayed */ VCSTriggersCreateTag = "Trigger configuration on tag creation in VCS" VCSTriggersCreateTagRevision = "Create new revision on tag creation" VCSTriggersCreateTagRevisionEnabled = "Whether to create revision when tag is created." )
VCS Triggers attributes
const ( EnvVarConfig = "Configuration for the environment variable." EnvVarConfigVarName = "Name of the variable." EnvVarConfigSecretId = `` /* 132-byte string literal not displayed */ EnvVarConfigTextValue = `Text value (if using plain text). Only if type is <span style="background-color: #eff0f0; color: #e53835;">TEXT</span>` EnvVarKind = `` /* 187-byte string literal not displayed */ )
Environment Variables attributes
const ( 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 = "Workflow group id for the workflow." MiniStepsWfChainingStackId = "Stack id for the stack to be triggered." MiniStepsWfChainingStackPayload = "JSON string specifying overrides for the stack to be triggered" MiniStepsWfChainingWorkflowId = "Workflow id for the workflow to be triggered" MiniStepsWfChainingWorkflowPayload = "JSON string specifying overrides for the workflow to be triggered" )
Mini Steps attributes
const ( RunnerConstraintsType = `` /* 177-byte string literal not displayed */ RunnerConstraintsNames = "Id of the runner group" )
Runner Constraints attributes
const ( UserScheduleCron = "Cron expression defining the schedule." UserScheduleState = `` /* 177-byte string literal not displayed */ UserScheduleDesc = "Description of the schedule." UserScheduleName = "Name of the schedule." )
User Schedules attributes
const ( DeploymentPlatformKind = `` /* 561-byte string literal not displayed */ DeploymentPlatformConfigDetails = "Deployment platform configuration details." DeploymentPlatformIntegrationId = "Integration ID for the deployment platform." 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 = "Workflow step template ID." WfStepInputData = "Workflow step input data (JSON string)" WfStepInputDataSchemaType = `Schema type for the input data. Options: <span style="background-color: #eff0f0; color: #e53835;">FORM_JSONSCHEMA</span>` WfStepInputDataData = "Input data (JSON)." )
Workflow Steps Config attributes
const ( TerraformConfig = "Terraform configuration. Valid only for terraform type template" TerraformVersion = "Terraform version to use." 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." )
Terraform Config attributes
const ( WorkflowStepTemplateSourceConfigKindCommon = `` /* 304-byte string literal not displayed */ WorkflowStepTemplateIsActiveCommon = `` /* 209-byte string literal not displayed */ WorkflowStepTemplateIsPublicCommon = `` /* 221-byte string literal not displayed */ WorkflowStepTemplateRuntimeSourceDestKindCommon = "Destination kind for the runtime source configuration. Examples:" + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">CONTAINER_REGISTRY</span>," + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">GIT</span>," + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">S3</span>" WorkflowStepTemplateRuntimeSourceConfigIsPrivateCommon = "Indicates whether the container registry or repository is private." WorkflowStepTemplateRuntimeSourceConfigAuthCommon = "Authentication credentials or method for accessing the private registry or repository. (Sensitive)" 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 = "Workfing directory path." )
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 = `` /* 337-byte string literal not displayed */ WorkflowStepTemplateIsActive = `` /* 209-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 = `` /* 304-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 = "Destination kind for the runtime source configuration. Examples:" + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">CONTAINER_REGISTRY</span>," + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">GIT</span>," + "\n<span style=\"background-color: #eff0f0; color: #e53835;\">S3</span>" 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 = "ID of the parent workflow step template." 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 = `` /* 337-byte string literal not displayed */ WorkflowStepTemplateRevisionSourceConfigKind = `` /* 262-byte string literal not displayed */ WorkflowStepTemplateRevisionIsActive = `` /* 195-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 = "Destination kind for the runtime source configuration." 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 (
WorkflowGroupResourceName = "Name of the workflow group. Must be less than 100 characters. Allowed characters are ^[a-zA-Z0-9_/]+$"
)
Workflow Group
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.