github.ActionsEnvironmentSecret

GitHub v6.13.1, Apr 29 26

Viewing docs for GitHub v6.13.1
published on Wednesday, Apr 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

Viewing docs for GitHub v6.13.1
published on Wednesday, Apr 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

For the purposes of security, the contents of the value field have been marked as sensitive to Terraform, but it is important to note that this does not hide it from state files. You should treat state as sensitive always. It is also advised that you do not store plaintext values in your code but rather populate the valueEncrypted using fields from a resource, data source or variable as, while encrypted in state, these will be easily accessible in your code. See below for an example of this abstraction.

Example Lifecycle Ignore Changes

This resource supports using the lifecycle ignoreChanges block on remoteUpdatedAt to support use cases where a secret value is created using a placeholder value and then modified after creation outside the scope of Terraform. This approach ensures only the initial placeholder value is referenced in your code and in the resulting state file.

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const exampleAllowDrift = new github.ActionsEnvironmentSecret("example_allow_drift", {
    repository: "example-repo",
    environment: "example-environment",
    secretName: "example_secret_name",
    value: "placeholder",
});

import pulumi
import pulumi_github as github

example_allow_drift = github.ActionsEnvironmentSecret("example_allow_drift",
    repository="example-repo",
    environment="example-environment",
    secret_name="example_secret_name",
    value="placeholder")

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 {
		_, err := github.NewActionsEnvironmentSecret(ctx, "example_allow_drift", &github.ActionsEnvironmentSecretArgs{
			Repository:  pulumi.String("example-repo"),
			Environment: pulumi.String("example-environment"),
			SecretName:  pulumi.String("example_secret_name"),
			Value:       pulumi.String("placeholder"),
		})
		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 exampleAllowDrift = new Github.Index.ActionsEnvironmentSecret("example_allow_drift", new()
    {
        Repository = "example-repo",
        Environment = "example-environment",
        SecretName = "example_secret_name",
        Value = "placeholder",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.ActionsEnvironmentSecret;
import com.pulumi.github.ActionsEnvironmentSecretArgs;
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 exampleAllowDrift = new ActionsEnvironmentSecret("exampleAllowDrift", ActionsEnvironmentSecretArgs.builder()
            .repository("example-repo")
            .environment("example-environment")
            .secretName("example_secret_name")
            .value("placeholder")
            .build());

    }
}

resources:
  exampleAllowDrift:
    type: github:ActionsEnvironmentSecret
    name: example_allow_drift
    properties:
      repository: example-repo
      environment: example-environment
      secretName: example_secret_name
      value: placeholder

Example coming soon!

Create ActionsEnvironmentSecret Resource

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

Constructor syntax

new ActionsEnvironmentSecret(name: string, args: ActionsEnvironmentSecretArgs, opts?: CustomResourceOptions);

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

@overload
def ActionsEnvironmentSecret(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             environment: Optional[str] = None,
                             repository: Optional[str] = None,
                             secret_name: Optional[str] = None,
                             encrypted_value: Optional[str] = None,
                             key_id: Optional[str] = None,
                             plaintext_value: Optional[str] = None,
                             value: Optional[str] = None,
                             value_encrypted: Optional[str] = None)

func NewActionsEnvironmentSecret(ctx *Context, name string, args ActionsEnvironmentSecretArgs, opts ...ResourceOption) (*ActionsEnvironmentSecret, error)

public ActionsEnvironmentSecret(string name, ActionsEnvironmentSecretArgs args, CustomResourceOptions? opts = null)

public ActionsEnvironmentSecret(String name, ActionsEnvironmentSecretArgs args)
public ActionsEnvironmentSecret(String name, ActionsEnvironmentSecretArgs args, CustomResourceOptions options)

type: github:ActionsEnvironmentSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "github_actionsenvironmentsecret" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args ActionsEnvironmentSecretArgs: 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 ActionsEnvironmentSecretArgs: 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 ActionsEnvironmentSecretArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ActionsEnvironmentSecretArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ActionsEnvironmentSecretArgs: 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 actionsEnvironmentSecretResource = new Github.ActionsEnvironmentSecret("actionsEnvironmentSecretResource", new()
{
    Environment = "string",
    Repository = "string",
    SecretName = "string",
    KeyId = "string",
    Value = "string",
    ValueEncrypted = "string",
});

example, err := github.NewActionsEnvironmentSecret(ctx, "actionsEnvironmentSecretResource", &github.ActionsEnvironmentSecretArgs{
	Environment:    pulumi.String("string"),
	Repository:     pulumi.String("string"),
	SecretName:     pulumi.String("string"),
	KeyId:          pulumi.String("string"),
	Value:          pulumi.String("string"),
	ValueEncrypted: pulumi.String("string"),
})

resource "github_actionsenvironmentsecret" "actionsEnvironmentSecretResource" {
  environment     = "string"
  repository      = "string"
  secret_name     = "string"
  key_id          = "string"
  value           = "string"
  value_encrypted = "string"
}

var actionsEnvironmentSecretResource = new ActionsEnvironmentSecret("actionsEnvironmentSecretResource", ActionsEnvironmentSecretArgs.builder()
    .environment("string")
    .repository("string")
    .secretName("string")
    .keyId("string")
    .value("string")
    .valueEncrypted("string")
    .build());

actions_environment_secret_resource = github.ActionsEnvironmentSecret("actionsEnvironmentSecretResource",
    environment="string",
    repository="string",
    secret_name="string",
    key_id="string",
    value="string",
    value_encrypted="string")

const actionsEnvironmentSecretResource = new github.ActionsEnvironmentSecret("actionsEnvironmentSecretResource", {
    environment: "string",
    repository: "string",
    secretName: "string",
    keyId: "string",
    value: "string",
    valueEncrypted: "string",
});

type: github:ActionsEnvironmentSecret
properties:
    environment: string
    keyId: string
    repository: string
    secretName: string
    value: string
    valueEncrypted: string

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

Environment string

Name of the environment.

Repository string

Name of the repository.

SecretName string

Name of the secret.

EncryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

KeyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

PlaintextValue string

(Optional) Please use value.

Deprecated: Use value.

Value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

ValueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

Environment string

Name of the environment.

Repository string

Name of the repository.

SecretName string

Name of the secret.

EncryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

KeyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

PlaintextValue string

(Optional) Please use value.

Deprecated: Use value.

Value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

ValueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

environment string

Name of the environment.

repository string

Name of the repository.

secret_name string

Name of the secret.

encrypted_value string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

key_id string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintext_value string

(Optional) Please use value.

Deprecated: Use value.

value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

value_encrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

environment String

Name of the environment.

repository String

Name of the repository.

secretName String

Name of the secret.

encryptedValue String

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

keyId String

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue String

(Optional) Please use value.

Deprecated: Use value.

value String

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted String

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

environment string

Name of the environment.

repository string

Name of the repository.

secretName string

Name of the secret.

encryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

keyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue string

(Optional) Please use value.

Deprecated: Use value.

value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

environment str

Name of the environment.

repository str

Name of the repository.

secret_name str

Name of the secret.

encrypted_value str

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

key_id str

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintext_value str

(Optional) Please use value.

Deprecated: Use value.

value str

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

value_encrypted str

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

environment String

Name of the environment.

repository String

Name of the repository.

secretName String

Name of the secret.

encryptedValue String

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

keyId String

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue String

(Optional) Please use value.

Deprecated: Use value.

value String

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted String

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

Outputs

All input properties are implicitly available as output properties. Additionally, the ActionsEnvironmentSecret resource produces the following output properties:

CreatedAt string: Date the secret was created.
Id string: The provider-assigned unique ID for this managed resource.
RemoteUpdatedAt string: Date the secret was last updated in GitHub.
RepositoryId int: ID of the repository.
UpdatedAt string: Date the secret was last updated by the provider.

CreatedAt string: Date the secret was created.
Id string: The provider-assigned unique ID for this managed resource.
RemoteUpdatedAt string: Date the secret was last updated in GitHub.
RepositoryId int: ID of the repository.
UpdatedAt string: Date the secret was last updated by the provider.

created_at string: Date the secret was created.
id string: The provider-assigned unique ID for this managed resource.
remote_updated_at string: Date the secret was last updated in GitHub.
repository_id number: ID of the repository.
updated_at string: Date the secret was last updated by the provider.

createdAt String: Date the secret was created.
id String: The provider-assigned unique ID for this managed resource.
remoteUpdatedAt String: Date the secret was last updated in GitHub.
repositoryId Integer: ID of the repository.
updatedAt String: Date the secret was last updated by the provider.

createdAt string: Date the secret was created.
id string: The provider-assigned unique ID for this managed resource.
remoteUpdatedAt string: Date the secret was last updated in GitHub.
repositoryId number: ID of the repository.
updatedAt string: Date the secret was last updated by the provider.

created_at str: Date the secret was created.
id str: The provider-assigned unique ID for this managed resource.
remote_updated_at str: Date the secret was last updated in GitHub.
repository_id int: ID of the repository.
updated_at str: Date the secret was last updated by the provider.

createdAt String: Date the secret was created.
id String: The provider-assigned unique ID for this managed resource.
remoteUpdatedAt String: Date the secret was last updated in GitHub.
repositoryId Number: ID of the repository.
updatedAt String: Date the secret was last updated by the provider.

Look up Existing ActionsEnvironmentSecret Resource

Get an existing ActionsEnvironmentSecret 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?: ActionsEnvironmentSecretState, opts?: CustomResourceOptions): ActionsEnvironmentSecret

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        encrypted_value: Optional[str] = None,
        environment: Optional[str] = None,
        key_id: Optional[str] = None,
        plaintext_value: Optional[str] = None,
        remote_updated_at: Optional[str] = None,
        repository: Optional[str] = None,
        repository_id: Optional[int] = None,
        secret_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        value: Optional[str] = None,
        value_encrypted: Optional[str] = None) -> ActionsEnvironmentSecret

