1. Packages
  2. GitHub
  3. API Docs
  4. DependabotSecret
GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi

github.DependabotSecret

Explore with Pulumi AI

github logo
GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi

    Example Usage

    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,
                         plaintext_value: 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var dependabotSecretResource = new Github.DependabotSecret("dependabotSecretResource", new()
    {
        Repository = "string",
        SecretName = "string",
        EncryptedValue = "string",
        PlaintextValue = "string",
    });
    
    example, err := github.NewDependabotSecret(ctx, "dependabotSecretResource", &github.DependabotSecretArgs{
    	Repository:     pulumi.String("string"),
    	SecretName:     pulumi.String("string"),
    	EncryptedValue: pulumi.String("string"),
    	PlaintextValue: pulumi.String("string"),
    })
    
    var dependabotSecretResource = new DependabotSecret("dependabotSecretResource", DependabotSecretArgs.builder()
        .repository("string")
        .secretName("string")
        .encryptedValue("string")
        .plaintextValue("string")
        .build());
    
    dependabot_secret_resource = github.DependabotSecret("dependabotSecretResource",
        repository="string",
        secret_name="string",
        encrypted_value="string",
        plaintext_value="string")
    
    const dependabotSecretResource = new github.DependabotSecret("dependabotSecretResource", {
        repository: "string",
        secretName: "string",
        encryptedValue: "string",
        plaintextValue: "string",
    });
    
    type: github:DependabotSecret
    properties:
        encryptedValue: string
        plaintextValue: string
        repository: string
        secretName: 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

    The DependabotSecret resource accepts the following input properties:

    Repository string
    Name of the repository
    SecretName string
    Name of the secret
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    PlaintextValue string
    Plaintext value of the secret to be encrypted
    Repository string
    Name of the repository
    SecretName string
    Name of the secret
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    PlaintextValue string
    Plaintext value of the secret to be encrypted
    repository String
    Name of the repository
    secretName String
    Name of the secret
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue String
    Plaintext value of the secret to be encrypted
    repository string
    Name of the repository
    secretName string
    Name of the secret
    encryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue string
    Plaintext value of the secret to be encrypted
    repository str
    Name of the repository
    secret_name str
    Name of the secret
    encrypted_value str
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintext_value str
    Plaintext value of the secret to be encrypted
    repository String
    Name of the repository
    secretName String
    Name of the secret
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue String
    Plaintext value of the secret to be encrypted

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DependabotSecret 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 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,
            plaintext_value: Optional[str] = None,
            repository: Optional[str] = None,
            secret_name: Optional[str] = None,
            updated_at: 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)
    Resource lookup is not supported in YAML
    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 of dependabot_secret creation.
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    PlaintextValue string
    Plaintext value of the secret to be encrypted
    Repository string
    Name of the repository
    SecretName string
    Name of the secret
    UpdatedAt string
    Date of dependabot_secret update.
    CreatedAt string
    Date of dependabot_secret creation.
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    PlaintextValue string
    Plaintext value of the secret to be encrypted
    Repository string
    Name of the repository
    SecretName string
    Name of the secret
    UpdatedAt string
    Date of dependabot_secret update.
    createdAt String
    Date of dependabot_secret creation.
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue String
    Plaintext value of the secret to be encrypted
    repository String
    Name of the repository
    secretName String
    Name of the secret
    updatedAt String
    Date of dependabot_secret update.
    createdAt string
    Date of dependabot_secret creation.
    encryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue string
    Plaintext value of the secret to be encrypted
    repository string
    Name of the repository
    secretName string
    Name of the secret
    updatedAt string
    Date of dependabot_secret update.
    created_at str
    Date of dependabot_secret creation.
    encrypted_value str
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintext_value str
    Plaintext value of the secret to be encrypted
    repository str
    Name of the repository
    secret_name str
    Name of the secret
    updated_at str
    Date of dependabot_secret update.
    createdAt String
    Date of dependabot_secret creation.
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    plaintextValue String
    Plaintext value of the secret to be encrypted
    repository String
    Name of the repository
    secretName String
    Name of the secret
    updatedAt String
    Date of dependabot_secret update.

    Import

    This resource can be imported using an ID made up of the repository and secret_name:

    $ pulumi import github:index/dependabotSecret:DependabotSecret example_secret example_repository/example_secret
    

    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.
    github logo
    GitHub v6.2.1 published on Thursday, May 23, 2024 by Pulumi