1. Packages
  2. Github Provider
  3. API Docs
  4. DependabotOrganizationSecret
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

github.DependabotOrganizationSecret

Explore with Pulumi AI

Example Usage

Create DependabotOrganizationSecret Resource

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

Constructor syntax

new DependabotOrganizationSecret(name: string, args: DependabotOrganizationSecretArgs, opts?: CustomResourceOptions);
@overload
def DependabotOrganizationSecret(resource_name: str,
                                 args: DependabotOrganizationSecretArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def DependabotOrganizationSecret(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 secret_name: Optional[str] = None,
                                 visibility: Optional[str] = None,
                                 encrypted_value: Optional[str] = None,
                                 plaintext_value: Optional[str] = None,
                                 selected_repository_ids: Optional[Sequence[int]] = None)
func NewDependabotOrganizationSecret(ctx *Context, name string, args DependabotOrganizationSecretArgs, opts ...ResourceOption) (*DependabotOrganizationSecret, error)
public DependabotOrganizationSecret(string name, DependabotOrganizationSecretArgs args, CustomResourceOptions? opts = null)
public DependabotOrganizationSecret(String name, DependabotOrganizationSecretArgs args)
public DependabotOrganizationSecret(String name, DependabotOrganizationSecretArgs args, CustomResourceOptions options)
type: github:DependabotOrganizationSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DependabotOrganizationSecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DependabotOrganizationSecretArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DependabotOrganizationSecretArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DependabotOrganizationSecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DependabotOrganizationSecretArgs
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 dependabotOrganizationSecretResource = new Github.DependabotOrganizationSecret("dependabotOrganizationSecretResource", new()
{
    SecretName = "string",
    Visibility = "string",
    EncryptedValue = "string",
    PlaintextValue = "string",
    SelectedRepositoryIds = new[]
    {
        0,
    },
});
Copy
example, err := github.NewDependabotOrganizationSecret(ctx, "dependabotOrganizationSecretResource", &github.DependabotOrganizationSecretArgs{
	SecretName:     pulumi.String("string"),
	Visibility:     pulumi.String("string"),
	EncryptedValue: pulumi.String("string"),
	PlaintextValue: pulumi.String("string"),
	SelectedRepositoryIds: pulumi.IntArray{
		pulumi.Int(0),
	},
})
Copy
var dependabotOrganizationSecretResource = new DependabotOrganizationSecret("dependabotOrganizationSecretResource", DependabotOrganizationSecretArgs.builder()
    .secretName("string")
    .visibility("string")
    .encryptedValue("string")
    .plaintextValue("string")
    .selectedRepositoryIds(0)
    .build());
Copy
dependabot_organization_secret_resource = github.DependabotOrganizationSecret("dependabotOrganizationSecretResource",
    secret_name="string",
    visibility="string",
    encrypted_value="string",
    plaintext_value="string",
    selected_repository_ids=[0])
Copy
const dependabotOrganizationSecretResource = new github.DependabotOrganizationSecret("dependabotOrganizationSecretResource", {
    secretName: "string",
    visibility: "string",
    encryptedValue: "string",
    plaintextValue: "string",
    selectedRepositoryIds: [0],
});
Copy
type: github:DependabotOrganizationSecret
properties:
    encryptedValue: string
    plaintextValue: string
    secretName: string
    selectedRepositoryIds:
        - 0
    visibility: string
Copy

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

SecretName
This property is required.
Changes to this property will trigger replacement.
string
Name of the secret
Visibility
This property is required.
Changes to this property will trigger replacement.
string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
EncryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
PlaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
SelectedRepositoryIds Changes to this property will trigger replacement. List<int>
An array of repository ids that can access the organization secret.
SecretName
This property is required.
Changes to this property will trigger replacement.
string
Name of the secret
Visibility
This property is required.
Changes to this property will trigger replacement.
string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
EncryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
PlaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
SelectedRepositoryIds Changes to this property will trigger replacement. []int
An array of repository ids that can access the organization secret.
secretName
This property is required.
Changes to this property will trigger replacement.
String
Name of the secret
visibility
This property is required.
Changes to this property will trigger replacement.
String
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
encryptedValue Changes to this property will trigger replacement. String
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. String
Plaintext value of the secret to be encrypted
selectedRepositoryIds Changes to this property will trigger replacement. List<Integer>
An array of repository ids that can access the organization secret.
secretName
This property is required.
Changes to this property will trigger replacement.
string
Name of the secret
visibility
This property is required.
Changes to this property will trigger replacement.
string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
encryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
selectedRepositoryIds Changes to this property will trigger replacement. number[]
An array of repository ids that can access the organization secret.
secret_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the secret
visibility
This property is required.
Changes to this property will trigger replacement.
str
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
encrypted_value Changes to this property will trigger replacement. str
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintext_value Changes to this property will trigger replacement. str
Plaintext value of the secret to be encrypted
selected_repository_ids Changes to this property will trigger replacement. Sequence[int]
An array of repository ids that can access the organization secret.
secretName
This property is required.
Changes to this property will trigger replacement.
String
Name of the secret
visibility
This property is required.
Changes to this property will trigger replacement.
String
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
encryptedValue Changes to this property will trigger replacement. String
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. String
Plaintext value of the secret to be encrypted
selectedRepositoryIds Changes to this property will trigger replacement. List<Number>
An array of repository ids that can access the organization secret.

Outputs

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

CreatedAt string
Date of dependabot_secret creation.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Date of dependabot_secret update.
CreatedAt string
Date of dependabot_secret creation.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Date of dependabot_secret update.
createdAt String
Date of dependabot_secret creation.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Date of dependabot_secret update.
createdAt string
Date of dependabot_secret creation.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
Date of dependabot_secret update.
created_at str
Date of dependabot_secret creation.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
Date of dependabot_secret update.
createdAt String
Date of dependabot_secret creation.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Date of dependabot_secret update.

Look up Existing DependabotOrganizationSecret Resource

Get an existing DependabotOrganizationSecret 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?: DependabotOrganizationSecretState, opts?: CustomResourceOptions): DependabotOrganizationSecret
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        encrypted_value: Optional[str] = None,
        plaintext_value: Optional[str] = None,
        secret_name: Optional[str] = None,
        selected_repository_ids: Optional[Sequence[int]] = None,
        updated_at: Optional[str] = None,
        visibility: Optional[str] = None) -> DependabotOrganizationSecret
