Docs
Packagesgithub.CodespacesSecret
Explore with Pulumi AI
Import
This resource can be imported using an ID made up of the repository and secret_name
$ pulumi import github:index/codespacesSecret:CodespacesSecret example_secret <repository>/<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 examplePublicKey = Github.GetCodespacesPublicKey.Invoke(new()
{
Repository = "example_repository",
});
var exampleSecretCodespacesSecret = new Github.CodespacesSecret("exampleSecretCodespacesSecret", new()
{
Repository = "example_repository",
SecretName = "example_secret_name",
PlaintextValue = @var.Some_secret_string,
});
var exampleSecretIndex_codespacesSecretCodespacesSecret = new Github.CodespacesSecret("exampleSecretIndex/codespacesSecretCodespacesSecret", new()
{
Repository = "example_repository",
SecretName = "example_secret_name",
EncryptedValue = @var.Some_encrypted_secret_string,
});
});
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 {
_, err := github.GetCodespacesPublicKey(ctx, &github.GetCodespacesPublicKeyArgs{
Repository: "example_repository",
}, nil)
if err != nil {
return err
}
_, err = github.NewCodespacesSecret(ctx, "exampleSecretCodespacesSecret", &github.CodespacesSecretArgs{
Repository: pulumi.String("example_repository"),
SecretName: pulumi.String("example_secret_name"),
PlaintextValue: pulumi.Any(_var.Some_secret_string),
})
if err != nil {
return err
}
_, err = github.NewCodespacesSecret(ctx, "exampleSecretIndex/codespacesSecretCodespacesSecret", &github.CodespacesSecretArgs{
Repository: pulumi.String("example_repository"),
SecretName: pulumi.String("example_secret_name"),
EncryptedValue: pulumi.Any(_var.Some_encrypted_secret_string),
})
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.GetCodespacesPublicKeyArgs;
import com.pulumi.github.CodespacesSecret;
import com.pulumi.github.CodespacesSecretArgs;
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 examplePublicKey = GithubFunctions.getCodespacesPublicKey(GetCodespacesPublicKeyArgs.builder()
.repository("example_repository")
.build());
var exampleSecretCodespacesSecret = new CodespacesSecret("exampleSecretCodespacesSecret", CodespacesSecretArgs.builder()
.repository("example_repository")
.secretName("example_secret_name")
.plaintextValue(var_.some_secret_string())
.build());
var exampleSecretIndex_codespacesSecretCodespacesSecret = new CodespacesSecret("exampleSecretIndex/codespacesSecretCodespacesSecret", CodespacesSecretArgs.builder()
.repository("example_repository")
.secretName("example_secret_name")
.encryptedValue(var_.some_encrypted_secret_string())
.build());
}
}
import pulumi
import pulumi_github as github
example_public_key = github.get_codespaces_public_key(repository="example_repository")
example_secret_codespaces_secret = github.CodespacesSecret("exampleSecretCodespacesSecret",
repository="example_repository",
secret_name="example_secret_name",
plaintext_value=var["some_secret_string"])
example_secret_index_codespaces_secret_codespaces_secret = github.CodespacesSecret("exampleSecretIndex/codespacesSecretCodespacesSecret",
repository="example_repository",
secret_name="example_secret_name",
encrypted_value=var["some_encrypted_secret_string"])
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const examplePublicKey = github.getCodespacesPublicKey({
repository: "example_repository",
});
const exampleSecretCodespacesSecret = new github.CodespacesSecret("exampleSecretCodespacesSecret", {
repository: "example_repository",
secretName: "example_secret_name",
plaintextValue: _var.some_secret_string,
});
const exampleSecretIndex_codespacesSecretCodespacesSecret = new github.CodespacesSecret("exampleSecretIndex/codespacesSecretCodespacesSecret", {
repository: "example_repository",
secretName: "example_secret_name",
encryptedValue: _var.some_encrypted_secret_string,
});
resources:
exampleSecretCodespacesSecret:
type: github:CodespacesSecret
properties:
repository: example_repository
secretName: example_secret_name
plaintextValue: ${var.some_secret_string}
exampleSecretIndex/codespacesSecretCodespacesSecret:
type: github:CodespacesSecret
properties:
repository: example_repository
secretName: example_secret_name
encryptedValue: ${var.some_encrypted_secret_string}
variables:
examplePublicKey:
fn::invoke:
Function: github:getCodespacesPublicKey
Arguments:
repository: example_repository
Create CodespacesSecret Resource
new CodespacesSecret(name: string, args: CodespacesSecretArgs, opts?: CustomResourceOptions);@overload
def CodespacesSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
encrypted_value: Optional[str] = None,
plaintext_value: Optional[str] = None,
repository: Optional[str] = None,
secret_name: Optional[str] = None)
@overload
def CodespacesSecret(resource_name: str,
args: CodespacesSecretArgs,
opts: Optional[ResourceOptions] = None)func NewCodespacesSecret(ctx *Context, name string, args CodespacesSecretArgs, opts ...ResourceOption) (*CodespacesSecret, error)public CodespacesSecret(string name, CodespacesSecretArgs args, CustomResourceOptions? opts = null)
public CodespacesSecret(String name, CodespacesSecretArgs args)
public CodespacesSecret(String name, CodespacesSecretArgs args, CustomResourceOptions options)
type: github:CodespacesSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodespacesSecretArgs
- 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 CodespacesSecretArgs
- 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 CodespacesSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodespacesSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CodespacesSecretArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CodespacesSecret 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 CodespacesSecret resource accepts the following input properties:
- Repository string
Name of the repository
- 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
- Repository string
Name of the repository
- 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
- repository String
Name of the repository
- 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
- repository string
Name of the repository
- 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
- repository str
Name of the repository
- 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
- repository String
Name of the repository
- 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
Outputs
All input properties are implicitly available as output properties. Additionally, the CodespacesSecret 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 CodespacesSecret Resource
Get an existing CodespacesSecret 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?: CodespacesSecretState, opts?: CustomResourceOptions): CodespacesSecret@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,
repository: Optional[str] = None,
secret_name: Optional[str] = None,
updated_at: Optional[str] = None) -> CodespacesSecretfunc GetCodespacesSecret(ctx *Context, name string, id IDInput, state *CodespacesSecretState, opts ...ResourceOption) (*CodespacesSecret, error)public static CodespacesSecret Get(string name, Input<string> id, CodespacesSecretState? state, CustomResourceOptions? opts = null)public static CodespacesSecret get(String name, Output<String> id, CodespacesSecretState 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
- Repository string
Name of the repository
- Secret
Name string Name of the 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
- Repository string
Name of the repository
- Secret
Name string Name of the 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
- repository String
Name of the repository
- secret
Name String Name of the 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
- repository string
Name of the repository
- secret
Name string Name of the 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
- repository str
Name of the repository
- secret_
name str Name of the 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
- repository String
Name of the repository
- secret
Name String Name of the 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
githubTerraform Provider.