DeployKey

# gitlab_deploy_key

This resource allows you to create and manage deploy keys for your GitLab projects.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new GitLab.DeployKey("example", new GitLab.DeployKeyArgs
        {
            Key = "ssh-rsa AAAA...",
            Project = "example/deploying",
            Title = "Example deploy key",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v4/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewDeployKey(ctx, "example", &gitlab.DeployKeyArgs{
			Key:     pulumi.String("ssh-rsa AAAA..."),
			Project: pulumi.String("example/deploying"),
			Title:   pulumi.String("Example deploy key"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.DeployKey("example",
    key="ssh-rsa AAAA...",
    project="example/deploying",
    title="Example deploy key")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.DeployKey("example", {
    key: "ssh-rsa AAAA...",
    project: "example/deploying",
    title: "Example deploy key",
});

Create a DeployKey Resource

new DeployKey(name: string, args: DeployKeyArgs, opts?: CustomResourceOptions);
@overload
def DeployKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              can_push: Optional[bool] = None,
              key: Optional[str] = None,
              project: Optional[str] = None,
              title: Optional[str] = None)
@overload
def DeployKey(resource_name: str,
              args: DeployKeyArgs,
              opts: Optional[ResourceOptions] = None)
func NewDeployKey(ctx *Context, name string, args DeployKeyArgs, opts ...ResourceOption) (*DeployKey, error)
public DeployKey(string name, DeployKeyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DeployKeyArgs
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 DeployKeyArgs
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 DeployKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeployKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DeployKey Resource Properties

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

Inputs

The DeployKey resource accepts the following input properties:

Key string
The public ssh key body.
Project string
The name or id of the project to add the deploy key to.
Title string
A title to describe the deploy key with.
CanPush bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
Key string
The public ssh key body.
Project string
The name or id of the project to add the deploy key to.
Title string
A title to describe the deploy key with.
CanPush bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
key string
The public ssh key body.
project string
The name or id of the project to add the deploy key to.
title string
A title to describe the deploy key with.
canPush boolean
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
key str
The public ssh key body.
project str
The name or id of the project to add the deploy key to.
title str
A title to describe the deploy key with.
can_push bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeployKey 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing DeployKey Resource

Get an existing DeployKey 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?: DeployKeyState, opts?: CustomResourceOptions): DeployKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_push: Optional[bool] = None,
        key: Optional[str] = None,
        project: Optional[str] = None,
        title: Optional[str] = None) -> DeployKey
func GetDeployKey(ctx *Context, name string, id IDInput, state *DeployKeyState, opts ...ResourceOption) (*DeployKey, error)
public static DeployKey Get(string name, Input<string> id, DeployKeyState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

CanPush bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
Key string
The public ssh key body.
Project string
The name or id of the project to add the deploy key to.
Title string
A title to describe the deploy key with.
CanPush bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
Key string
The public ssh key body.
Project string
The name or id of the project to add the deploy key to.
Title string
A title to describe the deploy key with.
canPush boolean
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
key string
The public ssh key body.
project string
The name or id of the project to add the deploy key to.
title string
A title to describe the deploy key with.
can_push bool
Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.
key str
The public ssh key body.
project str
The name or id of the project to add the deploy key to.
title str
A title to describe the deploy key with.

Import

GitLab deploy keys can be imported using an id made up of {project_id}:{deploy_key_id}, e.g.

 $ pulumi import gitlab:index/deployKey:DeployKey test 1:3

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.