1. Packages
  2. GitLab
  3. API Docs
  4. getComplianceFramework
GitLab v8.2.0 published on Friday, Jul 19, 2024 by Pulumi

gitlab.getComplianceFramework

Explore with Pulumi AI

gitlab logo
GitLab v8.2.0 published on Friday, Jul 19, 2024 by Pulumi

    The gitlab.ComplianceFramework data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to.

    Upstream API: GitLab GraphQL API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const example = gitlab.getComplianceFramework({
        namespacePath: "top-level-group",
        name: "HIPAA",
    });
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    example = gitlab.get_compliance_framework(namespace_path="top-level-group",
        name="HIPAA")
    
    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.LookupComplianceFramework(ctx, &gitlab.LookupComplianceFrameworkArgs{
    			NamespacePath: "top-level-group",
    			Name:          "HIPAA",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using GitLab = Pulumi.GitLab;
    
    return await Deployment.RunAsync(() => 
    {
        var example = GitLab.GetComplianceFramework.Invoke(new()
        {
            NamespacePath = "top-level-group",
            Name = "HIPAA",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gitlab.GitlabFunctions;
    import com.pulumi.gitlab.inputs.GetComplianceFrameworkArgs;
    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) {
            final var example = GitlabFunctions.getComplianceFramework(GetComplianceFrameworkArgs.builder()
                .namespacePath("top-level-group")
                .name("HIPAA")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: gitlab:getComplianceFramework
          Arguments:
            namespacePath: top-level-group
            name: HIPAA
    

    Using getComplianceFramework

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getComplianceFramework(args: GetComplianceFrameworkArgs, opts?: InvokeOptions): Promise<GetComplianceFrameworkResult>
    function getComplianceFrameworkOutput(args: GetComplianceFrameworkOutputArgs, opts?: InvokeOptions): Output<GetComplianceFrameworkResult>
    def get_compliance_framework(name: Optional[str] = None,
                                 namespace_path: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetComplianceFrameworkResult
    def get_compliance_framework_output(name: Optional[pulumi.Input[str]] = None,
                                 namespace_path: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetComplianceFrameworkResult]
    func LookupComplianceFramework(ctx *Context, args *LookupComplianceFrameworkArgs, opts ...InvokeOption) (*LookupComplianceFrameworkResult, error)
    func LookupComplianceFrameworkOutput(ctx *Context, args *LookupComplianceFrameworkOutputArgs, opts ...InvokeOption) LookupComplianceFrameworkResultOutput

    > Note: This function is named LookupComplianceFramework in the Go SDK.

    public static class GetComplianceFramework 
    {
        public static Task<GetComplianceFrameworkResult> InvokeAsync(GetComplianceFrameworkArgs args, InvokeOptions? opts = null)
        public static Output<GetComplianceFrameworkResult> Invoke(GetComplianceFrameworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComplianceFrameworkResult> getComplianceFramework(GetComplianceFrameworkArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gitlab:index/getComplianceFramework:getComplianceFramework
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name for the compliance framework.
    NamespacePath string
    Full path of the namespace to where the compliance framework is.
    Name string
    Name for the compliance framework.
    NamespacePath string
    Full path of the namespace to where the compliance framework is.
    name String
    Name for the compliance framework.
    namespacePath String
    Full path of the namespace to where the compliance framework is.
    name string
    Name for the compliance framework.
    namespacePath string
    Full path of the namespace to where the compliance framework is.
    name str
    Name for the compliance framework.
    namespace_path str
    Full path of the namespace to where the compliance framework is.
    name String
    Name for the compliance framework.
    namespacePath String
    Full path of the namespace to where the compliance framework is.

    getComplianceFramework Result

    The following output properties are available:

    Color string
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    Default bool
    Is the compliance framework the default framework for the group.
    Description string
    Description for the compliance framework.
    FrameworkId string
    Globally unique ID of the compliance framework.
    Id string
    Name string
    Name for the compliance framework.
    NamespacePath string
    Full path of the namespace to where the compliance framework is.
    PipelineConfigurationFullPath string
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.
    Color string
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    Default bool
    Is the compliance framework the default framework for the group.
    Description string
    Description for the compliance framework.
    FrameworkId string
    Globally unique ID of the compliance framework.
    Id string
    Name string
    Name for the compliance framework.
    NamespacePath string
    Full path of the namespace to where the compliance framework is.
    PipelineConfigurationFullPath string
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.
    color String
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    default_ Boolean
    Is the compliance framework the default framework for the group.
    description String
    Description for the compliance framework.
    frameworkId String
    Globally unique ID of the compliance framework.
    id String
    name String
    Name for the compliance framework.
    namespacePath String
    Full path of the namespace to where the compliance framework is.
    pipelineConfigurationFullPath String
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.
    color string
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    default boolean
    Is the compliance framework the default framework for the group.
    description string
    Description for the compliance framework.
    frameworkId string
    Globally unique ID of the compliance framework.
    id string
    name string
    Name for the compliance framework.
    namespacePath string
    Full path of the namespace to where the compliance framework is.
    pipelineConfigurationFullPath string
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.
    color str
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    default bool
    Is the compliance framework the default framework for the group.
    description str
    Description for the compliance framework.
    framework_id str
    Globally unique ID of the compliance framework.
    id str
    name str
    Name for the compliance framework.
    namespace_path str
    Full path of the namespace to where the compliance framework is.
    pipeline_configuration_full_path str
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.
    color String
    Color representation of the compliance framework in hex format. e.g. #FCA121.
    default Boolean
    Is the compliance framework the default framework for the group.
    description String
    Description for the compliance framework.
    frameworkId String
    Globally unique ID of the compliance framework.
    id String
    name String
    Name for the compliance framework.
    namespacePath String
    Full path of the namespace to where the compliance framework is.
    pipelineConfigurationFullPath String
    Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa. Format: path/file.y[a]ml@group-name/project-name Note: Ultimate license required.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.2.0 published on Friday, Jul 19, 2024 by Pulumi