github.CodespacesUserSecret
Explore with Pulumi AI
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
NOTEthe implementation is limited in that it won’t fetch the value of the plaintext_value
or encrypted_value
fields when importing. You may need to ignore changes for these as a workaround.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var repo = Github.GetRepository.Invoke(new()
{
FullName = "my-org/repo",
});
var exampleSecretCodespacesUserSecret = new Github.CodespacesUserSecret("exampleSecretCodespacesUserSecret", new()
{
SecretName = "example_secret_name",
PlaintextValue = @var.Some_secret_string,
SelectedRepositoryIds = new[]
{
repo.Apply(getRepositoryResult => getRepositoryResult.RepoId),
},
});
var exampleSecretIndex_codespacesUserSecretCodespacesUserSecret = new Github.CodespacesUserSecret("exampleSecretIndex/codespacesUserSecretCodespacesUserSecret", new()
{
SecretName = "example_secret_name",
EncryptedValue = @var.Some_encrypted_secret_string,
SelectedRepositoryIds = new[]
{
repo.Apply(getRepositoryResult => getRepositoryResult.RepoId),
},
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v5/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
repo, err := github.LookupRepository(ctx, &github.LookupRepositoryArgs{
FullName: pulumi.StringRef("my-org/repo"),
}, nil)
if err != nil {
return err
}
_, err = github.NewCodespacesUserSecret(ctx, "exampleSecretCodespacesUserSecret", &github.CodespacesUserSecretArgs{
SecretName: pulumi.String("example_secret_name"),
PlaintextValue: pulumi.Any(_var.Some_secret_string),
SelectedRepositoryIds: pulumi.IntArray{
*pulumi.Int(repo.RepoId),
},
})
if err != nil {
return err
}
_, err = github.NewCodespacesUserSecret(ctx, "exampleSecretIndex/codespacesUserSecretCodespacesUserSecret", &github.CodespacesUserSecretArgs{
SecretName: pulumi.String("example_secret_name"),
EncryptedValue: pulumi.Any(_var.Some_encrypted_secret_string),
SelectedRepositoryIds: pulumi.IntArray{
*pulumi.Int(repo.RepoId),
},
})
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.github.GithubFunctions;
import com.pulumi.github.inputs.GetRepositoryArgs;
import com.pulumi.github.CodespacesUserSecret;
import com.pulumi.github.CodespacesUserSecretArgs;
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) {
final var repo = GithubFunctions.getRepository(GetRepositoryArgs.builder()
.fullName("my-org/repo")
.build());
var exampleSecretCodespacesUserSecret = new CodespacesUserSecret("exampleSecretCodespacesUserSecret", CodespacesUserSecretArgs.builder()
.secretName("example_secret_name")
.plaintextValue(var_.some_secret_string())
.selectedRepositoryIds(repo.applyValue(getRepositoryResult -> getRepositoryResult.repoId()))
.build());
var exampleSecretIndex_codespacesUserSecretCodespacesUserSecret = new CodespacesUserSecret("exampleSecretIndex/codespacesUserSecretCodespacesUserSecret", CodespacesUserSecretArgs.builder()
.secretName("example_secret_name")
.encryptedValue(var_.some_encrypted_secret_string())
.selectedRepositoryIds(repo.applyValue(getRepositoryResult -> getRepositoryResult.repoId()))
.build());
}
}
import pulumi
import pulumi_github as github
repo = github.get_repository(full_name="my-org/repo")
example_secret_codespaces_user_secret = github.CodespacesUserSecret("exampleSecretCodespacesUserSecret",
secret_name="example_secret_name",
plaintext_value=var["some_secret_string"],
selected_repository_ids=[repo.repo_id])
example_secret_index_codespaces_user_secret_codespaces_user_secret = github.CodespacesUserSecret("exampleSecretIndex/codespacesUserSecretCodespacesUserSecret",
secret_name="example_secret_name",
encrypted_value=var["some_encrypted_secret_string"],
selected_repository_ids=[repo.repo_id])
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const repo = github.getRepository({
fullName: "my-org/repo",
});
const exampleSecretCodespacesUserSecret = new github.CodespacesUserSecret("exampleSecretCodespacesUserSecret", {
secretName: "example_secret_name",
plaintextValue: _var.some_secret_string,
selectedRepositoryIds: [repo.then(repo => repo.repoId)],
});
const exampleSecretIndex_codespacesUserSecretCodespacesUserSecret = new github.CodespacesUserSecret("exampleSecretIndex/codespacesUserSecretCodespacesUserSecret", {
secretName: "example_secret_name",
encryptedValue: _var.some_encrypted_secret_string,
selectedRepositoryIds: [repo.then(repo => repo.repoId)],
});
resources:
exampleSecretCodespacesUserSecret:
type: github:CodespacesUserSecret
properties:
secretName: example_secret_name
plaintextValue: ${var.some_secret_string}
selectedRepositoryIds:
- ${repo.repoId}
exampleSecretIndex/codespacesUserSecretCodespacesUserSecret:
type: github:CodespacesUserSecret
properties:
secretName: example_secret_name
encryptedValue: ${var.some_encrypted_secret_string}
selectedRepositoryIds:
- ${repo.repoId}
variables:
repo:
fn::invoke:
Function: github:getRepository
Arguments:
fullName: my-org/repo
Create CodespacesUserSecret Resource
new CodespacesUserSecret(name: string, args: CodespacesUserSecretArgs, opts?: CustomResourceOptions);
@overload
def CodespacesUserSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
encrypted_value: Optional[str] = None,
plaintext_value: Optional[str] = None,
secret_name: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None)
@overload
def CodespacesUserSecret(resource_name: str,
args: CodespacesUserSecretArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args CodespacesUserSecretArgs
- 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 CodespacesUserSecretArgs
- 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 CodespacesUserSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodespacesUserSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CodespacesUserSecretArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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:
- Secret
Name string Name of the secret
- Encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string Plaintext value of the secret to be encrypted
- Selected
Repository List<int>Ids An array of repository ids that can access the user secret.
- Secret
Name string Name of the secret
- Encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string Plaintext value of the secret to be encrypted
- Selected
Repository []intIds An array of repository ids that can access the user secret.
- secret
Name String Name of the secret
- encrypted
Value String Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String Plaintext value of the secret to be encrypted
- selected
Repository List<Integer>Ids An array of repository ids that can access the user secret.
- secret
Name string Name of the secret
- encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value string Plaintext value of the secret to be encrypted
- selected
Repository number[]Ids An array of repository ids that can access the user secret.
- secret_
name str Name of the secret
- encrypted_
value str Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext_
value str Plaintext value of the secret to be encrypted
- selected_
repository_ Sequence[int]ids An array of repository ids that can access the user secret.
- secret
Name String Name of the secret
- encrypted
Value String Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String Plaintext value of the secret to be encrypted
- selected
Repository List<Number>Ids An array of repository ids that can access the user secret.
Outputs
All input properties are implicitly available as output properties. Additionally, the CodespacesUserSecret resource produces the following output properties:
- created_
at str Date of codespaces_secret creation.
- id str
The provider-assigned unique ID for this managed resource.
- updated_
at str Date of codespaces_secret update.
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)
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.
- Created
At string Date of codespaces_secret creation.
- Encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string Plaintext value of the secret to be encrypted
- Secret
Name string Name of the secret
- Selected
Repository List<int>Ids An array of repository ids that can access the user secret.
- Updated
At string Date of codespaces_secret update.
- Created
At string Date of codespaces_secret creation.
- Encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- Plaintext
Value string Plaintext value of the secret to be encrypted
- Secret
Name string Name of the secret
- Selected
Repository []intIds An array of repository ids that can access the user secret.
- Updated
At string Date of codespaces_secret update.
- created
At String Date of codespaces_secret creation.
- encrypted
Value String Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String Plaintext value of the secret to be encrypted
- secret
Name String Name of the secret
- selected
Repository List<Integer>Ids An array of repository ids that can access the user secret.
- updated
At String Date of codespaces_secret update.
- created
At string Date of codespaces_secret creation.
- encrypted
Value string Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value string Plaintext value of the secret to be encrypted
- secret
Name string Name of the secret
- selected
Repository number[]Ids An array of repository ids that can access the user secret.
- updated
At string Date of codespaces_secret update.
- created_
at str Date of codespaces_secret creation.
- encrypted_
value str Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext_
value str Plaintext value of the secret to be encrypted
- secret_
name str Name of the secret
- selected_
repository_ Sequence[int]ids An array of repository ids that can access the user secret.
- updated_
at str Date of codespaces_secret update.
- created
At String Date of codespaces_secret creation.
- encrypted
Value String Encrypted value of the secret using the GitHub public key in Base64 format.
- plaintext
Value String Plaintext value of the secret to be encrypted
- secret
Name String Name of the secret
- selected
Repository List<Number>Ids An array of repository ids that can access the user secret.
- updated
At String Date of codespaces_secret update.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
github
Terraform Provider.