github.CodespacesUserSecret

This resource allows you to create and manage GitHub Codespaces secrets within your GitHub user. You must have write access to a repository to use this resource.

Secret values are encrypted using the Go ‘/crypto/box’ module which is interoperable with libsodium. Libsodium is used by GitHub to decrypt secret values.

For the purposes of security, the contents of the plaintextValue field have been marked as sensitive to Terraform, but it is important to note that this does not hide it from state files. You should treat state as sensitive always. It is also advised that you do not store plaintext values in your code but rather populate the encryptedValue using fields from a resource, data source or variable as, while encrypted in state, these will be easily accessible in your code. See below for an example of this abstraction.

Create CodespacesUserSecret Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CodespacesUserSecret(name: string, args: CodespacesUserSecretArgs, opts?: CustomResourceOptions);

@overload
def CodespacesUserSecret(resource_name: str,
                         args: CodespacesUserSecretArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def CodespacesUserSecret(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         secret_name: Optional[str] = None,
                         encrypted_value: Optional[str] = None,
                         plaintext_value: Optional[str] = None,
                         selected_repository_ids: Optional[Sequence[int]] = None)

func NewCodespacesUserSecret(ctx *Context, name string, args CodespacesUserSecretArgs, opts ...ResourceOption) (*CodespacesUserSecret, error)

public CodespacesUserSecret(string name, CodespacesUserSecretArgs args, CustomResourceOptions? opts = null)

public CodespacesUserSecret(String name, CodespacesUserSecretArgs args)
public CodespacesUserSecret(String name, CodespacesUserSecretArgs args, CustomResourceOptions options)

type: github:CodespacesUserSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var codespacesUserSecretResource = new Github.CodespacesUserSecret("codespacesUserSecretResource", new()
{
    SecretName = "string",
    EncryptedValue = "string",
    PlaintextValue = "string",
    SelectedRepositoryIds = new[]
    {
        0,
    },
});

example, err := github.NewCodespacesUserSecret(ctx, "codespacesUserSecretResource", &github.CodespacesUserSecretArgs{
	SecretName:     pulumi.String("string"),
	EncryptedValue: pulumi.String("string"),
	PlaintextValue: pulumi.String("string"),
	SelectedRepositoryIds: pulumi.IntArray{
		pulumi.Int(0),
	},
})

var codespacesUserSecretResource = new CodespacesUserSecret("codespacesUserSecretResource", CodespacesUserSecretArgs.builder()
    .secretName("string")
    .encryptedValue("string")
    .plaintextValue("string")
    .selectedRepositoryIds(0)
    .build());

codespaces_user_secret_resource = github.CodespacesUserSecret("codespacesUserSecretResource",
    secret_name="string",
    encrypted_value="string",
    plaintext_value="string",
    selected_repository_ids=[0])

const codespacesUserSecretResource = new github.CodespacesUserSecret("codespacesUserSecretResource", {
    secretName: "string",
    encryptedValue: "string",
    plaintextValue: "string",
    selectedRepositoryIds: [0],
});

type: github:CodespacesUserSecret
properties:
    encryptedValue: string
    plaintextValue: string
    secretName: string
    selectedRepositoryIds:
        - 0

CodespacesUserSecret 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 CodespacesUserSecret resource accepts the following input properties:

Outputs

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

Look up Existing CodespacesUserSecret Resource

Get an existing CodespacesUserSecret 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?: CodespacesUserSecretState, opts?: CustomResourceOptions): CodespacesUserSecret

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        encrypted_value: Optional[str] = None,
        plaintext_value: Optional[str] = None,
        secret_name: Optional[str] = None,
        selected_repository_ids: Optional[Sequence[int]] = None,
        updated_at: Optional[str] = None) -> CodespacesUserSecret

func GetCodespacesUserSecret(ctx *Context, name string, id IDInput, state *CodespacesUserSecretState, opts ...ResourceOption) (*CodespacesUserSecret, error)

public static CodespacesUserSecret Get(string name, Input<string> id, CodespacesUserSecretState? state, CustomResourceOptions? opts = null)

public static CodespacesUserSecret get(String name, Output<String> id, CodespacesUserSecretState state, CustomResourceOptions options)

resources:  _:    type: github:CodespacesUserSecret    get:      id: ${id}

Import

This resource can be imported using an ID made up of the secret name:

$ pulumi import github:index/codespacesUserSecret:CodespacesUserSecret test_secret test_secret_name

NOTE: the implementation is limited in that it won’t fetch the value of the plaintextValue or encryptedValue fields when importing. You may need to ignore changes for these as a workaround.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

GitHub pulumi/pulumi-github

License

Apache-2.0

Notes

This Pulumi package is based on the github Terraform Provider.