This resource adds permission for a repository to use an actions variables within your GitHub organization. You must have write access to an organization variable to use this resource.
This resource is only applicable when visibility of the existing organization variable has been set to selected.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.ActionsOrganizationVariable("example", {
variableName: "myvariable",
plaintextValue: "foo",
visibility: "selected",
});
const exampleRepository = new github.Repository("example", {
name: "myrepo",
visibility: "public",
});
const exampleActionsOrganizationVariableRepository = new github.ActionsOrganizationVariableRepository("example", {
variableName: example.name,
repositoryId: exampleRepository.repoId,
});
import pulumi
import pulumi_github as github
example = github.ActionsOrganizationVariable("example",
variable_name="myvariable",
plaintext_value="foo",
visibility="selected")
example_repository = github.Repository("example",
name="myrepo",
visibility="public")
example_actions_organization_variable_repository = github.ActionsOrganizationVariableRepository("example",
variable_name=example.name,
repository_id=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.NewActionsOrganizationVariable(ctx, "example", &github.ActionsOrganizationVariableArgs{
VariableName: pulumi.String("myvariable"),
PlaintextValue: "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.NewActionsOrganizationVariableRepository(ctx, "example", &github.ActionsOrganizationVariableRepositoryArgs{
VariableName: example.Name,
RepositoryId: 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.ActionsOrganizationVariable("example", new()
{
VariableName = "myvariable",
PlaintextValue = "foo",
Visibility = "selected",
});
var exampleRepository = new Github.Repository("example", new()
{
Name = "myrepo",
Visibility = "public",
});
var exampleActionsOrganizationVariableRepository = new Github.ActionsOrganizationVariableRepository("example", new()
{
VariableName = example.Name,
RepositoryId = exampleRepository.RepoId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.ActionsOrganizationVariable;
import com.pulumi.github.ActionsOrganizationVariableArgs;
import com.pulumi.github.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.ActionsOrganizationVariableRepository;
import com.pulumi.github.ActionsOrganizationVariableRepositoryArgs;
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 ActionsOrganizationVariable("example", ActionsOrganizationVariableArgs.builder()
.variableName("myvariable")
.plaintextValue("foo")
.visibility("selected")
.build());
var exampleRepository = new Repository("exampleRepository", RepositoryArgs.builder()
.name("myrepo")
.visibility("public")
.build());
var exampleActionsOrganizationVariableRepository = new ActionsOrganizationVariableRepository("exampleActionsOrganizationVariableRepository", ActionsOrganizationVariableRepositoryArgs.builder()
.variableName(example.name())
.repositoryId(exampleRepository.repoId())
.build());
}
}
resources:
example:
type: github:ActionsOrganizationVariable
properties:
variableName: myvariable
plaintextValue: foo
visibility: selected
exampleRepository:
type: github:Repository
name: example
properties:
name: myrepo
visibility: public
exampleActionsOrganizationVariableRepository:
type: github:ActionsOrganizationVariableRepository
name: example
properties:
variableName: ${example.name}
repositoryId: ${exampleRepository.repoId}
Create ActionsOrganizationVariableRepository Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ActionsOrganizationVariableRepository(name: string, args: ActionsOrganizationVariableRepositoryArgs, opts?: CustomResourceOptions);@overload
def ActionsOrganizationVariableRepository(resource_name: str,
args: ActionsOrganizationVariableRepositoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ActionsOrganizationVariableRepository(resource_name: str,
opts: Optional[ResourceOptions] = None,
repository_id: Optional[int] = None,
variable_name: Optional[str] = None)func NewActionsOrganizationVariableRepository(ctx *Context, name string, args ActionsOrganizationVariableRepositoryArgs, opts ...ResourceOption) (*ActionsOrganizationVariableRepository, error)public ActionsOrganizationVariableRepository(string name, ActionsOrganizationVariableRepositoryArgs args, CustomResourceOptions? opts = null)
public ActionsOrganizationVariableRepository(String name, ActionsOrganizationVariableRepositoryArgs args)
public ActionsOrganizationVariableRepository(String name, ActionsOrganizationVariableRepositoryArgs args, CustomResourceOptions options)
type: github:ActionsOrganizationVariableRepository
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 ActionsOrganizationVariableRepositoryArgs
- 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 ActionsOrganizationVariableRepositoryArgs
- 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 ActionsOrganizationVariableRepositoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionsOrganizationVariableRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActionsOrganizationVariableRepositoryArgs
- 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 actionsOrganizationVariableRepositoryResource = new Github.ActionsOrganizationVariableRepository("actionsOrganizationVariableRepositoryResource", new()
{
RepositoryId = 0,
VariableName = "string",
});
example, err := github.NewActionsOrganizationVariableRepository(ctx, "actionsOrganizationVariableRepositoryResource", &github.ActionsOrganizationVariableRepositoryArgs{
RepositoryId: pulumi.Int(0),
VariableName: pulumi.String("string"),
})
var actionsOrganizationVariableRepositoryResource = new ActionsOrganizationVariableRepository("actionsOrganizationVariableRepositoryResource", ActionsOrganizationVariableRepositoryArgs.builder()
.repositoryId(0)
.variableName("string")
.build());
actions_organization_variable_repository_resource = github.ActionsOrganizationVariableRepository("actionsOrganizationVariableRepositoryResource",
repository_id=0,
variable_name="string")
const actionsOrganizationVariableRepositoryResource = new github.ActionsOrganizationVariableRepository("actionsOrganizationVariableRepositoryResource", {
repositoryId: 0,
variableName: "string",
});
type: github:ActionsOrganizationVariableRepository
properties:
repositoryId: 0
variableName: string
ActionsOrganizationVariableRepository 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 ActionsOrganizationVariableRepository resource accepts the following input properties:
- Repository
Id int - ID of the repository that should be able to access the variable.
- Variable
Name string - Name of the actions organization variable.
- Repository
Id int - ID of the repository that should be able to access the variable.
- Variable
Name string - Name of the actions organization variable.
- repository
Id Integer - ID of the repository that should be able to access the variable.
- variable
Name String - Name of the actions organization variable.
- repository
Id number - ID of the repository that should be able to access the variable.
- variable
Name string - Name of the actions organization variable.
- repository_
id int - ID of the repository that should be able to access the variable.
- variable_
name str - Name of the actions organization variable.
- repository
Id Number - ID of the repository that should be able to access the variable.
- variable
Name String - Name of the actions organization variable.
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionsOrganizationVariableRepository 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 ActionsOrganizationVariableRepository Resource
Get an existing ActionsOrganizationVariableRepository 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?: ActionsOrganizationVariableRepositoryState, opts?: CustomResourceOptions): ActionsOrganizationVariableRepository@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
repository_id: Optional[int] = None,
variable_name: Optional[str] = None) -> ActionsOrganizationVariableRepositoryfunc GetActionsOrganizationVariableRepository(ctx *Context, name string, id IDInput, state *ActionsOrganizationVariableRepositoryState, opts ...ResourceOption) (*ActionsOrganizationVariableRepository, error)public static ActionsOrganizationVariableRepository Get(string name, Input<string> id, ActionsOrganizationVariableRepositoryState? state, CustomResourceOptions? opts = null)public static ActionsOrganizationVariableRepository get(String name, Output<String> id, ActionsOrganizationVariableRepositoryState state, CustomResourceOptions options)resources: _: type: github:ActionsOrganizationVariableRepository 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.
- Repository
Id int - ID of the repository that should be able to access the variable.
- Variable
Name string - Name of the actions organization variable.
- Repository
Id int - ID of the repository that should be able to access the variable.
- Variable
Name string - Name of the actions organization variable.
- repository
Id Integer - ID of the repository that should be able to access the variable.
- variable
Name String - Name of the actions organization variable.
- repository
Id number - ID of the repository that should be able to access the variable.
- variable
Name string - Name of the actions organization variable.
- repository_
id int - ID of the repository that should be able to access the variable.
- variable_
name str - Name of the actions organization variable.
- repository
Id Number - ID of the repository that should be able to access the variable.
- variable
Name String - Name of the actions organization variable.
Import
Import Command
The following command imports the access of repository ID 123456 for the actions organization variable named myvariable to a github_actions_organization_variable_repository resource named example.
$ pulumi import github:index/actionsOrganizationVariableRepository:ActionsOrganizationVariableRepository example myvariable:123456
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.
