ComplianceFramework

class ComplianceFramework : KotlinCustomResource

The gitlab.ComplianceFramework resource allows to manage the lifecycle of a compliance framework on top-level groups. There can be only one default compliance framework. Of all the configured compliance frameworks marked as default, the last one applied will be the default compliance framework.

This resource requires a GitLab Enterprise instance with a Premium license to create the compliance framework. This resource requires a GitLab Enterprise instance with an Ultimate license to specify a compliance pipeline configuration in the compliance framework. Upstream API: GitLab GraphQL API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const sample = new gitlab.ComplianceFramework("sample", {
namespacePath: "top-level-group",
name: "HIPAA",
description: "A HIPAA Compliance Framework",
color: "#87BEEF",
"default": false,
pipelineConfigurationFullPath: ".hipaa.yml@top-level-group/compliance-frameworks",
});
import pulumi
import pulumi_gitlab as gitlab
sample = gitlab.ComplianceFramework("sample",
namespace_path="top-level-group",
name="HIPAA",
description="A HIPAA Compliance Framework",
color="#87BEEF",
default=False,
pipeline_configuration_full_path=".hipaa.yml@top-level-group/compliance-frameworks")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var sample = new GitLab.ComplianceFramework("sample", new()
{
NamespacePath = "top-level-group",
Name = "HIPAA",
Description = "A HIPAA Compliance Framework",
Color = "#87BEEF",
Default = false,
PipelineConfigurationFullPath = ".hipaa.yml@top-level-group/compliance-frameworks",
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.NewComplianceFramework(ctx, "sample", &gitlab.ComplianceFrameworkArgs{
NamespacePath: pulumi.String("top-level-group"),
Name: pulumi.String("HIPAA"),
Description: pulumi.String("A HIPAA Compliance Framework"),
Color: pulumi.String("#87BEEF"),
Default: pulumi.Bool(false),
PipelineConfigurationFullPath: pulumi.String(".hipaa.yml@top-level-group/compliance-frameworks"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ComplianceFramework;
import com.pulumi.gitlab.ComplianceFrameworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var sample = new ComplianceFramework("sample", ComplianceFrameworkArgs.builder()
.namespacePath("top-level-group")
.name("HIPAA")
.description("A HIPAA Compliance Framework")
.color("#87BEEF")
.default_(false)
.pipelineConfigurationFullPath(".hipaa.yml@top-level-group/compliance-frameworks")
.build());
}
}
resources:
sample:
type: gitlab:ComplianceFramework
properties:
namespacePath: top-level-group
name: HIPAA
description: A HIPAA Compliance Framework
color: '#87BEEF'
default: false
pipelineConfigurationFullPath: .hipaa.yml@top-level-group/compliance-frameworks

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_compliance_framework. For example: terraform import { to = gitlab_compliance_framework.example id = "see CLI command below for ID" } Import using the CLI is supported using the following syntax: Gitlab compliance frameworks can be imported with a key composed of <namespace_path>:<framework_id>, e.g.

$ pulumi import gitlab:index/complianceFramework:ComplianceFramework sample "top-level-group:gid://gitlab/ComplianceManagement::Framework/12345"

Properties

Link copied to clipboard
val color: Output<String>

New color representation of the compliance framework in hex format. e.g. #FCA121.

Link copied to clipboard
val default: Output<Boolean>

Set this compliance framework as the default framework for the group. Default: false

Link copied to clipboard
val description: Output<String>

Description for the compliance framework.

Link copied to clipboard
val frameworkId: Output<String>

Globally unique ID of the compliance framework.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Name for the compliance framework.

Link copied to clipboard
val namespacePath: Output<String>

Full path of the namespace to add the compliance framework to.

Link copied to clipboard

Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Required format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>