UNPKG

@pulumi/kong

Version:

A Pulumi package for creating and managing Kong resources.

106 lines (105 loc) 3.94 kB
import * as pulumi from "@pulumi/pulumi"; /** * ## # kong.Certificate * * For more information on creating certificates in Kong [see their documentation](https://docs.konghq.com/gateway-oss/2.5.x/admin-api/#certificate-object) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as kong from "@pulumi/kong"; * * const certificate = new kong.Certificate("certificate", { * certificate: "public key --- 123 ----", * privateKey: "private key --- 456 ----", * snis: [ * "foo.com", * "bar.com", * ], * tags: ["myTag"], * }); * ``` * * ## Import * * To import a certificate: * * ```sh * $ pulumi import kong:index/certificate:Certificate <certifcate_identifier> <certificate_id> * ``` */ export declare class Certificate extends pulumi.CustomResource { /** * Get an existing Certificate 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?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate; /** * Returns true if the given object is an instance of Certificate. 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 Certificate; /** * should be the public key of your certificate it is mapped to the `Cert` parameter on the Kong API. */ readonly certificate: pulumi.Output<string>; /** * should be the private key of your certificate it is mapped to the `Key` parameter on the Kong API. */ readonly privateKey: pulumi.Output<string | undefined>; /** * A list of strings associated with the Certificate for grouping and filtering */ readonly snis: pulumi.Output<string[] | undefined>; readonly tags: pulumi.Output<string[] | undefined>; /** * Create a Certificate 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: CertificateArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Certificate resources. */ export interface CertificateState { /** * should be the public key of your certificate it is mapped to the `Cert` parameter on the Kong API. */ certificate?: pulumi.Input<string>; /** * should be the private key of your certificate it is mapped to the `Key` parameter on the Kong API. */ privateKey?: pulumi.Input<string>; /** * A list of strings associated with the Certificate for grouping and filtering */ snis?: pulumi.Input<pulumi.Input<string>[]>; tags?: pulumi.Input<pulumi.Input<string>[]>; } /** * The set of arguments for constructing a Certificate resource. */ export interface CertificateArgs { /** * should be the public key of your certificate it is mapped to the `Cert` parameter on the Kong API. */ certificate: pulumi.Input<string>; /** * should be the private key of your certificate it is mapped to the `Key` parameter on the Kong API. */ privateKey?: pulumi.Input<string>; /** * A list of strings associated with the Certificate for grouping and filtering */ snis?: pulumi.Input<pulumi.Input<string>[]>; tags?: pulumi.Input<pulumi.Input<string>[]>; }