@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
201 lines • 7.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new Google SQL SSL Cert on a Google SQL Instance. For more information, see the [official documentation](https://cloud.google.com/sql/), or the [JSON API](https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/sslCerts).
*
* Read more about sensitive data in state.
*
* ## Example Usage
*
* Example creating a SQL Client Certificate.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as random from "@pulumi/random";
*
* const dbNameSuffix = new random.index.Id("db_name_suffix", {byteLength: 4});
* const main = new gcp.sql.DatabaseInstance("main", {
* name: `main-instance-${dbNameSuffix.hex}`,
* databaseVersion: "MYSQL_5_7",
* settings: {
* tier: "db-f1-micro",
* },
* });
* const clientCert = new gcp.sql.SslCert("client_cert", {
* commonName: "client-name",
* instance: main.name,
* });
* ```
*
* ## Import
*
* Since the contents of the certificate cannot be accessed after its creation, this resource cannot be imported.
*/
export declare class SslCert extends pulumi.CustomResource {
/**
* Get an existing SslCert 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?: SslCertState, opts?: pulumi.CustomResourceOptions): SslCert;
/**
* Returns true if the given object is an instance of SslCert. 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 SslCert;
/**
* The actual certificate data for this client certificate.
*/
readonly cert: pulumi.Output<string>;
/**
* The serial number extracted from the certificate data.
*/
readonly certSerialNumber: pulumi.Output<string>;
/**
* The common name to be used in the certificate to identify the
* client. Constrained to [a-zA-Z.-_ ]+. Changing this forces a new resource to be created.
*/
readonly commonName: pulumi.Output<string>;
/**
* The time when the certificate was created in RFC 3339 format,
* for example 2012-11-15T16:19:00.094Z.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The time when the certificate expires in RFC 3339 format,
* for example 2012-11-15T16:19:00.094Z.
*/
readonly expirationTime: pulumi.Output<string>;
/**
* The name of the Cloud SQL instance. Changing this
* forces a new resource to be created.
*/
readonly instance: pulumi.Output<string>;
/**
* The private key associated with the client certificate.
*/
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 CA cert of the server this client cert was generated from.
*/
readonly serverCaCert: pulumi.Output<string>;
/**
* The SHA1 Fingerprint of the certificate.
*/
readonly sha1Fingerprint: pulumi.Output<string>;
/**
* Create a SslCert 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: SslCertArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SslCert resources.
*/
export interface SslCertState {
/**
* The actual certificate data for this client certificate.
*/
cert?: pulumi.Input<string | undefined>;
/**
* The serial number extracted from the certificate data.
*/
certSerialNumber?: pulumi.Input<string | undefined>;
/**
* The common name to be used in the certificate to identify the
* client. Constrained to [a-zA-Z.-_ ]+. Changing this forces a new resource to be created.
*/
commonName?: pulumi.Input<string | undefined>;
/**
* The time when the certificate was created in RFC 3339 format,
* for example 2012-11-15T16:19:00.094Z.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The time when the certificate expires in RFC 3339 format,
* for example 2012-11-15T16:19:00.094Z.
*/
expirationTime?: pulumi.Input<string | undefined>;
/**
* The name of the Cloud SQL instance. Changing this
* forces a new resource to be created.
*/
instance?: pulumi.Input<string | undefined>;
/**
* The private key associated with the client certificate.
*/
privateKey?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The CA cert of the server this client cert was generated from.
*/
serverCaCert?: pulumi.Input<string | undefined>;
/**
* The SHA1 Fingerprint of the certificate.
*/
sha1Fingerprint?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SslCert resource.
*/
export interface SslCertArgs {
/**
* The common name to be used in the certificate to identify the
* client. Constrained to [a-zA-Z.-_ ]+. Changing this forces a new resource to be created.
*/
commonName: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The name of the Cloud SQL instance. Changing this
* forces a new resource to be created.
*/
instance: 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 | undefined>;
}
//# sourceMappingURL=sslCert.d.ts.map