func GetDependabotOrganizationSecret(ctx *Context, name string, id IDInput, state *DependabotOrganizationSecretState, opts ...ResourceOption) (*DependabotOrganizationSecret, error)
public static DependabotOrganizationSecret Get(string name, Input<string> id, DependabotOrganizationSecretState? state, CustomResourceOptions? opts = null)
public static DependabotOrganizationSecret get(String name, Output<String> id, DependabotOrganizationSecretState state, CustomResourceOptions options)
resources:  _:    type: github:DependabotOrganizationSecret    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 of dependabot_secret creation.
EncryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
PlaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
SecretName Changes to this property will trigger replacement. string
Name of the secret
SelectedRepositoryIds Changes to this property will trigger replacement. List<int>
An array of repository ids that can access the organization secret.
UpdatedAt string
Date of dependabot_secret update.
Visibility Changes to this property will trigger replacement. string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
CreatedAt string
Date of dependabot_secret creation.
EncryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
PlaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
SecretName Changes to this property will trigger replacement. string
Name of the secret
SelectedRepositoryIds Changes to this property will trigger replacement. []int
An array of repository ids that can access the organization secret.
UpdatedAt string
Date of dependabot_secret update.
Visibility Changes to this property will trigger replacement. string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
createdAt String
Date of dependabot_secret creation.
encryptedValue Changes to this property will trigger replacement. String
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. String
Plaintext value of the secret to be encrypted
secretName Changes to this property will trigger replacement. String
Name of the secret
selectedRepositoryIds Changes to this property will trigger replacement. List<Integer>
An array of repository ids that can access the organization secret.
updatedAt String
Date of dependabot_secret update.
visibility Changes to this property will trigger replacement. String
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
createdAt string
Date of dependabot_secret creation.
encryptedValue Changes to this property will trigger replacement. string
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. string
Plaintext value of the secret to be encrypted
secretName Changes to this property will trigger replacement. string
Name of the secret
selectedRepositoryIds Changes to this property will trigger replacement. number[]
An array of repository ids that can access the organization secret.
updatedAt string
Date of dependabot_secret update.
visibility Changes to this property will trigger replacement. string
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
created_at str
Date of dependabot_secret creation.
encrypted_value Changes to this property will trigger replacement. str
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintext_value Changes to this property will trigger replacement. str
Plaintext value of the secret to be encrypted
secret_name Changes to this property will trigger replacement. str
Name of the secret
selected_repository_ids Changes to this property will trigger replacement. Sequence[int]
An array of repository ids that can access the organization secret.
updated_at str
Date of dependabot_secret update.
visibility Changes to this property will trigger replacement. str
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.
createdAt String
Date of dependabot_secret creation.
encryptedValue Changes to this property will trigger replacement. String
Encrypted value of the secret using the GitHub public key in Base64 format.
plaintextValue Changes to this property will trigger replacement. String
Plaintext value of the secret to be encrypted
secretName Changes to this property will trigger replacement. String
Name of the secret
selectedRepositoryIds Changes to this property will trigger replacement. List<Number>
An array of repository ids that can access the organization secret.
updatedAt String
Date of dependabot_secret update.
visibility Changes to this property will trigger replacement. String
Configures the access that repositories have to the organization secret. Must be one of all, private, selected. selected_repository_ids is required if set to selected.

Import

This resource can be imported using an ID made up of the secret name:

$ pulumi import github:index/dependabotOrganizationSecret:DependabotOrganizationSecret test_secret test_secret_name
Copy

NOTE: the implementation is limited in that it won’t fetch the value of the

plaintext_value or encrypted_value fields when importing. You may need to ignore changes for these as a workaround.

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.