@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
183 lines • 6.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DNSimple Let's Encrypt certificate resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* const example = new dnsimple.LetsEncryptCertificate("example", {
* domainId: "example.com",
* name: "www",
* autoRenew: true,
* alternateNames: [
* "docs.example.com",
* "status.example.com",
* ],
* });
* ```
*
* ## Import
*
* DNSimple Let's Encrypt certificates can be imported using the domain name and certificate ID in the format `domainNameCertificateId`.
*
* ```sh
* $ pulumi import dnsimple:index/letsEncryptCertificate:LetsEncryptCertificate example example.com_1234
* ```
*
* The certificate ID can be found via the [DNSimple Certificates API](https://developer.dnsimple.com/v2/certificates/#listCertificates).
*/
export declare class LetsEncryptCertificate extends pulumi.CustomResource {
/**
* Get an existing LetsEncryptCertificate 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?: LetsEncryptCertificateState, opts?: pulumi.CustomResourceOptions): LetsEncryptCertificate;
/**
* Returns true if the given object is an instance of LetsEncryptCertificate. 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 LetsEncryptCertificate;
/**
* List of alternate names (SANs) for the certificate.
*/
readonly alternateNames: pulumi.Output<string[] | undefined>;
/**
* The identifying certification authority (CA).
*/
readonly authorityIdentifier: pulumi.Output<string>;
/**
* Whether the certificate should auto-renew.
*/
readonly autoRenew: pulumi.Output<boolean>;
/**
* The datetime when the certificate was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The certificate signing request.
*/
readonly csr: pulumi.Output<string>;
/**
* The domain name or ID to issue the certificate for.
*/
readonly domainId: pulumi.Output<string>;
/**
* The datetime when the certificate will expire.
*/
readonly expiresAt: pulumi.Output<string>;
/**
* The certificate name; use `""` for the root domain. Wildcard names are supported.
*/
readonly name: pulumi.Output<string>;
/**
* The signature algorithm to use for the certificate.
*/
readonly signatureAlgorithm: pulumi.Output<string | undefined>;
/**
* The state of the certificate.
*/
readonly state: pulumi.Output<string>;
/**
* The datetime when the certificate was last updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The number of years the certificate will last.
*/
readonly years: pulumi.Output<number>;
/**
* Create a LetsEncryptCertificate 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: LetsEncryptCertificateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LetsEncryptCertificate resources.
*/
export interface LetsEncryptCertificateState {
/**
* List of alternate names (SANs) for the certificate.
*/
alternateNames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The identifying certification authority (CA).
*/
authorityIdentifier?: pulumi.Input<string | undefined>;
/**
* Whether the certificate should auto-renew.
*/
autoRenew?: pulumi.Input<boolean | undefined>;
/**
* The datetime when the certificate was created.
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The certificate signing request.
*/
csr?: pulumi.Input<string | undefined>;
/**
* The domain name or ID to issue the certificate for.
*/
domainId?: pulumi.Input<string | undefined>;
/**
* The datetime when the certificate will expire.
*/
expiresAt?: pulumi.Input<string | undefined>;
/**
* The certificate name; use `""` for the root domain. Wildcard names are supported.
*/
name?: pulumi.Input<string | undefined>;
/**
* The signature algorithm to use for the certificate.
*/
signatureAlgorithm?: pulumi.Input<string | undefined>;
/**
* The state of the certificate.
*/
state?: pulumi.Input<string | undefined>;
/**
* The datetime when the certificate was last updated.
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* The number of years the certificate will last.
*/
years?: pulumi.Input<number | undefined>;
}
/**
* The set of arguments for constructing a LetsEncryptCertificate resource.
*/
export interface LetsEncryptCertificateArgs {
/**
* List of alternate names (SANs) for the certificate.
*/
alternateNames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Whether the certificate should auto-renew.
*/
autoRenew: pulumi.Input<boolean>;
/**
* The domain name or ID to issue the certificate for.
*/
domainId: pulumi.Input<string>;
/**
* The certificate name; use `""` for the root domain. Wildcard names are supported.
*/
name: pulumi.Input<string>;
/**
* The signature algorithm to use for the certificate.
*/
signatureAlgorithm?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=letsEncryptCertificate.d.ts.map