1. Packages
  2. GitLab
  3. API Docs
  4. ProjectJobTokenScopes
GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi

gitlab.ProjectJobTokenScopes

Explore with Pulumi AI

gitlab logo
GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi

    The gitlab.ProjectJobTokenScopes resource allows to manage the CI/CD Job Token scopes in a project. Any project not within the defined set in this attribute will be removed, which allows this resource to be used as an explicit deny.

    Conflicts with the use of gitlab.ProjectJobTokenScope when used on the same project. Use one or the other to ensure the desired state.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const allowedSingleProject = new gitlab.ProjectJobTokenScopes("allowed_single_project", {
        projectId: 111,
        targetProjectIds: [123],
    });
    const allowedMultipleProject = new gitlab.ProjectJobTokenScopes("allowed_multiple_project", {
        projectId: 111,
        targetProjectIds: [
            123,
            456,
            789,
        ],
    });
    // This will remove all job token scopes, even if added outside of TF.
    const explicitDeny = new gitlab.ProjectJobTokenScopes("explicit_deny", {
        projectId: 111,
        targetProjectIds: [],
    });
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    allowed_single_project = gitlab.ProjectJobTokenScopes("allowed_single_project",
        project_id=111,
        target_project_ids=[123])
    allowed_multiple_project = gitlab.ProjectJobTokenScopes("allowed_multiple_project",
        project_id=111,
        target_project_ids=[
            123,
            456,
            789,
        ])
    # This will remove all job token scopes, even if added outside of TF.
    explicit_deny = gitlab.ProjectJobTokenScopes("explicit_deny",
        project_id=111,
        target_project_ids=[])
    
    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.NewProjectJobTokenScopes(ctx, "allowed_single_project", &gitlab.ProjectJobTokenScopesArgs{
    			ProjectId: pulumi.Int(111),
    			TargetProjectIds: pulumi.IntArray{
    				pulumi.Int(123),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = gitlab.NewProjectJobTokenScopes(ctx, "allowed_multiple_project", &gitlab.ProjectJobTokenScopesArgs{
    			ProjectId: pulumi.Int(111),
    			TargetProjectIds: pulumi.IntArray{
    				pulumi.Int(123),
    				pulumi.Int(456),
    				pulumi.Int(789),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// This will remove all job token scopes, even if added outside of TF.
    		_, err = gitlab.NewProjectJobTokenScopes(ctx, "explicit_deny", &gitlab.ProjectJobTokenScopesArgs{
    			ProjectId:        pulumi.Int(111),
    			TargetProjectIds: pulumi.IntArray{},
    		})
    		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 allowedSingleProject = new GitLab.ProjectJobTokenScopes("allowed_single_project", new()
        {
            ProjectId = 111,
            TargetProjectIds = new[]
            {
                123,
            },
        });
    
        var allowedMultipleProject = new GitLab.ProjectJobTokenScopes("allowed_multiple_project", new()
        {
            ProjectId = 111,
            TargetProjectIds = new[]
            {
                123,
                456,
                789,
            },
        });
    
        // This will remove all job token scopes, even if added outside of TF.
        var explicitDeny = new GitLab.ProjectJobTokenScopes("explicit_deny", new()
        {
            ProjectId = 111,
            TargetProjectIds = new[] {},
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gitlab.ProjectJobTokenScopes;
    import com.pulumi.gitlab.ProjectJobTokenScopesArgs;
    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 allowedSingleProject = new ProjectJobTokenScopes("allowedSingleProject", ProjectJobTokenScopesArgs.builder()
                .projectId(111)
                .targetProjectIds(123)
                .build());
    
            var allowedMultipleProject = new ProjectJobTokenScopes("allowedMultipleProject", ProjectJobTokenScopesArgs.builder()
                .projectId(111)
                .targetProjectIds(            
                    123,
                    456,
                    789)
                .build());
    
            // This will remove all job token scopes, even if added outside of TF.
            var explicitDeny = new ProjectJobTokenScopes("explicitDeny", ProjectJobTokenScopesArgs.builder()
                .projectId(111)
                .targetProjectIds()
                .build());
    
        }
    }
    
    resources:
      allowedSingleProject:
        type: gitlab:ProjectJobTokenScopes
        name: allowed_single_project
        properties:
          projectId: 111
          targetProjectIds:
            - 123
      allowedMultipleProject:
        type: gitlab:ProjectJobTokenScopes
        name: allowed_multiple_project
        properties:
          projectId: 111
          targetProjectIds:
            - 123
            - 456
            - 789
      # This will remove all job token scopes, even if added outside of TF.
      explicitDeny:
        type: gitlab:ProjectJobTokenScopes
        name: explicit_deny
        properties:
          projectId: 111
          targetProjectIds: []
    

    Create ProjectJobTokenScopes Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProjectJobTokenScopes(name: string, args: ProjectJobTokenScopesArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectJobTokenScopes(resource_name: str,
                              args: ProjectJobTokenScopesArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectJobTokenScopes(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              project_id: Optional[int] = None,
                              target_project_ids: Optional[Sequence[int]] = None)
    func NewProjectJobTokenScopes(ctx *Context, name string, args ProjectJobTokenScopesArgs, opts ...ResourceOption) (*ProjectJobTokenScopes, error)
    public ProjectJobTokenScopes(string name, ProjectJobTokenScopesArgs args, CustomResourceOptions? opts = null)
    public ProjectJobTokenScopes(String name, ProjectJobTokenScopesArgs args)
    public ProjectJobTokenScopes(String name, ProjectJobTokenScopesArgs args, CustomResourceOptions options)
    
    type: gitlab:ProjectJobTokenScopes
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectJobTokenScopesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectJobTokenScopesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectJobTokenScopesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectJobTokenScopesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectJobTokenScopesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var projectJobTokenScopesResource = new GitLab.ProjectJobTokenScopes("projectJobTokenScopesResource", new()
    {
        ProjectId = 0,
        TargetProjectIds = new[]
        {
            0,
        },
    });
    
    example, err := gitlab.NewProjectJobTokenScopes(ctx, "projectJobTokenScopesResource", &gitlab.ProjectJobTokenScopesArgs{
    	ProjectId: pulumi.Int(0),
    	TargetProjectIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    })
    
    var projectJobTokenScopesResource = new ProjectJobTokenScopes("projectJobTokenScopesResource", ProjectJobTokenScopesArgs.builder()
        .projectId(0)
        .targetProjectIds(0)
        .build());
    
    project_job_token_scopes_resource = gitlab.ProjectJobTokenScopes("projectJobTokenScopesResource",
        project_id=0,
        target_project_ids=[0])
    
    const projectJobTokenScopesResource = new gitlab.ProjectJobTokenScopes("projectJobTokenScopesResource", {
        projectId: 0,
        targetProjectIds: [0],
    });
    
    type: gitlab:ProjectJobTokenScopes
    properties:
        projectId: 0
        targetProjectIds:
            - 0
    

    ProjectJobTokenScopes Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ProjectJobTokenScopes resource accepts the following input properties:

    ProjectId int
    The ID of the project.
    TargetProjectIds List<int>
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    ProjectId int
    The ID of the project.
    TargetProjectIds []int
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId Integer
    The ID of the project.
    targetProjectIds List<Integer>
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId number
    The ID of the project.
    targetProjectIds number[]
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    project_id int
    The ID of the project.
    target_project_ids Sequence[int]
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId Number
    The ID of the project.
    targetProjectIds List<Number>
    A set of project IDs that are in the CI/CD job token inbound allowlist.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectJobTokenScopes resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProjectJobTokenScopes Resource

    Get an existing ProjectJobTokenScopes resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectJobTokenScopesState, opts?: CustomResourceOptions): ProjectJobTokenScopes
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            project_id: Optional[int] = None,
            target_project_ids: Optional[Sequence[int]] = None) -> ProjectJobTokenScopes
    func GetProjectJobTokenScopes(ctx *Context, name string, id IDInput, state *ProjectJobTokenScopesState, opts ...ResourceOption) (*ProjectJobTokenScopes, error)
    public static ProjectJobTokenScopes Get(string name, Input<string> id, ProjectJobTokenScopesState? state, CustomResourceOptions? opts = null)
    public static ProjectJobTokenScopes get(String name, Output<String> id, ProjectJobTokenScopesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ProjectId int
    The ID of the project.
    TargetProjectIds List<int>
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    ProjectId int
    The ID of the project.
    TargetProjectIds []int
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId Integer
    The ID of the project.
    targetProjectIds List<Integer>
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId number
    The ID of the project.
    targetProjectIds number[]
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    project_id int
    The ID of the project.
    target_project_ids Sequence[int]
    A set of project IDs that are in the CI/CD job token inbound allowlist.
    projectId Number
    The ID of the project.
    targetProjectIds List<Number>
    A set of project IDs that are in the CI/CD job token inbound allowlist.

    Import

    GitLab project job token scopes can be imported using an id made up of just the project_id as an integer

    $ pulumi import gitlab:index/projectJobTokenScopes:ProjectJobTokenScopes bar 123
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.1.0 published on Friday, Jun 21, 2024 by Pulumi