1. Packages
  2. DNSimple
  3. API Docs
  4. LetsEncryptCertificate
DNSimple v3.4.3 published on Thursday, May 23, 2024 by Pulumi

dnsimple.LetsEncryptCertificate

Explore with Pulumi AI

dnsimple logo
DNSimple v3.4.3 published on Thursday, May 23, 2024 by Pulumi

    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",
    });
    
    import pulumi
    import pulumi_dnsimple as dnsimple
    
    foobar = dnsimple.LetsEncryptCertificate("foobar",
        domain_id=dnsimple["domainId"],
        auto_renew=False,
        name="www")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-dnsimple/sdk/v3/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"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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",
        });
    
    });
    
    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")
                .build());
    
        }
    }
    
    resources:
      foobar:
        type: dnsimple:LetsEncryptCertificate
        properties:
          domainId: ${dnsimple.domainId}
          autoRenew: false
          name: www
    

    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,
                               name: Optional[str] = None,
                               contact_id: Optional[int] = None,
                               domain_id: 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 string
    The unique name of the resource.
    args LetsEncryptCertificateArgs
    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 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 string
    The unique name of the resource.
    args LetsEncryptCertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LetsEncryptCertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LetsEncryptCertificateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var letsEncryptCertificateResource = new DNSimple.LetsEncryptCertificate("letsEncryptCertificateResource", new()
    {
        AutoRenew = false,
        Name = "string",
        DomainId = "string",
    });
    
    example, err := dnsimple.NewLetsEncryptCertificate(ctx, "letsEncryptCertificateResource", &dnsimple.LetsEncryptCertificateArgs{
    	AutoRenew: pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    	DomainId:  pulumi.String("string"),
    })
    
    var letsEncryptCertificateResource = new LetsEncryptCertificate("letsEncryptCertificateResource", LetsEncryptCertificateArgs.builder()
        .autoRenew(false)
        .name("string")
        .domainId("string")
        .build());
    
    lets_encrypt_certificate_resource = dnsimple.LetsEncryptCertificate("letsEncryptCertificateResource",
        auto_renew=False,
        name="string",
        domain_id="string")
    
    const letsEncryptCertificateResource = new dnsimple.LetsEncryptCertificate("letsEncryptCertificateResource", {
        autoRenew: false,
        name: "string",
        domainId: "string",
    });
    
    type: dnsimple:LetsEncryptCertificate
    properties:
        autoRenew: false
        domainId: string
        name: string
    

    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

    The LetsEncryptCertificate resource accepts the following input properties:

    AutoRenew bool
    Set to true if the certificate will auto-renew
    Name string
    The certificate name
    ContactId int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    DomainId string
    The domain to be issued the certificate for
    AutoRenew bool
    Set to true if the certificate will auto-renew
    Name string
    The certificate name
    ContactId int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    DomainId string
    The domain to be issued the certificate for
    autoRenew Boolean
    Set to true if the certificate will auto-renew
    name String
    The certificate name
    contactId Integer
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    domainId String
    The domain to be issued the certificate for
    autoRenew boolean
    Set to true if the certificate will auto-renew
    name string
    The certificate name
    contactId number
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    domainId string
    The domain to be issued the certificate for
    auto_renew bool
    Set to true if the certificate will auto-renew
    name str
    The certificate name
    contact_id int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    domain_id str
    The domain to be issued the certificate for
    autoRenew Boolean
    Set to true if the certificate will auto-renew
    name String
    The certificate name
    contactId Number
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    domainId String
    The domain to be issued the certificate for

    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
    Csr string
    The certificate signing request
    ExpiresOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the certificate
    UpdatedAt string
    Years int
    The years the certificate will last
    AuthorityIdentifier string
    The identifying certification authority (CA)
    CreatedAt string
    Csr string
    The certificate signing request
    ExpiresOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the certificate
    UpdatedAt string
    Years int
    The years the certificate will last
    authorityIdentifier String
    The identifying certification authority (CA)
    createdAt String
    csr String
    The certificate signing request
    expiresOn String
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the certificate
    updatedAt String
    years Integer
    The years the certificate will last
    authorityIdentifier string
    The identifying certification authority (CA)
    createdAt string
    csr string
    The certificate signing request
    expiresOn string
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the certificate
    updatedAt string
    years number
    The years the certificate will last
    authority_identifier str
    The identifying certification authority (CA)
    created_at str
    csr str
    The certificate signing request
    expires_on str
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The state of the certificate
    updated_at str
    years int
    The years the certificate will last
    authorityIdentifier String
    The identifying certification authority (CA)
    createdAt String
    csr String
    The certificate signing request
    expiresOn String
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the certificate
    updatedAt String
    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,
            authority_identifier: Optional[str] = None,
            auto_renew: Optional[bool] = None,
            contact_id: Optional[int] = None,
            created_at: Optional[str] = None,
            csr: Optional[str] = None,
            domain_id: Optional[str] = None,
            expires_on: Optional[str] = None,
            name: 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)
    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.
    The following state arguments are supported:
    AuthorityIdentifier string
    The identifying certification authority (CA)
    AutoRenew bool
    Set to true if the certificate will auto-renew
    ContactId int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    CreatedAt string
    Csr string
    The certificate signing request
    DomainId string
    The domain to be issued the certificate for
    ExpiresOn string
    Name string
    The certificate name
    State string
    The state of the certificate
    UpdatedAt string
    Years int
    The years the certificate will last
    AuthorityIdentifier string
    The identifying certification authority (CA)
    AutoRenew bool
    Set to true if the certificate will auto-renew
    ContactId int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    CreatedAt string
    Csr string
    The certificate signing request
    DomainId string
    The domain to be issued the certificate for
    ExpiresOn string
    Name string
    The certificate name
    State string
    The state of the certificate
    UpdatedAt string
    Years int
    The years the certificate will last
    authorityIdentifier String
    The identifying certification authority (CA)
    autoRenew Boolean
    Set to true if the certificate will auto-renew
    contactId Integer
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    createdAt String
    csr String
    The certificate signing request
    domainId String
    The domain to be issued the certificate for
    expiresOn String
    name String
    The certificate name
    state String
    The state of the certificate
    updatedAt String
    years Integer
    The years the certificate will last
    authorityIdentifier string
    The identifying certification authority (CA)
    autoRenew boolean
    Set to true if the certificate will auto-renew
    contactId number
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    createdAt string
    csr string
    The certificate signing request
    domainId string
    The domain to be issued the certificate for
    expiresOn string
    name string
    The certificate name
    state string
    The state of the certificate
    updatedAt string
    years number
    The years the certificate will last
    authority_identifier str
    The identifying certification authority (CA)
    auto_renew bool
    Set to true if the certificate will auto-renew
    contact_id int
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    created_at str
    csr str
    The certificate signing request
    domain_id str
    The domain to be issued the certificate for
    expires_on str
    name str
    The certificate name
    state str
    The state of the certificate
    updated_at str
    years int
    The years the certificate will last
    authorityIdentifier String
    The identifying certification authority (CA)
    autoRenew Boolean
    Set to true if the certificate will auto-renew
    contactId Number
    The contact id for the certificate

    Deprecated: contact_id is deprecated and has no effect. The attribute will be removed in the next major version.

    createdAt String
    csr String
    The certificate signing request
    domainId String
    The domain to be issued the certificate for
    expiresOn String
    name String
    The certificate name
    state String
    The state of the certificate
    updatedAt String
    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 logo
    DNSimple v3.4.3 published on Thursday, May 23, 2024 by Pulumi