Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Dnsimple Provider
  3. API Docs
  4. LetsEncryptCertificate
DNSimple v4.3.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-dnsimple

dnsimple.LetsEncryptCertificate

Explore with Pulumi AI

DNSimple v4.3.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-dnsimple

Provides a DNSimple Let’s Encrypt certificate resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as dnsimple from "@pulumi/dnsimple";

const foobar = new dnsimple.LetsEncryptCertificate("foobar", {
    domainId: dnsimple.domainId,
    autoRenew: false,
    name: "www",
    alternateNames: [
        "docs.example.com",
        "status.example.com",
    ],
});
Copy
import pulumi
import pulumi_dnsimple as dnsimple

foobar = dnsimple.LetsEncryptCertificate("foobar",
    domain_id=dnsimple["domainId"],
    auto_renew=False,
    name="www",
    alternate_names=[
        "docs.example.com",
        "status.example.com",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v4/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewLetsEncryptCertificate(ctx, "foobar", &dnsimple.LetsEncryptCertificateArgs{
			DomainId:  pulumi.Any(dnsimple.DomainId),
			AutoRenew: pulumi.Bool(false),
			Name:      pulumi.String("www"),
			AlternateNames: pulumi.StringArray{
				pulumi.String("docs.example.com"),
				pulumi.String("status.example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DNSimple = Pulumi.DNSimple;

return await Deployment.RunAsync(() => 
{
    var foobar = new DNSimple.LetsEncryptCertificate("foobar", new()
    {
        DomainId = dnsimple.DomainId,
        AutoRenew = false,
        Name = "www",
        AlternateNames = new[]
        {
            "docs.example.com",
            "status.example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.LetsEncryptCertificate;
import com.pulumi.dnsimple.LetsEncryptCertificateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foobar = new LetsEncryptCertificate("foobar", LetsEncryptCertificateArgs.builder()
            .domainId(dnsimple.domainId())
            .autoRenew(false)
            .name("www")
            .alternateNames(            
                "docs.example.com",
                "status.example.com")
            .build());

    }
}
Copy
resources:
  foobar:
    type: dnsimple:LetsEncryptCertificate
    properties:
      domainId: ${dnsimple.domainId}
      autoRenew: false
      name: www
      alternateNames:
        - docs.example.com
        - status.example.com
Copy

Create LetsEncryptCertificate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LetsEncryptCertificate(name: string, args: LetsEncryptCertificateArgs, opts?: CustomResourceOptions);
@overload
def LetsEncryptCertificate(resource_name: str,
                           args: LetsEncryptCertificateArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def LetsEncryptCertificate(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           auto_renew: Optional[bool] = None,
                           domain_id: Optional[str] = None,
                           name: Optional[str] = None,
                           alternate_names: Optional[Sequence[str]] = None,
                           signature_algorithm: Optional[str] = None)
func NewLetsEncryptCertificate(ctx *Context, name string, args LetsEncryptCertificateArgs, opts ...ResourceOption) (*LetsEncryptCertificate, error)
public LetsEncryptCertificate(string name, LetsEncryptCertificateArgs args, CustomResourceOptions? opts = null)
public LetsEncryptCertificate(String name, LetsEncryptCertificateArgs args)
public LetsEncryptCertificate(String name, LetsEncryptCertificateArgs args, CustomResourceOptions options)

type: dnsimple:LetsEncryptCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LetsEncryptCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LetsEncryptCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LetsEncryptCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LetsEncryptCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LetsEncryptCertificateArgs
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 letsEncryptCertificateResource = new DNSimple.LetsEncryptCertificate("letsEncryptCertificateResource", new()
{
    AutoRenew = false,
    DomainId = "string",
    Name = "string",
    AlternateNames = new[]
    {
        "string",
    },
    SignatureAlgorithm = "string",
});
Copy
example, err := dnsimple.NewLetsEncryptCertificate(ctx, "letsEncryptCertificateResource", &dnsimple.LetsEncryptCertificateArgs{
	AutoRenew: pulumi.Bool(false),
	DomainId:  pulumi.String("string"),
	Name:      pulumi.String("string"),
	AlternateNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	SignatureAlgorithm: pulumi.String("string"),
})
Copy
var letsEncryptCertificateResource = new LetsEncryptCertificate("letsEncryptCertificateResource", LetsEncryptCertificateArgs.builder()
    .autoRenew(false)
    .domainId("string")
    .name("string")
    .alternateNames("string")
    .signatureAlgorithm("string")
    .build());
Copy
lets_encrypt_certificate_resource = dnsimple.LetsEncryptCertificate("letsEncryptCertificateResource",
    auto_renew=False,
    domain_id="string",
    name="string",
    alternate_names=["string"],
    signature_algorithm="string")
Copy
const letsEncryptCertificateResource = new dnsimple.LetsEncryptCertificate("letsEncryptCertificateResource", {
    autoRenew: false,
    domainId: "string",
    name: "string",
    alternateNames: ["string"],
    signatureAlgorithm: "string",
});
Copy
type: dnsimple:LetsEncryptCertificate
properties:
    alternateNames:
        - string
    autoRenew: false
    domainId: string
    name: string
    signatureAlgorithm: string
Copy

LetsEncryptCertificate 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 LetsEncryptCertificate resource accepts the following input properties:

AutoRenew This property is required. bool
True if the certificate should auto-renew
DomainId This property is required. string
The domain to be issued the certificate for
Name This property is required. string
The certificate name; use "" for the root domain. Wildcard names are supported.
AlternateNames List<string>
The certificate alternate names
SignatureAlgorithm string
The signature algorithm to use for the certificate
AutoRenew This property is required. bool
True if the certificate should auto-renew
DomainId This property is required. string
The domain to be issued the certificate for
Name This property is required. string
The certificate name; use "" for the root domain. Wildcard names are supported.
AlternateNames []string
The certificate alternate names
SignatureAlgorithm string
The signature algorithm to use for the certificate
autoRenew This property is required. Boolean
True if the certificate should auto-renew
domainId This property is required. String
The domain to be issued the certificate for
name This property is required. String
The certificate name; use "" for the root domain. Wildcard names are supported.
alternateNames List<String>
The certificate alternate names
signatureAlgorithm String
The signature algorithm to use for the certificate
autoRenew This property is required. boolean
True if the certificate should auto-renew
domainId This property is required. string
The domain to be issued the certificate for
name This property is required. string
The certificate name; use "" for the root domain. Wildcard names are supported.
alternateNames string[]
The certificate alternate names
signatureAlgorithm string
The signature algorithm to use for the certificate
auto_renew This property is required. bool
True if the certificate should auto-renew
domain_id This property is required. str
The domain to be issued the certificate for
name This property is required. str
The certificate name; use "" for the root domain. Wildcard names are supported.
alternate_names Sequence[str]
The certificate alternate names
signature_algorithm str
The signature algorithm to use for the certificate
autoRenew This property is required. Boolean
True if the certificate should auto-renew
domainId This property is required. String
The domain to be issued the certificate for
name This property is required. String
The certificate name; use "" for the root domain. Wildcard names are supported.
alternateNames List<String>
The certificate alternate names
signatureAlgorithm String
The signature algorithm to use for the certificate

Outputs

All input properties are implicitly available as output properties. Additionally, the LetsEncryptCertificate resource produces the following output properties:

AuthorityIdentifier string
The identifying certification authority (CA)
CreatedAt string
The datetime the certificate was created
Csr string
The certificate signing request
ExpiresAt string
The datetime the certificate will expire
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the certificate
UpdatedAt string
The datetime the certificate was last updated
Years int
The years the certificate will last
AuthorityIdentifier string
The identifying certification authority (CA)
CreatedAt string
The datetime the certificate was created
Csr string
The certificate signing request
ExpiresAt string
The datetime the certificate will expire
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the certificate
UpdatedAt string
The datetime the certificate was last updated
Years int
The years the certificate will last
authorityIdentifier String
The identifying certification authority (CA)
createdAt String
The datetime the certificate was created
csr String
The certificate signing request
expiresAt String
The datetime the certificate will expire
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the certificate
updatedAt String
The datetime the certificate was last updated
years Integer
The years the certificate will last
authorityIdentifier string
The identifying certification authority (CA)
createdAt string
The datetime the certificate was created
csr string
The certificate signing request
expiresAt string
The datetime the certificate will expire
id string
The provider-assigned unique ID for this managed resource.
state string
The state of the certificate
updatedAt string
The datetime the certificate was last updated
years number
The years the certificate will last
authority_identifier str
The identifying certification authority (CA)
created_at str
The datetime the certificate was created
csr str
The certificate signing request
expires_at str
The datetime the certificate will expire
id str
The provider-assigned unique ID for this managed resource.
state str
The state of the certificate
updated_at str
The datetime the certificate was last updated
years int
The years the certificate will last
authorityIdentifier String
The identifying certification authority (CA)
createdAt String
The datetime the certificate was created
csr String
The certificate signing request
expiresAt String
The datetime the certificate will expire
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the certificate
updatedAt String
The datetime the certificate was last updated
years Number
The years the certificate will last

Look up Existing LetsEncryptCertificate Resource

Get an existing LetsEncryptCertificate 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?: LetsEncryptCertificateState, opts?: CustomResourceOptions): LetsEncryptCertificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alternate_names: Optional[Sequence[str]] = None,
        authority_identifier: Optional[str] = None,
        auto_renew: Optional[bool] = None,
        created_at: Optional[str] = None,
        csr: Optional[str] = None,
        domain_id: Optional[str] = None,
        expires_at: Optional[str] = None,
        name: Optional[str] = None,
        signature_algorithm: Optional[str] = None,
        state: Optional[str] = None,
        updated_at: Optional[str] = None,
        years: Optional[int] = None) -> LetsEncryptCertificate
func GetLetsEncryptCertificate(ctx *Context, name string, id IDInput, state *LetsEncryptCertificateState, opts ...ResourceOption) (*LetsEncryptCertificate, error)
public static LetsEncryptCertificate Get(string name, Input<string> id, LetsEncryptCertificateState? state, CustomResourceOptions? opts = null)
public static LetsEncryptCertificate get(String name, Output<String> id, LetsEncryptCertificateState state, CustomResourceOptions options)
resources:  _:    type: dnsimple:LetsEncryptCertificate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AlternateNames List<string>
The certificate alternate names
AuthorityIdentifier string
The identifying certification authority (CA)
AutoRenew bool
True if the certificate should auto-renew
CreatedAt string
The datetime the certificate was created
Csr string
The certificate signing request
DomainId string
The domain to be issued the certificate for
ExpiresAt string
The datetime the certificate will expire
Name string
The certificate name; use "" for the root domain. Wildcard names are supported.
SignatureAlgorithm string
The signature algorithm to use for the certificate
State string
The state of the certificate
UpdatedAt string
The datetime the certificate was last updated
Years int
The years the certificate will last
AlternateNames []string
The certificate alternate names
AuthorityIdentifier string
The identifying certification authority (CA)
AutoRenew bool
True if the certificate should auto-renew
CreatedAt string
The datetime the certificate was created
Csr string
The certificate signing request
DomainId string
The domain to be issued the certificate for
ExpiresAt string
The datetime the certificate will expire
Name string
The certificate name; use "" for the root domain. Wildcard names are supported.
SignatureAlgorithm string
The signature algorithm to use for the certificate
State string
The state of the certificate
UpdatedAt string
The datetime the certificate was last updated
Years int
The years the certificate will last
alternateNames List<String>
The certificate alternate names
authorityIdentifier String
The identifying certification authority (CA)
autoRenew Boolean
True if the certificate should auto-renew
createdAt String
The datetime the certificate was created
csr String
The certificate signing request
domainId String
The domain to be issued the certificate for
expiresAt String
The datetime the certificate will expire
name String
The certificate name; use "" for the root domain. Wildcard names are supported.
signatureAlgorithm String
The signature algorithm to use for the certificate
state String
The state of the certificate
updatedAt String
The datetime the certificate was last updated
years Integer
The years the certificate will last
alternateNames string[]
The certificate alternate names
authorityIdentifier string
The identifying certification authority (CA)
autoRenew boolean
True if the certificate should auto-renew
createdAt string
The datetime the certificate was created
csr string
The certificate signing request
domainId string
The domain to be issued the certificate for
expiresAt string
The datetime the certificate will expire
name string
The certificate name; use "" for the root domain. Wildcard names are supported.
signatureAlgorithm string
The signature algorithm to use for the certificate
state string
The state of the certificate
updatedAt string
The datetime the certificate was last updated
years number
The years the certificate will last
alternate_names Sequence[str]
The certificate alternate names
authority_identifier str
The identifying certification authority (CA)
auto_renew bool
True if the certificate should auto-renew
created_at str
The datetime the certificate was created
csr str
The certificate signing request
domain_id str
The domain to be issued the certificate for
expires_at str
The datetime the certificate will expire
name str
The certificate name; use "" for the root domain. Wildcard names are supported.
signature_algorithm str
The signature algorithm to use for the certificate
state str
The state of the certificate
updated_at str
The datetime the certificate was last updated
years int
The years the certificate will last
alternateNames List<String>
The certificate alternate names
authorityIdentifier String
The identifying certification authority (CA)
autoRenew Boolean
True if the certificate should auto-renew
createdAt String
The datetime the certificate was created
csr String
The certificate signing request
domainId String
The domain to be issued the certificate for
expiresAt String
The datetime the certificate will expire
name String
The certificate name; use "" for the root domain. Wildcard names are supported.
signatureAlgorithm String
The signature algorithm to use for the certificate
state String
The state of the certificate
updatedAt String
The datetime the certificate was last updated
years Number
The years the certificate will last

Package Details

Repository
DNSimple pulumi/pulumi-dnsimple
License
Apache-2.0
Notes
This Pulumi package is based on the dnsimple Terraform Provider.
DNSimple v4.3.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-dnsimple