Class DeployKey

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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

DeployKey

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.GitLab

Assembly: Pulumi.GitLab.dll

Syntax

public class DeployKey : CustomResource

Constructors

DeployKey(String, DeployKeyArgs, CustomResourceOptions)

Create a DeployKey resource with the given unique name, arguments, and options.

Declaration

public DeployKey(string name, DeployKeyArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DeployKeyArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CanPush

Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.

Declaration

public Output<bool?> CanPush { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Key

The public ssh key body.

Declaration

public Output<string> Key { get; }

Property Value

Type	Description
Output<System.String>

Project

The name or id of the project to add the deploy key to.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Title

A title to describe the deploy key with.

Declaration

public Output<string> Title { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, DeployKeyState, CustomResourceOptions)

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

Declaration

public static DeployKey Get(string name, Input<string> id, DeployKeyState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DeployKeyState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DeployKey