1. Packages
  2. GitHub
  3. API Docs
  4. ActionsSecret
GitHub v5.19.0 published on Friday, Sep 22, 2023 by Pulumi

github.ActionsSecret

Explore with Pulumi AI

github logo
GitHub v5.19.0 published on Friday, Sep 22, 2023 by Pulumi

    Import

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

     $ pulumi import github:index/actionsSecret:ActionsSecret example_secret repository/secret_name
    

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var examplePublicKey = Github.GetActionsPublicKey.Invoke(new()
        {
            Repository = "example_repository",
        });
    
        var exampleSecretActionsSecret = new Github.ActionsSecret("exampleSecretActionsSecret", new()
        {
            Repository = "example_repository",
            SecretName = "example_secret_name",
            PlaintextValue = @var.Some_secret_string,
        });
    
        var exampleSecretIndex_actionsSecretActionsSecret = new Github.ActionsSecret("exampleSecretIndex/actionsSecretActionsSecret", new()
        {
            Repository = "example_repository",
            SecretName = "example_secret_name",
            EncryptedValue = @var.Some_encrypted_secret_string,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v5/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := github.GetActionsPublicKey(ctx, &github.GetActionsPublicKeyArgs{
    			Repository: "example_repository",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = github.NewActionsSecret(ctx, "exampleSecretActionsSecret", &github.ActionsSecretArgs{
    			Repository:     pulumi.String("example_repository"),
    			SecretName:     pulumi.String("example_secret_name"),
    			PlaintextValue: pulumi.Any(_var.Some_secret_string),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = github.NewActionsSecret(ctx, "exampleSecretIndex/actionsSecretActionsSecret", &github.ActionsSecretArgs{
    			Repository:     pulumi.String("example_repository"),
    			SecretName:     pulumi.String("example_secret_name"),
    			EncryptedValue: pulumi.Any(_var.Some_encrypted_secret_string),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    import com.pulumi.github.inputs.GetActionsPublicKeyArgs;
    import com.pulumi.github.ActionsSecret;
    import com.pulumi.github.ActionsSecretArgs;
    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) {
            final var examplePublicKey = GithubFunctions.getActionsPublicKey(GetActionsPublicKeyArgs.builder()
                .repository("example_repository")
                .build());
    
            var exampleSecretActionsSecret = new ActionsSecret("exampleSecretActionsSecret", ActionsSecretArgs.builder()        
                .repository("example_repository")
                .secretName("example_secret_name")
                .plaintextValue(var_.some_secret_string())
                .build());
    
            var exampleSecretIndex_actionsSecretActionsSecret = new ActionsSecret("exampleSecretIndex/actionsSecretActionsSecret", ActionsSecretArgs.builder()        
                .repository("example_repository")
                .secretName("example_secret_name")
                .encryptedValue(var_.some_encrypted_secret_string())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_github as github
    
    example_public_key = github.get_actions_public_key(repository="example_repository")
    example_secret_actions_secret = github.ActionsSecret("exampleSecretActionsSecret",
        repository="example_repository",
        secret_name="example_secret_name",
        plaintext_value=var["some_secret_string"])
    example_secret_index_actions_secret_actions_secret = github.ActionsSecret("exampleSecretIndex/actionsSecretActionsSecret",
        repository="example_repository",
        secret_name="example_secret_name",
        encrypted_value=var["some_encrypted_secret_string"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const examplePublicKey = github.getActionsPublicKey({
        repository: "example_repository",
    });
    const exampleSecretActionsSecret = new github.ActionsSecret("exampleSecretActionsSecret", {
        repository: "example_repository",
        secretName: "example_secret_name",
        plaintextValue: _var.some_secret_string,
    });
    const exampleSecretIndex_actionsSecretActionsSecret = new github.ActionsSecret("exampleSecretIndex/actionsSecretActionsSecret", {
        repository: "example_repository",
        secretName: "example_secret_name",
        encryptedValue: _var.some_encrypted_secret_string,
    });
    
    resources:
      exampleSecretActionsSecret:
        type: github:ActionsSecret
        properties:
          repository: example_repository
          secretName: example_secret_name
          plaintextValue: ${var.some_secret_string}
      exampleSecretIndex/actionsSecretActionsSecret:
        type: github:ActionsSecret
        properties:
          repository: example_repository
          secretName: example_secret_name
          encryptedValue: ${var.some_encrypted_secret_string}
    variables:
      examplePublicKey:
        fn::invoke:
          Function: github:getActionsPublicKey
          Arguments:
            repository: example_repository
    

    Create ActionsSecret Resource

    new ActionsSecret(name: string, args: ActionsSecretArgs, opts?: CustomResourceOptions);
    @overload
    def ActionsSecret(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      encrypted_value: Optional[str] = None,
                      plaintext_value: Optional[str] = None,
                      repository: Optional[str] = None,
                      secret_name: Optional[str] = None)
    @overload
    def ActionsSecret(resource_name: str,
                      args: ActionsSecretArgs,
                      opts: Optional[ResourceOptions] = None)
    func NewActionsSecret(ctx *Context, name string, args ActionsSecretArgs, opts ...ResourceOption) (*ActionsSecret, error)
    public ActionsSecret(string name, ActionsSecretArgs args, CustomResourceOptions? opts = null)
    public ActionsSecret(String name, ActionsSecretArgs args)
    public ActionsSecret(String name, ActionsSecretArgs args, CustomResourceOptions options)
    
    type: github:ActionsSecret
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ActionsSecretArgs
    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 ActionsSecretArgs
    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 ActionsSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionsSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionsSecretArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ActionsSecret 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 ActionsSecret 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 ActionsSecret resource produces the following output properties:

    CreatedAt string

    Date of actions_secret creation.

    Id string

    The provider-assigned unique ID for this managed resource.

    UpdatedAt string

    Date of actions_secret update.

    CreatedAt string

    Date of actions_secret creation.

    Id string

    The provider-assigned unique ID for this managed resource.

    UpdatedAt string

    Date of actions_secret update.

    createdAt String

    Date of actions_secret creation.

    id String

    The provider-assigned unique ID for this managed resource.

    updatedAt String

    Date of actions_secret update.

    createdAt string

    Date of actions_secret creation.

    id string

    The provider-assigned unique ID for this managed resource.

    updatedAt string

    Date of actions_secret update.

    created_at str

    Date of actions_secret creation.

    id str

    The provider-assigned unique ID for this managed resource.

    updated_at str

    Date of actions_secret update.

    createdAt String

    Date of actions_secret creation.

    id String

    The provider-assigned unique ID for this managed resource.

    updatedAt String

    Date of actions_secret update.

    Look up Existing ActionsSecret Resource

    Get an existing ActionsSecret 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?: ActionsSecretState, opts?: CustomResourceOptions): ActionsSecret
    @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) -> ActionsSecret
    func GetActionsSecret(ctx *Context, name string, id IDInput, state *ActionsSecretState, opts ...ResourceOption) (*ActionsSecret, error)
    public static ActionsSecret Get(string name, Input<string> id, ActionsSecretState? state, CustomResourceOptions? opts = null)
    public static ActionsSecret get(String name, Output<String> id, ActionsSecretState 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 actions_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 actions_secret update.

    CreatedAt string

    Date of actions_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 actions_secret update.

    createdAt String

    Date of actions_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 actions_secret update.

    createdAt string

    Date of actions_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 actions_secret update.

    created_at str

    Date of actions_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 actions_secret update.

    createdAt String

    Date of actions_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 actions_secret update.

    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 v5.19.0 published on Friday, Sep 22, 2023 by Pulumi