1. Docs
  2. Reference
  3. API
  4. GitHub
  5. UserGpgKey

UserGpgKey

Provides a GitHub user’s GPG key resource.

This resource allows you to add/remove GPG keys from your user account.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Github.UserGpgKey("example", new Github.UserGpgKeyArgs
        {
            ArmoredPublicKey = @"-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----
",
        });
    }

}

Coming soon!

import pulumi
import pulumi_github as github

example = github.UserGpgKey("example", armored_public_key="""-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----
""")
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = new github.UserGpgKey("example", {
    armoredPublicKey: `-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----`,
});

Create a UserGpgKey Resource

new UserGpgKey(name: string, args: UserGpgKeyArgs, opts?: CustomResourceOptions);
def UserGpgKey(resource_name, opts=None, armored_public_key=None, __props__=None);
func NewUserGpgKey(ctx *Context, name string, args UserGpgKeyArgs, opts ...ResourceOption) (*UserGpgKey, error)
public UserGpgKey(string name, UserGpgKeyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args UserGpgKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserGpgKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserGpgKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

UserGpgKey Resource Properties

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

Inputs

The UserGpgKey resource accepts the following input properties:

ArmoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

ArmoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

armoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

armored_public_key str

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserGpgKey resource produces the following output properties:

Etag string
Id string
The provider-assigned unique ID for this managed resource.
KeyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

Etag string
Id string
The provider-assigned unique ID for this managed resource.
KeyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

etag string
id string
The provider-assigned unique ID for this managed resource.
keyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

etag str
id str
The provider-assigned unique ID for this managed resource.
key_id str

The key ID of the GPG key, e.g. 3262EFF25BA0D270

Look up an Existing UserGpgKey Resource

Get an existing UserGpgKey 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?: UserGpgKeyState, opts?: CustomResourceOptions): UserGpgKey
static get(resource_name, id, opts=None, armored_public_key=None, etag=None, key_id=None, __props__=None);
func GetUserGpgKey(ctx *Context, name string, id IDInput, state *UserGpgKeyState, opts ...ResourceOption) (*UserGpgKey, error)
public static UserGpgKey Get(string name, Input<string> id, UserGpgKeyState? 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:

ArmoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

Etag string
KeyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

ArmoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

Etag string
KeyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

armoredPublicKey string

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

etag string
keyId string

The key ID of the GPG key, e.g. 3262EFF25BA0D270

armored_public_key str

Your public GPG key, generated in ASCII-armored format. See Generating a new GPG key for help on creating a GPG key.

etag str
key_id str

The key ID of the GPG key, e.g. 3262EFF25BA0D270

Package Details

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