1. Packages
  2. Github Provider
  3. API Docs
  4. ActionsEnvironmentSecret
GitHub v6.4.0 published on Thursday, Nov 21, 2024 by Pulumi

github.ActionsEnvironmentSecret

Explore with Pulumi AI

github logo
GitHub v6.4.0 published on Thursday, Nov 21, 2024 by Pulumi

    Example Usage

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

    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",
        EncryptedValue = "string",
        PlaintextValue = "string",
    });
    
    example, err := github.NewActionsEnvironmentSecret(ctx, "actionsEnvironmentSecretResource", &github.ActionsEnvironmentSecretArgs{
    	Environment:    pulumi.String("string"),
    	Repository:     pulumi.String("string"),
    	SecretName:     pulumi.String("string"),
    	EncryptedValue: pulumi.String("string"),
    	PlaintextValue: pulumi.String("string"),
    })
    
    var actionsEnvironmentSecretResource = new ActionsEnvironmentSecret("actionsEnvironmentSecretResource", ActionsEnvironmentSecretArgs.builder()
        .environment("string")
        .repository("string")
        .secretName("string")
        .encryptedValue("string")
        .plaintextValue("string")
        .build());
    
    actions_environment_secret_resource = github.ActionsEnvironmentSecret("actionsEnvironmentSecretResource",
        environment="string",
        repository="string",
        secret_name="string",
        encrypted_value="string",
        plaintext_value="string")
    
    const actionsEnvironmentSecretResource = new github.ActionsEnvironmentSecret("actionsEnvironmentSecretResource", {
        environment: "string",
        repository: "string",
        secretName: "string",
        encryptedValue: "string",
        plaintextValue: "string",
    });
    
    type: github:ActionsEnvironmentSecret
    properties:
        encryptedValue: string
        environment: string
        plaintextValue: string
        repository: string
        secretName: 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
    Encrypted value of the secret using the GitHub public key in Base64 format.
    PlaintextValue string
    Plaintext value of the secret to be encrypted.
    Environment string
    Name of the environment.
    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.
    environment String
    Name of the environment.
    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.
    environment string
    Name of the environment.
    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.
    environment str
    Name of the environment.
    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.
    environment String
    Name of the environment.
    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 ActionsEnvironmentSecret resource produces the following output properties:

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

    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,
            plaintext_value: Optional[str] = None,
            repository: Optional[str] = None,
            secret_name: Optional[str] = None,
            updated_at: 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)
    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_environment_secret creation.
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    Environment string
    Name of the environment.
    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_environment_secret update.
    CreatedAt string
    Date of actions_environment_secret creation.
    EncryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    Environment string
    Name of the environment.
    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_environment_secret update.
    createdAt String
    Date of actions_environment_secret creation.
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    environment String
    Name of the environment.
    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_environment_secret update.
    createdAt string
    Date of actions_environment_secret creation.
    encryptedValue string
    Encrypted value of the secret using the GitHub public key in Base64 format.
    environment string
    Name of the environment.
    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_environment_secret update.
    created_at str
    Date of actions_environment_secret creation.
    encrypted_value str
    Encrypted value of the secret using the GitHub public key in Base64 format.
    environment str
    Name of the environment.
    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_environment_secret update.
    createdAt String
    Date of actions_environment_secret creation.
    encryptedValue String
    Encrypted value of the secret using the GitHub public key in Base64 format.
    environment String
    Name of the environment.
    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_environment_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 v6.4.0 published on Thursday, Nov 21, 2024 by Pulumi