@pulumi/github
Version:
A Pulumi package for creating and managing github cloud resources.
145 lines (144 loc) • 4.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to create and manage GitHub Actions variables within your GitHub repository environments.
* You must have write access to a repository to use this resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const exampleVariable = new github.ActionsEnvironmentVariable("example_variable", {
* environment: "example_environment",
* variableName: "example_variable_name",
* value: "example_variable_value",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const repo = github.getRepository({
* fullName: "my-org/repo",
* });
* const repoEnvironment = new github.RepositoryEnvironment("repo_environment", {
* repository: repo.then(repo => repo.name),
* environment: "example_environment",
* });
* const exampleVariable = new github.ActionsEnvironmentVariable("example_variable", {
* repository: repo.then(repo => repo.name),
* environment: repoEnvironment.environment,
* variableName: "example_variable_name",
* value: "example_variable_value",
* });
* ```
*
* ## Import
*
* This resource can be imported using an ID made up of the repository name, environment name, and variable name:
*
* ```sh
* $ pulumi import github:index/actionsEnvironmentVariable:ActionsEnvironmentVariable test_variable myrepo:myenv:myvariable
* ```
*/
export declare class ActionsEnvironmentVariable extends pulumi.CustomResource {
/**
* Get an existing ActionsEnvironmentVariable resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActionsEnvironmentVariableState, opts?: pulumi.CustomResourceOptions): ActionsEnvironmentVariable;
/**
* Returns true if the given object is an instance of ActionsEnvironmentVariable. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ActionsEnvironmentVariable;
/**
* Date of actionsEnvironmentSecret creation.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Name of the environment.
*/
readonly environment: pulumi.Output<string>;
/**
* Name of the repository.
*/
readonly repository: pulumi.Output<string>;
/**
* Date of actionsEnvironmentSecret update.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Value of the variable
*/
readonly value: pulumi.Output<string>;
/**
* Name of the variable.
*/
readonly variableName: pulumi.Output<string>;
/**
* Create a ActionsEnvironmentVariable resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ActionsEnvironmentVariableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ActionsEnvironmentVariable resources.
*/
export interface ActionsEnvironmentVariableState {
/**
* Date of actionsEnvironmentSecret creation.
*/
createdAt?: pulumi.Input<string>;
/**
* Name of the environment.
*/
environment?: pulumi.Input<string>;
/**
* Name of the repository.
*/
repository?: pulumi.Input<string>;
/**
* Date of actionsEnvironmentSecret update.
*/
updatedAt?: pulumi.Input<string>;
/**
* Value of the variable
*/
value?: pulumi.Input<string>;
/**
* Name of the variable.
*/
variableName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ActionsEnvironmentVariable resource.
*/
export interface ActionsEnvironmentVariableArgs {
/**
* Name of the environment.
*/
environment: pulumi.Input<string>;
/**
* Name of the repository.
*/
repository: pulumi.Input<string>;
/**
* Value of the variable
*/
value: pulumi.Input<string>;
/**
* Name of the variable.
*/
variableName: pulumi.Input<string>;
}