DependabotSecret

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 Usage

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

const examplePlaintext = new github.DependabotSecret("example_plaintext", {
    repository: "example_repository",
    secretName: "example_secret_name",
    value: someSecretString,
});
const exampleEncrypted = new github.DependabotSecret("example_encrypted", {
    repository: "example_repository",
    secretName: "example_secret_name",
    valueEncrypted: someEncryptedSecretString,
});

import pulumi
import pulumi_github as github

example_plaintext = github.DependabotSecret("example_plaintext",
    repository="example_repository",
    secret_name="example_secret_name",
    value=some_secret_string)
example_encrypted = github.DependabotSecret("example_encrypted",
    repository="example_repository",
    secret_name="example_secret_name",
    value_encrypted=some_encrypted_secret_string)

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.NewDependabotSecret(ctx, "example_plaintext", &github.DependabotSecretArgs{
			Repository: pulumi.String("example_repository"),
			SecretName: pulumi.String("example_secret_name"),
			Value:      pulumi.Any(someSecretString),
		})
		if err != nil {
			return err
		}
		_, err = github.NewDependabotSecret(ctx, "example_encrypted", &github.DependabotSecretArgs{
			Repository:     pulumi.String("example_repository"),
			SecretName:     pulumi.String("example_secret_name"),
			ValueEncrypted: pulumi.Any(someEncryptedSecretString),
		})
		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 examplePlaintext = new Github.Index.DependabotSecret("example_plaintext", new()
    {
        Repository = "example_repository",
        SecretName = "example_secret_name",
        Value = someSecretString,
    });

    var exampleEncrypted = new Github.Index.DependabotSecret("example_encrypted", new()
    {
        Repository = "example_repository",
        SecretName = "example_secret_name",
        ValueEncrypted = someEncryptedSecretString,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.DependabotSecret;
import com.pulumi.github.DependabotSecretArgs;
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 examplePlaintext = new DependabotSecret("examplePlaintext", DependabotSecretArgs.builder()
            .repository("example_repository")
            .secretName("example_secret_name")
            .value(someSecretString)
            .build());

        var exampleEncrypted = new DependabotSecret("exampleEncrypted", DependabotSecretArgs.builder()
            .repository("example_repository")
            .secretName("example_secret_name")
            .valueEncrypted(someEncryptedSecretString)
            .build());

    }
}

resources:
  examplePlaintext:
    type: github:DependabotSecret
    name: example_plaintext
    properties:
      repository: example_repository
      secretName: example_secret_name
      value: ${someSecretString}
  exampleEncrypted:
    type: github:DependabotSecret
    name: example_encrypted
    properties:
      repository: example_repository
      secretName: example_secret_name
      valueEncrypted: ${someEncryptedSecretString}

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.DependabotSecret("example_allow_drift", {
    repository: "example_repository",
    secretName: "example_secret_name",
    value: "placeholder",
});

import pulumi
import pulumi_github as github

example_allow_drift = github.DependabotSecret("example_allow_drift",
    repository="example_repository",
    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.NewDependabotSecret(ctx, "example_allow_drift", &github.DependabotSecretArgs{
			Repository: pulumi.String("example_repository"),
			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.DependabotSecret("example_allow_drift", new()
    {
        Repository = "example_repository",
        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.DependabotSecret;
import com.pulumi.github.DependabotSecretArgs;
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 DependabotSecret("exampleAllowDrift", DependabotSecretArgs.builder()
            .repository("example_repository")
            .secretName("example_secret_name")
            .value("placeholder")
            .build());

    }
}

resources:
  exampleAllowDrift:
    type: github:DependabotSecret
    name: example_allow_drift
    properties:
      repository: example_repository
      secretName: example_secret_name
      value: placeholder

Create DependabotSecret Resource

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

Constructor syntax

new DependabotSecret(name: string, args: DependabotSecretArgs, opts?: CustomResourceOptions);

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

@overload
def DependabotSecret(resource_name: str,
                     opts: Optional[ResourceOptions] = 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 NewDependabotSecret(ctx *Context, name string, args DependabotSecretArgs, opts ...ResourceOption) (*DependabotSecret, error)

public DependabotSecret(string name, DependabotSecretArgs args, CustomResourceOptions? opts = null)

public DependabotSecret(String name, DependabotSecretArgs args)
public DependabotSecret(String name, DependabotSecretArgs args, CustomResourceOptions options)

type: github:DependabotSecret
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 DependabotSecretArgs: 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 DependabotSecretArgs: 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 DependabotSecretArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

example, err := github.NewDependabotSecret(ctx, "dependabotSecretResource", &github.DependabotSecretArgs{
	Repository:     pulumi.String("string"),
	SecretName:     pulumi.String("string"),
	KeyId:          pulumi.String("string"),
	Value:          pulumi.String("string"),
	ValueEncrypted: pulumi.String("string"),
})

var dependabotSecretResource = new DependabotSecret("dependabotSecretResource", DependabotSecretArgs.builder()
    .repository("string")
    .secretName("string")
    .keyId("string")
    .value("string")
    .valueEncrypted("string")
    .build());

dependabot_secret_resource = github.DependabotSecret("dependabotSecretResource",
    repository="string",
    secret_name="string",
    key_id="string",
    value="string",
    value_encrypted="string")

const dependabotSecretResource = new github.DependabotSecret("dependabotSecretResource", {
    repository: "string",
    secretName: "string",
    keyId: "string",
    value: "string",
    valueEncrypted: "string",
});

type: github:DependabotSecret
properties:
    keyId: string
    repository: string
    secretName: string
    value: string
    valueEncrypted: string

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

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.

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.

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.

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.

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.

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 DependabotSecret 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.

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 DependabotSecret Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        encrypted_value: 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) -> DependabotSecret

func GetDependabotSecret(ctx *Context, name string, id IDInput, state *DependabotSecretState, opts ...ResourceOption) (*DependabotSecret, error)

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

public static DependabotSecret get(String name, Output<String> id, DependabotSecretState state, CustomResourceOptions options)

resources:  _:    type: github:DependabotSecret    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.

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.

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.

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.

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.

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.

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.

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, and secret name separated by a :.

Import Command

The following command imports a GitHub Dependabot secret named mysecret for the repo myrepo to a github.DependabotSecret resource named example.

$ pulumi import github:index/dependabotSecret:DependabotSecret example myrepo: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.DependabotSecret

On this page

On this page

Example Usage

Example Lifecycle Ignore Changes

Create DependabotSecret Resource

Constructor syntax

Parameters

Constructor example

DependabotSecret Resource Properties

Inputs

Outputs

Look up Existing DependabotSecret Resource

Import

Import Command

Package Details

On this page

On this page