Docs
Packagesgcp.compute.SSLCertificate
Explore with Pulumi AI
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
- How-to Guides
Example Usage
Create SSLCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SSLCertificate(name: string, args: SSLCertificateArgs, opts?: CustomResourceOptions);@overload
def SSLCertificate(resource_name: str,
args: SSLCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SSLCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
private_key: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
project: Optional[str] = None)func NewSSLCertificate(ctx *Context, name string, args SSLCertificateArgs, opts ...ResourceOption) (*SSLCertificate, error)public SSLCertificate(string name, SSLCertificateArgs args, CustomResourceOptions? opts = null)
public SSLCertificate(String name, SSLCertificateArgs args)
public SSLCertificate(String name, SSLCertificateArgs args, CustomResourceOptions options)
type: gcp:compute:SSLCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SSLCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SSLCertificateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SSLCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SSLCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SSLCertificateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var sslcertificateResource = new Gcp.Compute.SSLCertificate("sslcertificateResource", new()
{
Certificate = "string",
PrivateKey = "string",
Description = "string",
Name = "string",
NamePrefix = "string",
Project = "string",
});
example, err := compute.NewSSLCertificate(ctx, "sslcertificateResource", &compute.SSLCertificateArgs{
Certificate: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
NamePrefix: pulumi.String("string"),
Project: pulumi.String("string"),
})
var sslcertificateResource = new SSLCertificate("sslcertificateResource", SSLCertificateArgs.builder()
.certificate("string")
.privateKey("string")
.description("string")
.name("string")
.namePrefix("string")
.project("string")
.build());
sslcertificate_resource = gcp.compute.SSLCertificate("sslcertificateResource",
certificate="string",
private_key="string",
description="string",
name="string",
name_prefix="string",
project="string")
const sslcertificateResource = new gcp.compute.SSLCertificate("sslcertificateResource", {
certificate: "string",
privateKey: "string",
description: "string",
name: "string",
namePrefix: "string",
project: "string",
});
type: gcp:compute:SSLCertificate
properties:
certificate: string
description: string
name: string
namePrefix: string
privateKey: string
project: string
SSLCertificate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SSLCertificate resource accepts the following input properties:
- Certificate string
- 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.
- Private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- Description string
- An optional description of this resource.
- Name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Certificate string
- 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.
- Private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- Description string
- An optional description of this resource.
- Name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- certificate String
- 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.
- private
Key String - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- description String
- An optional description of this resource.
- name 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
Prefix String - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- certificate string
- 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.
- private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- description string
- An optional description of this resource.
- name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- certificate str
- 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.
- private_
key str - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- description str
- An optional description of this resource.
- name str
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_
prefix str - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- certificate String
- 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.
- private
Key String - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- description String
- An optional description of this resource.
- name 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
Prefix String - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the SSLCertificate resource produces the following output properties:
- Certificate
Id int - The unique identifier for the resource.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Expire
Time string - Expire time of the certificate in RFC3339 text format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Self
Link string - The URI of the created resource.
- Certificate
Id int - The unique identifier for the resource.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Expire
Time string - Expire time of the certificate in RFC3339 text format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Self
Link string - The URI of the created resource.
- certificate
Id Integer - The unique identifier for the resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- expire
Time String - Expire time of the certificate in RFC3339 text format.
- id String
- The provider-assigned unique ID for this managed resource.
- self
Link String - The URI of the created resource.
- certificate
Id number - The unique identifier for the resource.
- creation
Timestamp string - Creation timestamp in RFC3339 text format.
- expire
Time string - Expire time of the certificate in RFC3339 text format.
- id string
- The provider-assigned unique ID for this managed resource.
- self
Link string - The URI of the created resource.
- certificate_
id int - The unique identifier for the resource.
- creation_
timestamp str - Creation timestamp in RFC3339 text format.
- expire_
time str - Expire time of the certificate in RFC3339 text format.
- id str
- The provider-assigned unique ID for this managed resource.
- self_
link str - The URI of the created resource.
- certificate
Id Number - The unique identifier for the resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- expire
Time String - Expire time of the certificate in RFC3339 text format.
- id String
- The provider-assigned unique ID for this managed resource.
- self
Link String - The URI of the created resource.
Look up Existing SSLCertificate Resource
Get an existing SSLCertificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SSLCertificateState, opts?: CustomResourceOptions): SSLCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
certificate_id: Optional[int] = None,
creation_timestamp: Optional[str] = None,
description: Optional[str] = None,
expire_time: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
private_key: Optional[str] = None,
project: Optional[str] = None,
self_link: Optional[str] = None) -> SSLCertificatefunc GetSSLCertificate(ctx *Context, name string, id IDInput, state *SSLCertificateState, opts ...ResourceOption) (*SSLCertificate, error)public static SSLCertificate Get(string name, Input<string> id, SSLCertificateState? state, CustomResourceOptions? opts = null)public static SSLCertificate get(String name, Output<String> id, SSLCertificateState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Certificate string
- 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
Id int - The unique identifier for the resource.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Description string
- An optional description of this resource.
- Expire
Time string - Expire time of the certificate in RFC3339 text format.
- Name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - Private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Self
Link string - The URI of the created resource.
- Certificate string
- 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
Id int - The unique identifier for the resource.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Description string
- An optional description of this resource.
- Expire
Time string - Expire time of the certificate in RFC3339 text format.
- Name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - Private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Self
Link string - The URI of the created resource.
- certificate String
- 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
Id Integer - The unique identifier for the resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- description String
- An optional description of this resource.
- expire
Time String - Expire time of the certificate in RFC3339 text format.
- name 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
Prefix String - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - private
Key String - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link String - The URI of the created resource.
- certificate string
- 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
Id number - The unique identifier for the resource.
- creation
Timestamp string - Creation timestamp in RFC3339 text format.
- description string
- An optional description of this resource.
- expire
Time string - Expire time of the certificate in RFC3339 text format.
- name 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
Prefix string - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - private
Key string - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link string - The URI of the created resource.
- certificate str
- 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_
id int - The unique identifier for the resource.
- creation_
timestamp str - Creation timestamp in RFC3339 text format.
- description str
- An optional description of this resource.
- expire_
time str - Expire time of the certificate in RFC3339 text format.
- name str
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_
prefix str - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - private_
key str - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self_
link str - The URI of the created resource.
- certificate String
- 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
Id Number - The unique identifier for the resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- description String
- An optional description of this resource.
- expire
Time String - Expire time of the certificate in RFC3339 text format.
- name 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
Prefix String - Creates a unique name beginning with the
specified prefix. Conflicts with
name. - private
Key String - The write-only private key in PEM format.
Note: This property is sensitive and will not be displayed in the plan.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link String - The URI of the created resource.
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:
$ pulumi import gcp:compute/sSLCertificate:SSLCertificate default projects/{{project}}/global/sslCertificates/{{name}}
$ pulumi import gcp:compute/sSLCertificate:SSLCertificate default {{project}}/{{name}}
$ pulumi import gcp:compute/sSLCertificate:SSLCertificate default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.