@pulumi/github
Version:
A Pulumi package for creating and managing github cloud resources.
70 lines (69 loc) • 2.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to retrieve information about a GitHub Codespaces public key. This data source is required to be used with other GitHub secrets interactions.
* Note that the provider `token` must have admin rights to a repository to retrieve it's Codespaces public key.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const example = github.getCodespacesPublicKey({
* repository: "example_repo",
* });
* ```
*/
export declare function getCodespacesPublicKey(args: GetCodespacesPublicKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetCodespacesPublicKeyResult>;
/**
* A collection of arguments for invoking getCodespacesPublicKey.
*/
export interface GetCodespacesPublicKeyArgs {
/**
* Name of the repository to get public key from.
*/
repository: string;
}
/**
* A collection of values returned by getCodespacesPublicKey.
*/
export interface GetCodespacesPublicKeyResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Actual key retrieved.
*/
readonly key: string;
/**
* ID of the key that has been retrieved.
*/
readonly keyId: string;
readonly repository: string;
}
/**
* Use this data source to retrieve information about a GitHub Codespaces public key. This data source is required to be used with other GitHub secrets interactions.
* Note that the provider `token` must have admin rights to a repository to retrieve it's Codespaces public key.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const example = github.getCodespacesPublicKey({
* repository: "example_repo",
* });
* ```
*/
export declare function getCodespacesPublicKeyOutput(args: GetCodespacesPublicKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCodespacesPublicKeyResult>;
/**
* A collection of arguments for invoking getCodespacesPublicKey.
*/
export interface GetCodespacesPublicKeyOutputArgs {
/**
* Name of the repository to get public key from.
*/
repository: pulumi.Input<string>;
}