Docs Packages
  1. Packages
  2. GitHub
  3. API Docs
  4. CodespacesOrganizationSecret
GitHub v5.19.0 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-github

github.CodespacesOrganizationSecret

Explore with Pulumi AI

github logo
GitHub v5.19.0 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-github

    Import

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

     $ pulumi import github:index/codespacesOrganizationSecret:CodespacesOrganizationSecret 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 exampleSecretCodespacesOrganizationSecret = new Github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", new()
    {
        SecretName = "example_secret_name",
        Visibility = "private",
        PlaintextValue = @var.Some_secret_string,
    });

    var exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new Github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", new()
    {
        SecretName = "example_secret_name",
        Visibility = "private",
        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.NewCodespacesOrganizationSecret(ctx, "exampleSecretCodespacesOrganizationSecret", &github.CodespacesOrganizationSecretArgs{
			SecretName:     pulumi.String("example_secret_name"),
			Visibility:     pulumi.String("private"),
			PlaintextValue: pulumi.Any(_var.Some_secret_string),
		})
		if err != nil {
			return err
		}
		_, err = github.NewCodespacesOrganizationSecret(ctx, "exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", &github.CodespacesOrganizationSecretArgs{
			SecretName:     pulumi.String("example_secret_name"),
			Visibility:     pulumi.String("private"),
			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.CodespacesOrganizationSecret;
import com.pulumi.github.CodespacesOrganizationSecretArgs;
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) {
        var exampleSecretCodespacesOrganizationSecret = new CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", CodespacesOrganizationSecretArgs.builder()        
            .secretName("example_secret_name")
            .visibility("private")
            .plaintextValue(var_.some_secret_string())
            .build());

        var exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", CodespacesOrganizationSecretArgs.builder()        
            .secretName("example_secret_name")
            .visibility("private")
            .encryptedValue(var_.some_encrypted_secret_string())
            .build());

    }
}

    import pulumi
import pulumi_github as github

example_secret_codespaces_organization_secret = github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret",
    secret_name="example_secret_name",
    visibility="private",
    plaintext_value=var["some_secret_string"])
