1. Packages
  2. Heroku Provider
  3. API Docs
  4. cert
  5. Cert
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

heroku.cert.Cert

Explore with Pulumi AI

heroku logo
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

    This resource manages an SSL certificate for a Heroku app.

    !> WARNING: This resource is deprecated in favor of heroku.ssl.Ssl.

    Example Usage

    # Create a new Heroku app
    resource "heroku_app" "default" {
      name = "test-app"
      region = "us"
    }
    
    # Add-on SSL to application
    resource "heroku_addon" "ssl" {
      app_id = heroku_app.default.id
      plan  = "ssl"
    }
    
    # Establish certificate for a given application
    resource "heroku_cert" "ssl_certificate" {
      app               = heroku_app.default.id
      certificate_chain = file("server.crt")
      private_key       = file("server.key")
      depends_on        = ["heroku_addon.ssl"]
    }
    

    Create Cert Resource

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

    Constructor syntax

    new Cert(name: string, args: CertArgs, opts?: CustomResourceOptions);
    @overload
    def Cert(resource_name: str,
             args: CertArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cert(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             app: Optional[str] = None,
             certificate_chain: Optional[str] = None,
             private_key: Optional[str] = None)
    func NewCert(ctx *Context, name string, args CertArgs, opts ...ResourceOption) (*Cert, error)
    public Cert(string name, CertArgs args, CustomResourceOptions? opts = null)
    public Cert(String name, CertArgs args)
    public Cert(String name, CertArgs args, CustomResourceOptions options)
    
    type: heroku:cert:Cert
    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 CertArgs
    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 CertArgs
    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 CertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertArgs
    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 certResource = new Heroku.Cert.Cert("certResource", new()
    {
        App = "string",
        CertificateChain = "string",
        PrivateKey = "string",
    });
    
    example, err := cert.NewCert(ctx, "certResource", &cert.CertArgs{
    	App:              pulumi.String("string"),
    	CertificateChain: pulumi.String("string"),
    	PrivateKey:       pulumi.String("string"),
    })
    
    var certResource = new Cert("certResource", CertArgs.builder()
        .app("string")
        .certificateChain("string")
        .privateKey("string")
        .build());
    
    cert_resource = heroku.cert.Cert("certResource",
        app="string",
        certificate_chain="string",
        private_key="string")
    
    const certResource = new heroku.cert.Cert("certResource", {
        app: "string",
        certificateChain: "string",
        privateKey: "string",
    });
    
    type: heroku:cert:Cert
    properties:
        app: string
        certificateChain: string
        privateKey: string
    

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

    App string
    Heroku app ID (do not use app name)
    CertificateChain string
    The certificate chain to add
    PrivateKey string
    The private key for a given certificate chain
    App string
    Heroku app ID (do not use app name)
    CertificateChain string
    The certificate chain to add
    PrivateKey string
    The private key for a given certificate chain
    app String
    Heroku app ID (do not use app name)
    certificateChain String
    The certificate chain to add
    privateKey String
    The private key for a given certificate chain
    app string
    Heroku app ID (do not use app name)
    certificateChain string
    The certificate chain to add
    privateKey string
    The private key for a given certificate chain
    app str
    Heroku app ID (do not use app name)
    certificate_chain str
    The certificate chain to add
    private_key str
    The private key for a given certificate chain
    app String
    Heroku app ID (do not use app name)
    certificateChain String
    The certificate chain to add
    privateKey String
    The private key for a given certificate chain

    Outputs

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

    Cname string
    The CNAME for the SSL endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the SSL certificate
    Cname string
    The CNAME for the SSL endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the SSL certificate
    cname String
    The CNAME for the SSL endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the SSL certificate
    cname string
    The CNAME for the SSL endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the SSL certificate
    cname str
    The CNAME for the SSL endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the SSL certificate
    cname String
    The CNAME for the SSL endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the SSL certificate

    Look up Existing Cert Resource

    Get an existing Cert 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?: CertState, opts?: CustomResourceOptions): Cert
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app: Optional[str] = None,
            certificate_chain: Optional[str] = None,
            cname: Optional[str] = None,
            name: Optional[str] = None,
            private_key: Optional[str] = None) -> Cert
    func GetCert(ctx *Context, name string, id IDInput, state *CertState, opts ...ResourceOption) (*Cert, error)
    public static Cert Get(string name, Input<string> id, CertState? state, CustomResourceOptions? opts = null)
    public static Cert get(String name, Output<String> id, CertState state, CustomResourceOptions options)
    resources:  _:    type: heroku:cert:Cert    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.
    The following state arguments are supported:
    App string
    Heroku app ID (do not use app name)
    CertificateChain string
    The certificate chain to add
    Cname string
    The CNAME for the SSL endpoint
    Name string
    The name of the SSL certificate
    PrivateKey string
    The private key for a given certificate chain
    App string
    Heroku app ID (do not use app name)
    CertificateChain string
    The certificate chain to add
    Cname string
    The CNAME for the SSL endpoint
    Name string
    The name of the SSL certificate
    PrivateKey string
    The private key for a given certificate chain
    app String
    Heroku app ID (do not use app name)
    certificateChain String
    The certificate chain to add
    cname String
    The CNAME for the SSL endpoint
    name String
    The name of the SSL certificate
    privateKey String
    The private key for a given certificate chain
    app string
    Heroku app ID (do not use app name)
    certificateChain string
    The certificate chain to add
    cname string
    The CNAME for the SSL endpoint
    name string
    The name of the SSL certificate
    privateKey string
    The private key for a given certificate chain
    app str
    Heroku app ID (do not use app name)
    certificate_chain str
    The certificate chain to add
    cname str
    The CNAME for the SSL endpoint
    name str
    The name of the SSL certificate
    private_key str
    The private key for a given certificate chain
    app String
    Heroku app ID (do not use app name)
    certificateChain String
    The certificate chain to add
    cname String
    The CNAME for the SSL endpoint
    name String
    The name of the SSL certificate
    privateKey String
    The private key for a given certificate chain

    Import

    ing

    When importing a Heroku cert resource, the ID must be built using the app name colon the unique ID from the Heroku API. For an app named production-api with a certificate ID of b85d9224-310b-409b-891e-c903f5a40568, you would import it as:

    $ terraform import heroku_cert.production_api production-api:b85d9224-310b-409b-891e-c903f5a40568
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns