Docs Home
Vercel v3.15.1 published on Monday, Sep 8, 2025 by Pulumiverse
vercel.CustomCertificate
Explore with Pulumi AI
Provides a Custom Certificate Resource, allowing Custom Certificates to be uploaded to Vercel.
By default, Vercel provides all domains with a custom SSL certificates. However, Enterprise teams can upload their own custom SSL certificate.
For more detailed information, please see the Vercel documentation.
Create CustomCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomCertificate(name: string, args: CustomCertificateArgs, opts?: CustomResourceOptions);@overload
def CustomCertificate(resource_name: str,
args: CustomCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
certificate_authority_certificate: Optional[str] = None,
private_key: Optional[str] = None,
team_id: Optional[str] = None)func NewCustomCertificate(ctx *Context, name string, args CustomCertificateArgs, opts ...ResourceOption) (*CustomCertificate, error)public CustomCertificate(string name, CustomCertificateArgs args, CustomResourceOptions? opts = null)
public CustomCertificate(String name, CustomCertificateArgs args)
public CustomCertificate(String name, CustomCertificateArgs args, CustomResourceOptions options)
type: vercel:CustomCertificate
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 CustomCertificateArgs
- 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 CustomCertificateArgs
- 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 CustomCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomCertificateArgs
- 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 customCertificateResource = new Vercel.CustomCertificate("customCertificateResource", new()
{
Certificate = "string",
CertificateAuthorityCertificate = "string",
PrivateKey = "string",
TeamId = "string",
});
example, err := vercel.NewCustomCertificate(ctx, "customCertificateResource", &vercel.CustomCertificateArgs{
Certificate: pulumi.String("string"),
CertificateAuthorityCertificate: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
TeamId: pulumi.String("string"),
})
var customCertificateResource = new CustomCertificate("customCertificateResource", CustomCertificateArgs.builder()
.certificate("string")
.certificateAuthorityCertificate("string")
.privateKey("string")
.teamId("string")
.build());
custom_certificate_resource = vercel.CustomCertificate("customCertificateResource",
certificate="string",
certificate_authority_certificate="string",
private_key="string",
team_id="string")
const customCertificateResource = new vercel.CustomCertificate("customCertificateResource", {
certificate: "string",
certificateAuthorityCertificate: "string",
privateKey: "string",
teamId: "string",
});
type: vercel:CustomCertificate
properties:
certificate: string
certificateAuthorityCertificate: string
privateKey: string
teamId: string
CustomCertificate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CustomCertificate resource accepts the following input properties:
- Certificate string
- The certificate itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- Private
Key string - The private key of the Certificate. Should be in PEM format.
- Team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- Certificate string
- The certificate itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- Private
Key string - The private key of the Certificate. Should be in PEM format.
- Team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate String
- The certificate itself. Should be in PEM format.
- String
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key String - The private key of the Certificate. Should be in PEM format.
- team
Id String - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate string
- The certificate itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key string - The private key of the Certificate. Should be in PEM format.
- team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate str
- The certificate itself. Should be in PEM format.
- str
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private_
key str - The private key of the Certificate. Should be in PEM format.
- team_
id str - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate String
- The certificate itself. Should be in PEM format.
- String
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key String - The private key of the Certificate. Should be in PEM format.
- team
Id String - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomCertificate resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing CustomCertificate Resource
Get an existing CustomCertificate 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?: CustomCertificateState, opts?: CustomResourceOptions): CustomCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
certificate_authority_certificate: Optional[str] = None,
private_key: Optional[str] = None,
team_id: Optional[str] = None) -> CustomCertificatefunc GetCustomCertificate(ctx *Context, name string, id IDInput, state *CustomCertificateState, opts ...ResourceOption) (*CustomCertificate, error)public static CustomCertificate Get(string name, Input<string> id, CustomCertificateState? state, CustomResourceOptions? opts = null)public static CustomCertificate get(String name, Output<String> id, CustomCertificateState state, CustomResourceOptions options)resources: _: type: vercel:CustomCertificate get: id: ${id}- 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 itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- Private
Key string - The private key of the Certificate. Should be in PEM format.
- Team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- Certificate string
- The certificate itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- Private
Key string - The private key of the Certificate. Should be in PEM format.
- Team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate String
- The certificate itself. Should be in PEM format.
- String
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key String - The private key of the Certificate. Should be in PEM format.
- team
Id String - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate string
- The certificate itself. Should be in PEM format.
- string
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key string - The private key of the Certificate. Should be in PEM format.
- team
Id string - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate str
- The certificate itself. Should be in PEM format.
- str
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private_
key str - The private key of the Certificate. Should be in PEM format.
- team_
id str - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
- certificate String
- The certificate itself. Should be in PEM format.
- String
- The Certificate Authority root certificate such as one of Let's Encrypt's ISRG root certificates. This will be provided by your certificate issuer and is different to the core certificate. This may be included in their download process or available for download on their website. Should be in PEM format.
- private
Key String - The private key of the Certificate. Should be in PEM format.
- team
Id String - The ID of the team the Custom Certificate should exist under. Required when configuring a team resource if a default team has not been set in the provider.
Package Details
- Repository
- vercel pulumiverse/pulumi-vercel
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vercelTerraform Provider.