example_secret_index_codespaces_organization_secret_codespaces_organization_secret = github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret",
    secret_name="example_secret_name",
    visibility="private",
    encrypted_value=var["some_encrypted_secret_string"])

    import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const exampleSecretCodespacesOrganizationSecret = new github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", {
    secretName: "example_secret_name",
    visibility: "private",
    plaintextValue: _var.some_secret_string,
});
const exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", {
    secretName: "example_secret_name",
    visibility: "private",
    encryptedValue: _var.some_encrypted_secret_string,
});

    resources:
  exampleSecretCodespacesOrganizationSecret:
    type: github:CodespacesOrganizationSecret
    properties:
      secretName: example_secret_name
      visibility: private
      plaintextValue: ${var.some_secret_string}
  exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret:
    type: github:CodespacesOrganizationSecret
    properties:
      secretName: example_secret_name
      visibility: private
      encryptedValue: ${var.some_encrypted_secret_string}

    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 exampleSecretCodespacesOrganizationSecret = new Github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", new()
    {
        SecretName = "example_secret_name",
        Visibility = "selected",
        PlaintextValue = @var.Some_secret_string,
        SelectedRepositoryIds = new[]
        {
            repo.Apply(getRepositoryResult => getRepositoryResult.RepoId),
        },
    });

    var exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new Github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", new()
    {
        SecretName = "example_secret_name",
        Visibility = "selected",
        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.NewCodespacesOrganizationSecret(ctx, "exampleSecretCodespacesOrganizationSecret", &github.CodespacesOrganizationSecretArgs{
			SecretName:     pulumi.String("example_secret_name"),
			Visibility:     pulumi.String("selected"),
			PlaintextValue: pulumi.Any(_var.Some_secret_string),
			SelectedRepositoryIds: pulumi.IntArray{
				*pulumi.Int(repo.RepoId),
			},
		})
		if err != nil {
			return err
		}
		_, err = github.NewCodespacesOrganizationSecret(ctx, "exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", &github.CodespacesOrganizationSecretArgs{
			SecretName:     pulumi.String("example_secret_name"),
			Visibility:     pulumi.String("selected"),
			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.CodespacesOrganizationSecret;
import com.pulumi.github.CodespacesOrganizationSecretArgs;
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 exampleSecretCodespacesOrganizationSecret = new CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", CodespacesOrganizationSecretArgs.builder()        
            .secretName("example_secret_name")
            .visibility("selected")
            .plaintextValue(var_.some_secret_string())
            .selectedRepositoryIds(repo.applyValue(getRepositoryResult -> getRepositoryResult.repoId()))
            .build());

        var exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", CodespacesOrganizationSecretArgs.builder()        
            .secretName("example_secret_name")
            .visibility("selected")
            .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_organization_secret = github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret",
    secret_name="example_secret_name",
    visibility="selected",
    plaintext_value=var["some_secret_string"],
    selected_repository_ids=[repo.repo_id])
example_secret_index_codespaces_organization_secret_codespaces_organization_secret = github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret",
    secret_name="example_secret_name",
    visibility="selected",
    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 exampleSecretCodespacesOrganizationSecret = new github.CodespacesOrganizationSecret("exampleSecretCodespacesOrganizationSecret", {
    secretName: "example_secret_name",
    visibility: "selected",
    plaintextValue: _var.some_secret_string,
    selectedRepositoryIds: [repo.then(repo => repo.repoId)],
});
const exampleSecretIndex_codespacesOrganizationSecretCodespacesOrganizationSecret = new github.CodespacesOrganizationSecret("exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret", {
    secretName: "example_secret_name",
    visibility: "selected",
    encryptedValue: _var.some_encrypted_secret_string,
    selectedRepositoryIds: [repo.then(repo => repo.repoId)],
});

    resources:
  exampleSecretCodespacesOrganizationSecret:
    type: github:CodespacesOrganizationSecret
    properties:
      secretName: example_secret_name
      visibility: selected
      plaintextValue: ${var.some_secret_string}
      selectedRepositoryIds:
        - ${repo.repoId}
  exampleSecretIndex/codespacesOrganizationSecretCodespacesOrganizationSecret:
    type: github:CodespacesOrganizationSecret
    properties:
      secretName: example_secret_name
      visibility: selected
      encryptedValue: ${var.some_encrypted_secret_string}
      selectedRepositoryIds:
        - ${repo.repoId}
variables:
  repo:
    fn::invoke:
      Function: github:getRepository
      Arguments:
        fullName: my-org/repo

    Create CodespacesOrganizationSecret Resource

    new CodespacesOrganizationSecret(name: string, args: CodespacesOrganizationSecretArgs, opts?: CustomResourceOptions);
    @overload
def CodespacesOrganizationSecret(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,
                                 visibility: Optional[str] = None)
@overload
def CodespacesOrganizationSecret(resource_name: str,
                                 args: CodespacesOrganizationSecretArgs,
                                 opts: Optional[ResourceOptions] = None)
    func NewCodespacesOrganizationSecret(ctx *Context, name string, args CodespacesOrganizationSecretArgs, opts ...ResourceOption) (*CodespacesOrganizationSecret, error)
    public CodespacesOrganizationSecret(string name, CodespacesOrganizationSecretArgs args, CustomResourceOptions? opts = null)
    public CodespacesOrganizationSecret(String name, CodespacesOrganizationSecretArgs args)
public CodespacesOrganizationSecret(String name, CodespacesOrganizationSecretArgs args, CustomResourceOptions options)

    type: github:CodespacesOrganizationSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CodespacesOrganizationSecretArgs
    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 CodespacesOrganizationSecretArgs
    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 CodespacesOrganizationSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CodespacesOrganizationSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CodespacesOrganizationSecretArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    SecretName string

    Name of the secret

    Visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    EncryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    PlaintextValue string

    Plaintext value of the secret to be encrypted

    SelectedRepositoryIds List<int>

    An array of repository ids that can access the organization secret.

    SecretName string

    Name of the secret

    Visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    EncryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    PlaintextValue string

    Plaintext value of the secret to be encrypted

    SelectedRepositoryIds []int

    An array of repository ids that can access the organization secret.

    secretName String

    Name of the secret

    visibility String

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    encryptedValue String

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue String

    Plaintext value of the secret to be encrypted

    selectedRepositoryIds List<Integer>

    An array of repository ids that can access the organization secret.

    secretName string

    Name of the secret

    visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    encryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue string

    Plaintext value of the secret to be encrypted

    selectedRepositoryIds number[]

    An array of repository ids that can access the organization secret.

    secret_name str

    Name of the secret

    visibility str

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    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_ids Sequence[int]

    An array of repository ids that can access the organization secret.

    secretName String

    Name of the secret

    visibility String

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    encryptedValue String

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue String

    Plaintext value of the secret to be encrypted

    selectedRepositoryIds List<Number>

    An array of repository ids that can access the organization secret.

    Outputs

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

    CreatedAt string

    Date of codespaces_secret creation.

    Id string

    The provider-assigned unique ID for this managed resource.

    UpdatedAt string

    Date of codespaces_secret update.

    CreatedAt string

    Date of codespaces_secret creation.

    Id string

    The provider-assigned unique ID for this managed resource.

    UpdatedAt string

    Date of codespaces_secret update.

    createdAt String

    Date of codespaces_secret creation.

    id String

    The provider-assigned unique ID for this managed resource.

    updatedAt String

    Date of codespaces_secret update.

    createdAt string

    Date of codespaces_secret creation.

    id string

    The provider-assigned unique ID for this managed resource.

    updatedAt string

    Date of codespaces_secret update.

    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.

    createdAt String

    Date of codespaces_secret creation.

    id String

    The provider-assigned unique ID for this managed resource.

    updatedAt String

    Date of codespaces_secret update.

    Look up Existing CodespacesOrganizationSecret Resource

    Get an existing CodespacesOrganizationSecret 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?: CodespacesOrganizationSecretState, opts?: CustomResourceOptions): CodespacesOrganizationSecret
    @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,
        visibility: Optional[str] = None) -> CodespacesOrganizationSecret
    func GetCodespacesOrganizationSecret(ctx *Context, name string, id IDInput, state *CodespacesOrganizationSecretState, opts ...ResourceOption) (*CodespacesOrganizationSecret, error)
    public static CodespacesOrganizationSecret Get(string name, Input<string> id, CodespacesOrganizationSecretState? state, CustomResourceOptions? opts = null)
    public static CodespacesOrganizationSecret get(String name, Output<String> id, CodespacesOrganizationSecretState 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.
    The following state arguments are supported:
    CreatedAt string

    Date of codespaces_secret creation.

    EncryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    PlaintextValue string

    Plaintext value of the secret to be encrypted

    SecretName string

    Name of the secret

    SelectedRepositoryIds List<int>

    An array of repository ids that can access the organization secret.

    UpdatedAt string

    Date of codespaces_secret update.

    Visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    CreatedAt string

    Date of codespaces_secret creation.

    EncryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    PlaintextValue string

    Plaintext value of the secret to be encrypted

    SecretName string

    Name of the secret

    SelectedRepositoryIds []int

    An array of repository ids that can access the organization secret.

    UpdatedAt string

    Date of codespaces_secret update.

    Visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    createdAt String

    Date of codespaces_secret creation.

    encryptedValue String

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue String

    Plaintext value of the secret to be encrypted

    secretName String

    Name of the secret

    selectedRepositoryIds List<Integer>

    An array of repository ids that can access the organization secret.

    updatedAt String

    Date of codespaces_secret update.

    visibility String

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    createdAt string

    Date of codespaces_secret creation.

    encryptedValue string

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue string

    Plaintext value of the secret to be encrypted

    secretName string

    Name of the secret

    selectedRepositoryIds number[]

    An array of repository ids that can access the organization secret.

    updatedAt string

    Date of codespaces_secret update.

    visibility string

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    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_ids Sequence[int]

    An array of repository ids that can access the organization secret.

    updated_at str

    Date of codespaces_secret update.

    visibility str

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    createdAt String

    Date of codespaces_secret creation.

    encryptedValue String

    Encrypted value of the secret using the GitHub public key in Base64 format.

    plaintextValue String

    Plaintext value of the secret to be encrypted

    secretName String

    Name of the secret

    selectedRepositoryIds List<Number>

    An array of repository ids that can access the organization secret.

    updatedAt String

    Date of codespaces_secret update.

    visibility String

    Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the github Terraform Provider.

    github logo
    GitHub v5.19.0 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-github