@pulumi/github
Version:
A Pulumi package for creating and managing github cloud resources.
131 lines (130 loc) • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ## Import
*
* This resource can be imported using an ID made up of the secret name:
*
* ```sh
* $ pulumi import github:index/codespacesOrganizationSecret:CodespacesOrganizationSecret test_secret test_secret_name
* ```
*
* 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.
*/
export declare class CodespacesOrganizationSecret extends pulumi.CustomResource {
/**
* Get an existing CodespacesOrganizationSecret resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CodespacesOrganizationSecretState, opts?: pulumi.CustomResourceOptions): CodespacesOrganizationSecret;
/**
* Returns true if the given object is an instance of CodespacesOrganizationSecret. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CodespacesOrganizationSecret;
/**
* Date of codespacesSecret creation.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Encrypted value of the secret using the GitHub public key in Base64 format.
*/
readonly encryptedValue: pulumi.Output<string | undefined>;
/**
* Plaintext value of the secret to be encrypted
*/
readonly plaintextValue: pulumi.Output<string | undefined>;
/**
* Name of the secret
*/
readonly secretName: pulumi.Output<string>;
/**
* An array of repository ids that can access the organization secret.
*/
readonly selectedRepositoryIds: pulumi.Output<number[] | undefined>;
/**
* Date of codespacesSecret update.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Configures the access that repositories have to the organization secret.
* Must be one of `all`, `private`, `selected`. `selectedRepositoryIds` is required if set to `selected`.
*/
readonly visibility: pulumi.Output<string>;
/**
* Create a CodespacesOrganizationSecret resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CodespacesOrganizationSecretArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CodespacesOrganizationSecret resources.
*/
export interface CodespacesOrganizationSecretState {
/**
* Date of codespacesSecret creation.
*/
createdAt?: pulumi.Input<string>;
/**
* Encrypted value of the secret using the GitHub public key in Base64 format.
*/
encryptedValue?: pulumi.Input<string>;
/**
* Plaintext value of the secret to be encrypted
*/
plaintextValue?: pulumi.Input<string>;
/**
* Name of the secret
*/
secretName?: pulumi.Input<string>;
/**
* An array of repository ids that can access the organization secret.
*/
selectedRepositoryIds?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Date of codespacesSecret update.
*/
updatedAt?: pulumi.Input<string>;
/**
* Configures the access that repositories have to the organization secret.
* Must be one of `all`, `private`, `selected`. `selectedRepositoryIds` is required if set to `selected`.
*/
visibility?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CodespacesOrganizationSecret resource.
*/
export interface CodespacesOrganizationSecretArgs {
/**
* Encrypted value of the secret using the GitHub public key in Base64 format.
*/
encryptedValue?: pulumi.Input<string>;
/**
* Plaintext value of the secret to be encrypted
*/
plaintextValue?: pulumi.Input<string>;
/**
* Name of the secret
*/
secretName: pulumi.Input<string>;
/**
* An array of repository ids that can access the organization secret.
*/
selectedRepositoryIds?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Configures the access that repositories have to the organization secret.
* Must be one of `all`, `private`, `selected`. `selectedRepositoryIds` is required if set to `selected`.
*/
visibility: pulumi.Input<string>;
}