@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
235 lines (234 loc) • 9.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An SslCertificate resource, used for HTTPS load balancing. This resource
* provides a mechanism to upload an SSL key and certificate to
* the load balancer to serve secure connections from the user.
*
* To get more information about SslCertificate, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/sslCertificates)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/load-balancing/docs/ssl-certificates)
*
* ## Example Usage
*
* ## Import
*
* SslCertificate can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/sslCertificates/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, SslCertificate can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/sSLCertificate:SSLCertificate default projects/{{project}}/global/sslCertificates/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/sSLCertificate:SSLCertificate default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/sSLCertificate:SSLCertificate default {{name}}
* ```
*/
export declare class SSLCertificate extends pulumi.CustomResource {
/**
* Get an existing SSLCertificate 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?: SSLCertificateState, opts?: pulumi.CustomResourceOptions): SSLCertificate;
/**
* Returns true if the given object is an instance of SSLCertificate. 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 SSLCertificate;
/**
* The certificate in PEM format.
* The certificate chain must be no greater than 5 certs long.
* The chain must include at least one intermediate cert.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
readonly certificate: pulumi.Output<string>;
/**
* The unique identifier for the resource.
*/
readonly certificateId: pulumi.Output<number>;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Expire time of the certificate in RFC3339 text format.
*/
readonly expireTime: pulumi.Output<string>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and match
* the regular expression `a-z?` which means the
* first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the last
* character, which cannot be a dash.
* These are in the same namespace as the managed SSL certificates.
*/
readonly name: pulumi.Output<string>;
/**
* Creates a unique name beginning with the
* specified prefix. Conflicts with `name`. Max length is 54 characters.
* Prefixes with lengths longer than 37 characters will use a shortened
* UUID that will be more prone to collisions.
* Resulting name for a `namePrefix` <= 37 characters:
* `namePrefix` + YYYYmmddHHSSssss + 8 digit incremental counter
* Resulting name for a `namePrefix` 38 - 54 characters:
* `namePrefix` + YYmmdd + 3 digit incremental counter
*/
readonly namePrefix: pulumi.Output<string>;
/**
* The write-only private key in PEM format.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
readonly privateKey: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Create a SSLCertificate 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: SSLCertificateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SSLCertificate resources.
*/
export interface SSLCertificateState {
/**
* The certificate in PEM format.
* The certificate chain must be no greater than 5 certs long.
* The chain must include at least one intermediate cert.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
certificate?: pulumi.Input<string>;
/**
* The unique identifier for the resource.
*/
certificateId?: pulumi.Input<number>;
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* Expire time of the certificate in RFC3339 text format.
*/
expireTime?: pulumi.Input<string>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and match
* the regular expression `a-z?` which means the
* first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the last
* character, which cannot be a dash.
* These are in the same namespace as the managed SSL certificates.
*/
name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the
* specified prefix. Conflicts with `name`. Max length is 54 characters.
* Prefixes with lengths longer than 37 characters will use a shortened
* UUID that will be more prone to collisions.
* Resulting name for a `namePrefix` <= 37 characters:
* `namePrefix` + YYYYmmddHHSSssss + 8 digit incremental counter
* Resulting name for a `namePrefix` 38 - 54 characters:
* `namePrefix` + YYmmdd + 3 digit incremental counter
*/
namePrefix?: pulumi.Input<string>;
/**
* The write-only private key in PEM format.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
privateKey?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SSLCertificate resource.
*/
export interface SSLCertificateArgs {
/**
* The certificate in PEM format.
* The certificate chain must be no greater than 5 certs long.
* The chain must include at least one intermediate cert.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
certificate: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and match
* the regular expression `a-z?` which means the
* first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the last
* character, which cannot be a dash.
* These are in the same namespace as the managed SSL certificates.
*/
name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the
* specified prefix. Conflicts with `name`. Max length is 54 characters.
* Prefixes with lengths longer than 37 characters will use a shortened
* UUID that will be more prone to collisions.
* Resulting name for a `namePrefix` <= 37 characters:
* `namePrefix` + YYYYmmddHHSSssss + 8 digit incremental counter
* Resulting name for a `namePrefix` 38 - 54 characters:
* `namePrefix` + YYmmdd + 3 digit incremental counter
*/
namePrefix?: pulumi.Input<string>;
/**
* The write-only private key in PEM format.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
privateKey: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}