GitLab

Pulumi Official
Package maintained by Pulumi
v4.7.1 published on Thursday, Jun 30, 2022 by Pulumi

getInstanceDeployKeys

The gitlab.getInstanceDeployKeys data source allows to retrieve a list of deploy keys for a GitLab instance.

This data source requires administration privileges.

Upstream API: GitLab REST API docs

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(GitLab.GetInstanceDeployKeys.InvokeAsync(new GitLab.GetInstanceDeployKeysArgs
        {
            Public = true,
        }));
    }

}
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.GetInstanceDeployKeys(ctx, &GetInstanceDeployKeysArgs{
			Public: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(GitlabFunctions.getInstanceDeployKeys(GetInstanceDeployKeysArgs.builder()
            .public_(true)
            .build()));

    }
}
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_instance_deploy_keys(public=True)
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

// only public deploy keys
const example = pulumi.output(gitlab.getInstanceDeployKeys({
    public: true,
}));
variables:
  example:
    Fn::Invoke:
      Function: gitlab:getInstanceDeployKeys
      Arguments:
        public: true

Using getInstanceDeployKeys

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstanceDeployKeys(args: GetInstanceDeployKeysArgs, opts?: InvokeOptions): Promise<GetInstanceDeployKeysResult>
function getInstanceDeployKeysOutput(args: GetInstanceDeployKeysOutputArgs, opts?: InvokeOptions): Output<GetInstanceDeployKeysResult>
def get_instance_deploy_keys(public: Optional[bool] = None,
                             opts: Optional[InvokeOptions] = None) -> GetInstanceDeployKeysResult
def get_instance_deploy_keys_output(public: Optional[pulumi.Input[bool]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetInstanceDeployKeysResult]
func GetInstanceDeployKeys(ctx *Context, args *GetInstanceDeployKeysArgs, opts ...InvokeOption) (*GetInstanceDeployKeysResult, error)
func GetInstanceDeployKeysOutput(ctx *Context, args *GetInstanceDeployKeysOutputArgs, opts ...InvokeOption) GetInstanceDeployKeysResultOutput

> Note: This function is named GetInstanceDeployKeys in the Go SDK.

public static class GetInstanceDeployKeys 
{
    public static Task<GetInstanceDeployKeysResult> InvokeAsync(GetInstanceDeployKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceDeployKeysResult> Invoke(GetInstanceDeployKeysInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceDeployKeysResult> getInstanceDeployKeys(GetInstanceDeployKeysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: gitlab:index/getInstanceDeployKeys:getInstanceDeployKeys
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Public bool
Public bool
public_ Boolean
public boolean
public bool
public Boolean

getInstanceDeployKeys Result

The following output properties are available:

DeployKeys List<Pulumi.GitLab.Outputs.GetInstanceDeployKeysDeployKey>
Id string

The provider-assigned unique ID for this managed resource.

Public bool
DeployKeys []GetInstanceDeployKeysDeployKey
Id string

The provider-assigned unique ID for this managed resource.

Public bool
deployKeys List<GetInstanceDeployKeysDeployKey>
id String

The provider-assigned unique ID for this managed resource.

public_ Boolean
deployKeys GetInstanceDeployKeysDeployKey[]
id string

The provider-assigned unique ID for this managed resource.

public boolean
deploy_keys Sequence[GetInstanceDeployKeysDeployKey]
id str

The provider-assigned unique ID for this managed resource.

public bool
deployKeys List<Property Map>
id String

The provider-assigned unique ID for this managed resource.

public Boolean

Supporting Types

GetInstanceDeployKeysDeployKey

GetInstanceDeployKeysDeployKeyProjectsWithWriteAccess

CreatedAt string
Description string
Id int
Name string
NameWithNamespace string
Path string
PathWithNamespace string
CreatedAt string
Description string
Id int
Name string
NameWithNamespace string
Path string
PathWithNamespace string
createdAt String
description String
id Integer
name String
nameWithNamespace String
path String
pathWithNamespace String
createdAt string
description string
id number
name string
nameWithNamespace string
path string
pathWithNamespace string
createdAt String
description String
id Number
name String
nameWithNamespace String
path String
pathWithNamespace String

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes

This Pulumi package is based on the gitlab Terraform Provider.