gitlab.DeployKey
Explore with Pulumi AI
The gitlab.DeployKey
resource allows to manage the lifecycle of a deploy key.
To enable an already existing deploy key for another project use the
gitlab_project_deploy_key
resource.
Upstream API: GitLab REST API docs
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = new GitLab.DeployKey("example", new()
{
Key = "ssh-ed25519 AAAA...",
Project = "example/deploying",
Title = "Example deploy key",
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v6/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-ed25519 AAAA..."),
Project: pulumi.String("example/deploying"),
Title: pulumi.String("Example deploy key"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.DeployKey;
import com.pulumi.gitlab.DeployKeyArgs;
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 DeployKey("example", DeployKeyArgs.builder()
.key("ssh-ed25519 AAAA...")
.project("example/deploying")
.title("Example deploy key")
.build());
}
}
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.DeployKey("example",
key="ssh-ed25519 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-ed25519 AAAA...",
project: "example/deploying",
title: "Example deploy key",
});
resources:
example:
type: gitlab:DeployKey
properties:
key: ssh-ed25519 AAAA...
project: example/deploying
title: Example deploy key
Create 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)
public DeployKey(String name, DeployKeyArgs args)
public DeployKey(String name, DeployKeyArgs args, CustomResourceOptions options)
type: gitlab:DeployKey
properties: # The arguments to resource properties.
options: # 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.
- 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.
- name String
- The unique name of the resource.
- args DeployKeyArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The DeployKey resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the DeployKey resource produces the following output properties:
- Deploy
Key intId The id of the project deploy key.
- Id string
The provider-assigned unique ID for this managed resource.
- Deploy
Key intId The id of the project deploy key.
- Id string
The provider-assigned unique ID for this managed resource.
- deploy
Key IntegerId The id of the project deploy key.
- id String
The provider-assigned unique ID for this managed resource.
- deploy
Key numberId The id of the project deploy key.
- id string
The provider-assigned unique ID for this managed resource.
- deploy_
key_ intid The id of the project deploy key.
- id str
The provider-assigned unique ID for this managed resource.
- deploy
Key NumberId The id of the project deploy key.
- id String
The provider-assigned unique ID for this managed resource.
Look up 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,
deploy_key_id: Optional[int] = 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)
public static DeployKey get(String name, Output<String> id, DeployKeyState 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.
- Can
Push bool Allow this deploy key to be used to push changes to the project. Defaults to
false
.- Deploy
Key intId The id of the project deploy key.
- 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
.- Deploy
Key intId The id of the project deploy key.
- 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 Boolean Allow this deploy key to be used to push changes to the project. Defaults to
false
.- deploy
Key IntegerId The id of the project deploy key.
- 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 boolean Allow this deploy key to be used to push changes to the project. Defaults to
false
.- deploy
Key numberId The id of the project deploy key.
- 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
.- deploy_
key_ intid The id of the project deploy key.
- 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 Boolean Allow this deploy key to be used to push changes to the project. Defaults to
false
.- deploy
Key NumberId The id of the project deploy key.
- 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.
Import
GitLab deploy keys can be imported using an id made up of {project_id}:{deploy_key_id}
, e.g. project_id
can be whatever the [get single project api][get_single_project] takes for its :id
value, so for example
$ pulumi import gitlab:index/deployKey:DeployKey test 1:3
$ pulumi import gitlab:index/deployKey:DeployKey test richardc/example:3
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
gitlab
Terraform Provider.