This resource allows you to manage the repositories allowed to access a Dependabot secret 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 example = new github.DependabotOrganizationSecret("example", {
secretName: "mysecret",
plaintextValue: "foo",
visibility: "selected",
});
const exampleRepository = new github.Repository("example", {
name: "myrepo",
visibility: "public",
});
const exampleDependabotOrganizationSecretRepositories = new github.DependabotOrganizationSecretRepositories("example", {
secretName: example.name,
selectedRepositoryIds: [exampleRepository.repoId],
});
import pulumi
import pulumi_github as github
example = github.DependabotOrganizationSecret("example",
secret_name="mysecret",
plaintext_value="foo",
visibility="selected")
example_repository = github.Repository("example",
name="myrepo",
visibility="public")
example_dependabot_organization_secret_repositories = github.DependabotOrganizationSecretRepositories("example",
secret_name=example.name,
selected_repository_ids=[example_repository.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 {
example, err := github.NewDependabotOrganizationSecret(ctx, "example", &github.DependabotOrganizationSecretArgs{
SecretName: pulumi.String("mysecret"),
PlaintextValue: pulumi.String("foo"),
Visibility: pulumi.String("selected"),
})
if err != nil {
return err
}
exampleRepository, err := github.NewRepository(ctx, "example", &github.RepositoryArgs{
Name: pulumi.String("myrepo"),
Visibility: pulumi.String("public"),
})
if err != nil {
return err
}
_, err = github.NewDependabotOrganizationSecretRepositories(ctx, "example", &github.DependabotOrganizationSecretRepositoriesArgs{
SecretName: example.Name,
SelectedRepositoryIds: pulumi.IntArray{
exampleRepository.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 example = new Github.DependabotOrganizationSecret("example", new()
{
SecretName = "mysecret",
PlaintextValue = "foo",
Visibility = "selected",
});
var exampleRepository = new Github.Repository("example", new()
{
Name = "myrepo",
Visibility = "public",
});
var exampleDependabotOrganizationSecretRepositories = new Github.DependabotOrganizationSecretRepositories("example", new()
{
SecretName = example.Name,
SelectedRepositoryIds = new[]
{
exampleRepository.RepoId,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.DependabotOrganizationSecret;
import com.pulumi.github.DependabotOrganizationSecretArgs;
import com.pulumi.github.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.DependabotOrganizationSecretRepositories;
import com.pulumi.github.DependabotOrganizationSecretRepositoriesArgs;
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 example = new DependabotOrganizationSecret("example", DependabotOrganizationSecretArgs.builder()
.secretName("mysecret")
.plaintextValue("foo")
.visibility("selected")
.build());
var exampleRepository = new Repository("exampleRepository", RepositoryArgs.builder()
.name("myrepo")
.visibility("public")
.build());
var exampleDependabotOrganizationSecretRepositories = new DependabotOrganizationSecretRepositories("exampleDependabotOrganizationSecretRepositories", DependabotOrganizationSecretRepositoriesArgs.builder()
.secretName(example.name())
.selectedRepositoryIds(exampleRepository.repoId())
.build());
}
}
resources:
example:
type: github:DependabotOrganizationSecret
properties:
secretName: mysecret
plaintextValue: foo
visibility: selected
exampleRepository:
type: github:Repository
name: example
properties:
name: myrepo
visibility: public
exampleDependabotOrganizationSecretRepositories:
type: github:DependabotOrganizationSecretRepositories
name: example
properties:
secretName: ${example.name}
selectedRepositoryIds:
- ${exampleRepository.repoId}
Create DependabotOrganizationSecretRepositories Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DependabotOrganizationSecretRepositories(name: string, args: DependabotOrganizationSecretRepositoriesArgs, opts?: CustomResourceOptions);@overload
def DependabotOrganizationSecretRepositories(resource_name: str,
args: DependabotOrganizationSecretRepositoriesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DependabotOrganizationSecretRepositories(resource_name: str,
opts: Optional[ResourceOptions] = None,
secret_name: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None)func NewDependabotOrganizationSecretRepositories(ctx *Context, name string, args DependabotOrganizationSecretRepositoriesArgs, opts ...ResourceOption) (*DependabotOrganizationSecretRepositories, error)public DependabotOrganizationSecretRepositories(string name, DependabotOrganizationSecretRepositoriesArgs args, CustomResourceOptions? opts = null)
public DependabotOrganizationSecretRepositories(String name, DependabotOrganizationSecretRepositoriesArgs args)
public DependabotOrganizationSecretRepositories(String name, DependabotOrganizationSecretRepositoriesArgs args, CustomResourceOptions options)
type: github:DependabotOrganizationSecretRepositories
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 DependabotOrganizationSecretRepositoriesArgs
- 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 DependabotOrganizationSecretRepositoriesArgs
- 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 DependabotOrganizationSecretRepositoriesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DependabotOrganizationSecretRepositoriesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DependabotOrganizationSecretRepositoriesArgs
- 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 dependabotOrganizationSecretRepositoriesResource = new Github.DependabotOrganizationSecretRepositories("dependabotOrganizationSecretRepositoriesResource", new()
{
SecretName = "string",
SelectedRepositoryIds = new[]
{
0,
},
});
example, err := github.NewDependabotOrganizationSecretRepositories(ctx, "dependabotOrganizationSecretRepositoriesResource", &github.DependabotOrganizationSecretRepositoriesArgs{
SecretName: pulumi.String("string"),
SelectedRepositoryIds: pulumi.IntArray{
pulumi.Int(0),
},
})
var dependabotOrganizationSecretRepositoriesResource = new DependabotOrganizationSecretRepositories("dependabotOrganizationSecretRepositoriesResource", DependabotOrganizationSecretRepositoriesArgs.builder()
.secretName("string")
.selectedRepositoryIds(0)
.build());
dependabot_organization_secret_repositories_resource = github.DependabotOrganizationSecretRepositories("dependabotOrganizationSecretRepositoriesResource",
secret_name="string",
selected_repository_ids=[0])
const dependabotOrganizationSecretRepositoriesResource = new github.DependabotOrganizationSecretRepositories("dependabotOrganizationSecretRepositoriesResource", {
secretName: "string",
selectedRepositoryIds: [0],
});
type: github:DependabotOrganizationSecretRepositories
properties:
secretName: string
selectedRepositoryIds:
- 0
DependabotOrganizationSecretRepositories 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 DependabotOrganizationSecretRepositories resource accepts the following input properties:
- Secret
Name string - Name of the Dependabot organization secret.
- Selected
Repository List<int>Ids - List of IDs for the repositories that should be able to access the secret.
- Secret
Name string - Name of the Dependabot organization secret.
- Selected
Repository []intIds - List of IDs for the repositories that should be able to access the secret.
- secret
Name String - Name of the Dependabot organization secret.
- selected
Repository List<Integer>Ids - List of IDs for the repositories that should be able to access the secret.
- secret
Name string - Name of the Dependabot organization secret.
- selected
Repository number[]Ids - List of IDs for the repositories that should be able to access the secret.
- secret_
name str - Name of the Dependabot organization secret.
- selected_
repository_ Sequence[int]ids - List of IDs for the repositories that should be able to access the secret.
- secret
Name String - Name of the Dependabot organization secret.
- selected
Repository List<Number>Ids - List of IDs for the repositories that should be able to access the secret.
Outputs
All input properties are implicitly available as output properties. Additionally, the DependabotOrganizationSecretRepositories 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 DependabotOrganizationSecretRepositories Resource
Get an existing DependabotOrganizationSecretRepositories 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?: DependabotOrganizationSecretRepositoriesState, opts?: CustomResourceOptions): DependabotOrganizationSecretRepositories@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
secret_name: Optional[str] = None,
selected_repository_ids: Optional[Sequence[int]] = None) -> DependabotOrganizationSecretRepositoriesfunc GetDependabotOrganizationSecretRepositories(ctx *Context, name string, id IDInput, state *DependabotOrganizationSecretRepositoriesState, opts ...ResourceOption) (*DependabotOrganizationSecretRepositories, error)public static DependabotOrganizationSecretRepositories Get(string name, Input<string> id, DependabotOrganizationSecretRepositoriesState? state, CustomResourceOptions? opts = null)public static DependabotOrganizationSecretRepositories get(String name, Output<String> id, DependabotOrganizationSecretRepositoriesState state, CustomResourceOptions options)resources: _: type: github:DependabotOrganizationSecretRepositories 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.
- Secret
Name string - Name of the Dependabot organization secret.
- Selected
Repository List<int>Ids - List of IDs for the repositories that should be able to access the secret.
- Secret
Name string - Name of the Dependabot organization secret.
- Selected
Repository []intIds - List of IDs for the repositories that should be able to access the secret.
- secret
Name String - Name of the Dependabot organization secret.
- selected
Repository List<Integer>Ids - List of IDs for the repositories that should be able to access the secret.
- secret
Name string - Name of the Dependabot organization secret.
- selected
Repository number[]Ids - List of IDs for the repositories that should be able to access the secret.
- secret_
name str - Name of the Dependabot organization secret.
- selected_
repository_ Sequence[int]ids - List of IDs for the repositories that should be able to access the secret.
- secret
Name String - Name of the Dependabot organization secret.
- selected
Repository List<Number>Ids - List of IDs for the repositories that should be able to access the secret.
Import
Import Command
The following command imports the repositories able to access the Dependabot organization secret named mysecret to a github_dependabot_organization_secret_repositories resource named example.
$ pulumi import github:index/dependabotOrganizationSecretRepositories:DependabotOrganizationSecretRepositories example mysecret
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
githubTerraform Provider.
