1. Packages
  2. GitHub
  3. API Docs
  4. CodespacesOrganizationSecretRepositories
GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi

github.CodespacesOrganizationSecretRepositories

Explore with Pulumi AI

github logo
GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi

    This resource allows you to manage repository allow list for existing GitHub Codespaces secrets within your GitHub organization.

    You must have write access to an organization secret to use this resource.

    This resource is only applicable when visibility of the existing organization secret has been set to selected.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const repo = github.getRepository({
        fullName: "my-org/repo",
    });
    const orgSecretRepos = new github.CodespacesOrganizationSecretRepositories("org_secret_repos", {
        secretName: "existing_secret_name",
        selectedRepositoryIds: [repo.then(repo => repo.repoId)],
    });
    
    import pulumi
    import pulumi_github as github
    
    repo = github.get_repository(full_name="my-org/repo")
    org_secret_repos = github.CodespacesOrganizationSecretRepositories("org_secret_repos",
        secret_name="existing_secret_name",
        selected_repository_ids=[repo.repo_id])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/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.NewCodespacesOrganizationSecretRepositories(ctx, "org_secret_repos", &github.CodespacesOrganizationSecretRepositoriesArgs{
    			SecretName: pulumi.String("existing_secret_name"),
    			SelectedRepositoryIds: pulumi.IntArray{
    				pulumi.Int(repo.RepoId),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 orgSecretRepos = new Github.CodespacesOrganizationSecretRepositories("org_secret_repos", new()
        {
            SecretName = "existing_secret_name",
            SelectedRepositoryIds = new[]
            {
                repo.Apply(getRepositoryResult => getRepositoryResult.RepoId),
            },
        });
    
    });
    
    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.CodespacesOrganizationSecretRepositories;
    import com.pulumi.github.CodespacesOrganizationSecretRepositoriesArgs;
    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 orgSecretRepos = new CodespacesOrganizationSecretRepositories("orgSecretRepos", CodespacesOrganizationSecretRepositoriesArgs.builder()
                .secretName("existing_secret_name")
                .selectedRepositoryIds(repo.applyValue(getRepositoryResult -> getRepositoryResult.repoId()))
                .build());
    
        }
    }
    
    resources:
      orgSecretRepos:
        type: github:CodespacesOrganizationSecretRepositories
        name: org_secret_repos
        properties:
          secretName: existing_secret_name
          selectedRepositoryIds:
            - ${repo.repoId}
    variables:
      repo:
        fn::invoke:
          Function: github:getRepository
          Arguments:
            fullName: my-org/repo
    

    Create CodespacesOrganizationSecretRepositories Resource

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

    Constructor syntax

    new CodespacesOrganizationSecretRepositories(name: string, args: CodespacesOrganizationSecretRepositoriesArgs, opts?: CustomResourceOptions);
    @overload
    def CodespacesOrganizationSecretRepositories(resource_name: str,
                                                 args: CodespacesOrganizationSecretRepositoriesArgs,
                                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CodespacesOrganizationSecretRepositories(resource_name: str,
                                                 opts: Optional[ResourceOptions] = None,
                                                 secret_name: Optional[str] = None,
                                                 selected_repository_ids: Optional[Sequence[int]] = None)
    func NewCodespacesOrganizationSecretRepositories(ctx *Context, name string, args CodespacesOrganizationSecretRepositoriesArgs, opts ...ResourceOption) (*CodespacesOrganizationSecretRepositories, error)
    public CodespacesOrganizationSecretRepositories(string name, CodespacesOrganizationSecretRepositoriesArgs args, CustomResourceOptions? opts = null)
    public CodespacesOrganizationSecretRepositories(String name, CodespacesOrganizationSecretRepositoriesArgs args)
    public CodespacesOrganizationSecretRepositories(String name, CodespacesOrganizationSecretRepositoriesArgs args, CustomResourceOptions options)
    
    type: github:CodespacesOrganizationSecretRepositories
    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 CodespacesOrganizationSecretRepositoriesArgs
    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 CodespacesOrganizationSecretRepositoriesArgs
    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 CodespacesOrganizationSecretRepositoriesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CodespacesOrganizationSecretRepositoriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CodespacesOrganizationSecretRepositoriesArgs
    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 codespacesOrganizationSecretRepositoriesResource = new Github.CodespacesOrganizationSecretRepositories("codespacesOrganizationSecretRepositoriesResource", new()
    {
        SecretName = "string",
        SelectedRepositoryIds = new[]
        {
            0,
        },
    });
    
    example, err := github.NewCodespacesOrganizationSecretRepositories(ctx, "codespacesOrganizationSecretRepositoriesResource", &github.CodespacesOrganizationSecretRepositoriesArgs{
    	SecretName: pulumi.String("string"),
    	SelectedRepositoryIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    })
    
    var codespacesOrganizationSecretRepositoriesResource = new CodespacesOrganizationSecretRepositories("codespacesOrganizationSecretRepositoriesResource", CodespacesOrganizationSecretRepositoriesArgs.builder()
        .secretName("string")
        .selectedRepositoryIds(0)
        .build());
    
    codespaces_organization_secret_repositories_resource = github.CodespacesOrganizationSecretRepositories("codespacesOrganizationSecretRepositoriesResource",
        secret_name="string",
        selected_repository_ids=[0])
    
    const codespacesOrganizationSecretRepositoriesResource = new github.CodespacesOrganizationSecretRepositories("codespacesOrganizationSecretRepositoriesResource", {
        secretName: "string",
        selectedRepositoryIds: [0],
    });
    
    type: github:CodespacesOrganizationSecretRepositories
    properties:
        secretName: string
        selectedRepositoryIds:
            - 0
    

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

    SecretName string
    Name of the existing secret
    SelectedRepositoryIds List<int>
    An array of repository ids that can access the organization secret.
    SecretName string
    Name of the existing secret
    SelectedRepositoryIds []int
    An array of repository ids that can access the organization secret.
    secretName String
    Name of the existing secret
    selectedRepositoryIds List<Integer>
    An array of repository ids that can access the organization secret.
    secretName string
    Name of the existing secret
    selectedRepositoryIds number[]
    An array of repository ids that can access the organization secret.
    secret_name str
    Name of the existing secret
    selected_repository_ids Sequence[int]
    An array of repository ids that can access the organization secret.
    secretName String
    Name of the existing secret
    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 CodespacesOrganizationSecretRepositories resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CodespacesOrganizationSecretRepositories Resource

    Get an existing CodespacesOrganizationSecretRepositories 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?: CodespacesOrganizationSecretRepositoriesState, opts?: CustomResourceOptions): CodespacesOrganizationSecretRepositories
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            secret_name: Optional[str] = None,
            selected_repository_ids: Optional[Sequence[int]] = None) -> CodespacesOrganizationSecretRepositories
    func GetCodespacesOrganizationSecretRepositories(ctx *Context, name string, id IDInput, state *CodespacesOrganizationSecretRepositoriesState, opts ...ResourceOption) (*CodespacesOrganizationSecretRepositories, error)
    public static CodespacesOrganizationSecretRepositories Get(string name, Input<string> id, CodespacesOrganizationSecretRepositoriesState? state, CustomResourceOptions? opts = null)
    public static CodespacesOrganizationSecretRepositories get(String name, Output<String> id, CodespacesOrganizationSecretRepositoriesState 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:
    SecretName string
    Name of the existing secret
    SelectedRepositoryIds List<int>
    An array of repository ids that can access the organization secret.
    SecretName string
    Name of the existing secret
    SelectedRepositoryIds []int
    An array of repository ids that can access the organization secret.
    secretName String
    Name of the existing secret
    selectedRepositoryIds List<Integer>
    An array of repository ids that can access the organization secret.
    secretName string
    Name of the existing secret
    selectedRepositoryIds number[]
    An array of repository ids that can access the organization secret.
    secret_name str
    Name of the existing secret
    selected_repository_ids Sequence[int]
    An array of repository ids that can access the organization secret.
    secretName String
    Name of the existing secret
    selectedRepositoryIds List<Number>
    An array of repository ids that can access the organization secret.

    Import

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

    $ pulumi import github:index/codespacesOrganizationSecretRepositories:CodespacesOrganizationSecretRepositories org_secret_repos existing_secret_name
    

    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 logo
    GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi