@formalco/pulumi
Version:
A Pulumi package for creating and managing Formal resources.
122 lines (121 loc) • 4.64 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Registering a Connector Hostname with Formal.
*/
export declare class ConnectorHostname extends pulumi.CustomResource {
/**
* Get an existing ConnectorHostname 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?: ConnectorHostnameState, opts?: pulumi.CustomResourceOptions): ConnectorHostname;
/**
* Returns true if the given object is an instance of ConnectorHostname. 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 ConnectorHostname;
/**
* The ID of the Connector this hostname is linked to.
*/
readonly connectorId: pulumi.Output<string>;
/**
* The DNS record for this hostname.
*/
readonly dnsRecord: pulumi.Output<string | undefined>;
/**
* The status of the DNS record for this hostname. Accepted values are `none`, `pending`, `success` and `failed`.
*/
readonly dnsRecordStatus: pulumi.Output<string>;
/**
* The hostname for this Connector hostname.
*/
readonly hostname: pulumi.Output<string>;
/**
* Deprecated: If set to true, Formal will manage the TLS certificate for this hostname.
*
* @deprecated This field is deprecated and has no effect. It will be removed in a future release.
*/
readonly managedTls: pulumi.Output<boolean | undefined>;
/**
* If set to true, this connector hostname cannot be deleted.
*/
readonly terminationProtection: pulumi.Output<boolean | undefined>;
/**
* The status of the TLS certificate for this hostname. Accepted values are `none`, `issuing`, and `issued`.
*/
readonly tlsCertificateStatus: pulumi.Output<string>;
/**
* Create a ConnectorHostname 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: ConnectorHostnameArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConnectorHostname resources.
*/
export interface ConnectorHostnameState {
/**
* The ID of the Connector this hostname is linked to.
*/
connectorId?: pulumi.Input<string>;
/**
* The DNS record for this hostname.
*/
dnsRecord?: pulumi.Input<string>;
/**
* The status of the DNS record for this hostname. Accepted values are `none`, `pending`, `success` and `failed`.
*/
dnsRecordStatus?: pulumi.Input<string>;
/**
* The hostname for this Connector hostname.
*/
hostname?: pulumi.Input<string>;
/**
* Deprecated: If set to true, Formal will manage the TLS certificate for this hostname.
*
* @deprecated This field is deprecated and has no effect. It will be removed in a future release.
*/
managedTls?: pulumi.Input<boolean>;
/**
* If set to true, this connector hostname cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* The status of the TLS certificate for this hostname. Accepted values are `none`, `issuing`, and `issued`.
*/
tlsCertificateStatus?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ConnectorHostname resource.
*/
export interface ConnectorHostnameArgs {
/**
* The ID of the Connector this hostname is linked to.
*/
connectorId: pulumi.Input<string>;
/**
* The DNS record for this hostname.
*/
dnsRecord?: pulumi.Input<string>;
/**
* The hostname for this Connector hostname.
*/
hostname: pulumi.Input<string>;
/**
* Deprecated: If set to true, Formal will manage the TLS certificate for this hostname.
*
* @deprecated This field is deprecated and has no effect. It will be removed in a future release.
*/
managedTls?: pulumi.Input<boolean>;
/**
* If set to true, this connector hostname cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
}