GitHub v6.7.0, Feb 28 25

GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

github.CodespacesOrganizationSecret

Explore with Pulumi AI

GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

pulumi/pulumi-github

Example Usage

Create CodespacesOrganizationSecret Resource

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

Constructor syntax

new CodespacesOrganizationSecret(name: string, args: CodespacesOrganizationSecretArgs, opts?: CustomResourceOptions);

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

@overload
def CodespacesOrganizationSecret(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 secret_name: Optional[str] = None,
                                 visibility: Optional[str] = None,
                                 encrypted_value: Optional[str] = None,
                                 plaintext_value: Optional[str] = None,
                                 selected_repository_ids: Optional[Sequence[int]] = 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.

Parameters

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.

Constructor example

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

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

example, err := github.NewCodespacesOrganizationSecret(ctx, "codespacesOrganizationSecretResource", &github.CodespacesOrganizationSecretArgs{
	SecretName:     pulumi.String("string"),
	Visibility:     pulumi.String("string"),
	EncryptedValue: pulumi.String("string"),
	PlaintextValue: pulumi.String("string"),
	SelectedRepositoryIds: pulumi.IntArray{
		pulumi.Int(0),
	},
})

var codespacesOrganizationSecretResource = new CodespacesOrganizationSecret("codespacesOrganizationSecretResource", CodespacesOrganizationSecretArgs.builder()
    .secretName("string")
    .visibility("string")
    .encryptedValue("string")
    .plaintextValue("string")
    .selectedRepositoryIds(0)
    .build());

codespaces_organization_secret_resource = github.CodespacesOrganizationSecret("codespacesOrganizationSecretResource",
    secret_name="string",
    visibility="string",
    encrypted_value="string",
    plaintext_value="string",
    selected_repository_ids=[0])

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

type: github:CodespacesOrganizationSecret
properties:
    encryptedValue: string
    plaintextValue: string
    secretName: string
    selectedRepositoryIds:
        - 0
    visibility: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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)

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

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.

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

NOTE: the 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.

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.

GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

pulumi/pulumi-github

github.CodespacesOrganizationSecret

On this page

On this page

Example Usage

Create CodespacesOrganizationSecret Resource

Constructor syntax

Parameters

Constructor example

CodespacesOrganizationSecret Resource Properties

Inputs

Outputs

Look up Existing CodespacesOrganizationSecret Resource

Import

Package Details

On this page

On this page