pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/ComplianceFrameworkArgs

ComplianceFrameworkArgs

data class ComplianceFrameworkArgs(val color: Output<String>? = null, val default: Output<Boolean>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val namespacePath: Output<String>? = null, val pipelineConfigurationFullPath: Output<String>? = null) : ConvertibleToJava<ComplianceFrameworkArgs>

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", {
    color: "#87BEEF",
    "default": false,
    description: "A HIPAA Compliance Framework",
    namespacePath: "top-level-group",
    pipelineConfigurationFullPath: ".hipaa.yml@top-level-group/compliance-frameworks",
});

import pulumi
import pulumi_gitlab as gitlab
sample = gitlab.ComplianceFramework("sample",
    color="#87BEEF",
    default=False,
    description="A HIPAA Compliance Framework",
    namespace_path="top-level-group",
    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()
    {
        Color = "#87BEEF",
        Default = false,
        Description = "A HIPAA Compliance Framework",
        NamespacePath = "top-level-group",
        PipelineConfigurationFullPath = ".hipaa.yml@top-level-group/compliance-frameworks",
    });
});

package main
import (
	"github.com/pulumi/pulumi-gitlab/sdk/v6/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{
			Color:                         pulumi.String("#87BEEF"),
			Default:                       pulumi.Bool(false),
			Description:                   pulumi.String("A HIPAA Compliance Framework"),
			NamespacePath:                 pulumi.String("top-level-group"),
			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()
            .color("#87BEEF")
            .default_(false)
            .description("A HIPAA Compliance Framework")
            .namespacePath("top-level-group")
            .pipelineConfigurationFullPath(".hipaa.yml@top-level-group/compliance-frameworks")
            .build());
    }
}

resources:
  sample:
    type: gitlab:ComplianceFramework
    properties:
      color: '#87BEEF'
      default: false
      description: A HIPAA Compliance Framework
      namespacePath: top-level-group
      pipelineConfigurationFullPath: .hipaa.yml@top-level-group/compliance-frameworks

Import

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"

Constructors

ComplianceFrameworkArgs

constructor(color: Output<String>? = null, default: Output<Boolean>? = null, description: Output<String>? = null, name: Output<String>? = null, namespacePath: Output<String>? = null, pipelineConfigurationFullPath: Output<String>? = null)

Properties

color

val color: Output<String>? = null

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

default

val default: Output<Boolean>? = null

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

description

val description: Output<String>? = null

Description for the compliance framework.

name

val name: Output<String>? = null

Name for the compliance framework.

namespacePath

val namespacePath: Output<String>? = null

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

pipelineConfigurationFullPath

val pipelineConfigurationFullPath: Output<String>? = null

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.

Functions

toJava

open override fun toJava(): ComplianceFrameworkArgs