The gitlab.ProjectCicdCatalog resource allows users to manage the lifecycle of a CI/CD Catalog project.
This resource controls whether a project is available as a CI/CD Catalog resource.
If
keep_settings_on_destroyis set to false, destroying the resource will revert the catalog status to the value that was present when the resource was first created. You will need to apply the resource with the new setting before destroying the resource.
Upstream API: GitLab GraphQL API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.ProjectCicdCatalog("example", {
project: "namespace/project",
enabled: true,
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.ProjectCicdCatalog("example",
project="namespace/project",
enabled=True)
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v9/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.NewProjectCicdCatalog(ctx, "example", &gitlab.ProjectCicdCatalogArgs{
Project: pulumi.String("namespace/project"),
Enabled: pulumi.Bool(true),
})
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 = new GitLab.ProjectCicdCatalog("example", new()
{
Project = "namespace/project",
Enabled = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ProjectCicdCatalog;
import com.pulumi.gitlab.ProjectCicdCatalogArgs;
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 example = new ProjectCicdCatalog("example", ProjectCicdCatalogArgs.builder()
.project("namespace/project")
.enabled(true)
.build());
}
}
resources:
example:
type: gitlab:ProjectCicdCatalog
properties:
project: namespace/project
enabled: true
Create ProjectCicdCatalog Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProjectCicdCatalog(name: string, args: ProjectCicdCatalogArgs, opts?: CustomResourceOptions);@overload
def ProjectCicdCatalog(resource_name: str,
args: ProjectCicdCatalogArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ProjectCicdCatalog(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
project: Optional[str] = None,
keep_settings_on_destroy: Optional[bool] = None)func NewProjectCicdCatalog(ctx *Context, name string, args ProjectCicdCatalogArgs, opts ...ResourceOption) (*ProjectCicdCatalog, error)public ProjectCicdCatalog(string name, ProjectCicdCatalogArgs args, CustomResourceOptions? opts = null)
public ProjectCicdCatalog(String name, ProjectCicdCatalogArgs args)
public ProjectCicdCatalog(String name, ProjectCicdCatalogArgs args, CustomResourceOptions options)
type: gitlab:ProjectCicdCatalog
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 ProjectCicdCatalogArgs
- 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 ProjectCicdCatalogArgs
- 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 ProjectCicdCatalogArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectCicdCatalogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectCicdCatalogArgs
- 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 projectCicdCatalogResource = new GitLab.ProjectCicdCatalog("projectCicdCatalogResource", new()
{
Enabled = false,
Project = "string",
KeepSettingsOnDestroy = false,
});
example, err := gitlab.NewProjectCicdCatalog(ctx, "projectCicdCatalogResource", &gitlab.ProjectCicdCatalogArgs{
Enabled: pulumi.Bool(false),
Project: pulumi.String("string"),
KeepSettingsOnDestroy: pulumi.Bool(false),
})
var projectCicdCatalogResource = new ProjectCicdCatalog("projectCicdCatalogResource", ProjectCicdCatalogArgs.builder()
.enabled(false)
.project("string")
.keepSettingsOnDestroy(false)
.build());
project_cicd_catalog_resource = gitlab.ProjectCicdCatalog("projectCicdCatalogResource",
enabled=False,
project="string",
keep_settings_on_destroy=False)
const projectCicdCatalogResource = new gitlab.ProjectCicdCatalog("projectCicdCatalogResource", {
enabled: false,
project: "string",
keepSettingsOnDestroy: false,
});
type: gitlab:ProjectCicdCatalog
properties:
enabled: false
keepSettingsOnDestroy: false
project: string
ProjectCicdCatalog Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProjectCicdCatalog resource accepts the following input properties:
- Enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- Project string
- The ID or URL-encoded path of the project.
- Keep
Settings boolOn Destroy
- Enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- Project string
- The ID or URL-encoded path of the project.
- Keep
Settings boolOn Destroy
- enabled Boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- project String
- The ID or URL-encoded path of the project.
- keep
Settings BooleanOn Destroy
- enabled boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- project string
- The ID or URL-encoded path of the project.
- keep
Settings booleanOn Destroy
- enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- project str
- The ID or URL-encoded path of the project.
- keep_
settings_ boolon_ destroy
- enabled Boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- project String
- The ID or URL-encoded path of the project.
- keep
Settings BooleanOn Destroy
Outputs
All input properties are implicitly available as output properties. Additionally, the ProjectCicdCatalog 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 ProjectCicdCatalog Resource
Get an existing ProjectCicdCatalog 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?: ProjectCicdCatalogState, opts?: CustomResourceOptions): ProjectCicdCatalog@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
keep_settings_on_destroy: Optional[bool] = None,
project: Optional[str] = None) -> ProjectCicdCatalogfunc GetProjectCicdCatalog(ctx *Context, name string, id IDInput, state *ProjectCicdCatalogState, opts ...ResourceOption) (*ProjectCicdCatalog, error)public static ProjectCicdCatalog Get(string name, Input<string> id, ProjectCicdCatalogState? state, CustomResourceOptions? opts = null)public static ProjectCicdCatalog get(String name, Output<String> id, ProjectCicdCatalogState state, CustomResourceOptions options)resources: _: type: gitlab:ProjectCicdCatalog get: id: ${id}- 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.
- Enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- Keep
Settings boolOn Destroy - Project string
- The ID or URL-encoded path of the project.
- Enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- Keep
Settings boolOn Destroy - Project string
- The ID or URL-encoded path of the project.
- enabled Boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- keep
Settings BooleanOn Destroy - project String
- The ID or URL-encoded path of the project.
- enabled boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- keep
Settings booleanOn Destroy - project string
- The ID or URL-encoded path of the project.
- enabled bool
- Whether the project should be enabled as a CI/CD Catalog resource.
- keep_
settings_ boolon_ destroy - project str
- The ID or URL-encoded path of the project.
- enabled Boolean
- Whether the project should be enabled as a CI/CD Catalog resource.
- keep
Settings BooleanOn Destroy - project String
- The ID or URL-encoded path of the project.
Import
Starting in Terraform v1.5.0, you can use an import block to import gitlab_project_cicd_catalog. For example:
terraform
import {
to = gitlab_project_cicd_catalog.example
id = “see CLI command below for ID”
}
Importing using the CLI is supported with the following syntax:
Gitlab Project CICD Catalogs can be imported with their id, e.g.
$ pulumi import gitlab:index/projectCicdCatalog:ProjectCicdCatalog example "1"
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
gitlabTerraform Provider.