func GetActionsEnvironmentSecret(ctx *Context, name string, id IDInput, state *ActionsEnvironmentSecretState, opts ...ResourceOption) (*ActionsEnvironmentSecret, error)

public static ActionsEnvironmentSecret Get(string name, Input<string> id, ActionsEnvironmentSecretState? state, CustomResourceOptions? opts = null)

public static ActionsEnvironmentSecret get(String name, Output<String> id, ActionsEnvironmentSecretState state, CustomResourceOptions options)

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

import {
  to = github_actionsenvironmentsecret.example
  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 the secret was created.

EncryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

Environment string

Name of the environment.

KeyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

PlaintextValue string

(Optional) Please use value.

Deprecated: Use value.

RemoteUpdatedAt string

Date the secret was last updated in GitHub.

Repository string

Name of the repository.

RepositoryId int

ID of the repository.

SecretName string

Name of the secret.

UpdatedAt string

Date the secret was last updated by the provider.

Value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

ValueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

CreatedAt string

Date the secret was created.

EncryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

Environment string

Name of the environment.

KeyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

PlaintextValue string

(Optional) Please use value.

Deprecated: Use value.

RemoteUpdatedAt string

Date the secret was last updated in GitHub.

Repository string

Name of the repository.

RepositoryId int

ID of the repository.

SecretName string

Name of the secret.

UpdatedAt string

Date the secret was last updated by the provider.

Value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

ValueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

created_at string

Date the secret was created.

encrypted_value string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

environment string

Name of the environment.

key_id string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintext_value string

(Optional) Please use value.

Deprecated: Use value.

remote_updated_at string

Date the secret was last updated in GitHub.

repository string

Name of the repository.

repository_id number

ID of the repository.

secret_name string

Name of the secret.

updated_at string

Date the secret was last updated by the provider.

value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

value_encrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

createdAt String

Date the secret was created.

encryptedValue String

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

environment String

Name of the environment.

keyId String

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue String

(Optional) Please use value.

Deprecated: Use value.

remoteUpdatedAt String

Date the secret was last updated in GitHub.

repository String

Name of the repository.

repositoryId Integer

ID of the repository.

secretName String

Name of the secret.

updatedAt String

Date the secret was last updated by the provider.

value String

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted String

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

createdAt string

Date the secret was created.

encryptedValue string

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

environment string

Name of the environment.

keyId string

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue string

(Optional) Please use value.

Deprecated: Use value.

remoteUpdatedAt string

Date the secret was last updated in GitHub.

repository string

Name of the repository.

repositoryId number

ID of the repository.

secretName string

Name of the secret.

updatedAt string

Date the secret was last updated by the provider.

value string

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted string

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

created_at str

Date the secret was created.

encrypted_value str

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

environment str

Name of the environment.

key_id str

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintext_value str

(Optional) Please use value.

Deprecated: Use value.

remote_updated_at str

Date the secret was last updated in GitHub.

repository str

Name of the repository.

repository_id int

ID of the repository.

secret_name str

Name of the secret.

updated_at str

Date the secret was last updated by the provider.

value str

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

value_encrypted str

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

createdAt String

Date the secret was created.

encryptedValue String

(Optional) Please use valueEncrypted.

Deprecated: Use valueEncrypted and key_id.

environment String

Name of the environment.

keyId String

ID of the public key used to encrypt the secret, required when setting encryptedValue.

plaintextValue String

(Optional) Please use value.

Deprecated: Use value.

remoteUpdatedAt String

Date the secret was last updated in GitHub.

repository String

Name of the repository.

repositoryId Number

ID of the repository.

secretName String

Name of the secret.

updatedAt String

Date the secret was last updated by the provider.

value String

Plaintext value of the secret to be encrypted. This conflicts with valueEncrypted, encryptedValue & plaintextValue.

valueEncrypted String

Encrypted value of the secret using the GitHub public key in Base64 format, keyId is required with this value. This conflicts with value, encryptedValue & plaintextValue.

Import

This resource can be imported using an ID made of the repository name, environment name (URL escaped), and secret name all separated by a :.

Import Command

The following command imports a GitHub actions environment secret named mysecret for the repo myrepo and environment myenv to a github.ActionsEnvironmentSecret resource named example.

$ pulumi import github:index/actionsEnvironmentSecret:ActionsEnvironmentSecret example myrepo:myenv: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 github Terraform Provider.

Viewing docs for GitHub v6.13.1
published on Wednesday, Apr 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

github.ActionsEnvironmentSecret

On this page

On this page

Example Lifecycle Ignore Changes

Create ActionsEnvironmentSecret Resource

Constructor syntax

Parameters

Constructor example

ActionsEnvironmentSecret Resource Properties

Inputs

Outputs

Look up Existing ActionsEnvironmentSecret Resource

Import

Import Command

Package Details

On this page

On this page