1. Packages
  2. Hsdp Provider
  3. API Docs
  4. EdgeCustomCert
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.EdgeCustomCert

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Manage custom certificates on Edge devices. Set sync to true to immediately sync the certificate to the k3s cluster, otherwise you should create a dependency on a hsdp.EdgeSync resource to batch sync changes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const cert = new hsdp.EdgeCustomCert("cert", {
        serialNumber: _var.serial_number,
        certPem: _var.cert_pem,
        privateKeyPem: _var.private_key_pme,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    cert = hsdp.EdgeCustomCert("cert",
        serial_number=var["serial_number"],
        cert_pem=var["cert_pem"],
        private_key_pem=var["private_key_pme"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.NewEdgeCustomCert(ctx, "cert", &hsdp.EdgeCustomCertArgs{
    			SerialNumber:  pulumi.Any(_var.Serial_number),
    			CertPem:       pulumi.Any(_var.Cert_pem),
    			PrivateKeyPem: pulumi.Any(_var.Private_key_pme),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var cert = new Hsdp.EdgeCustomCert("cert", new()
        {
            SerialNumber = @var.Serial_number,
            CertPem = @var.Cert_pem,
            PrivateKeyPem = @var.Private_key_pme,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.EdgeCustomCert;
    import com.pulumi.hsdp.EdgeCustomCertArgs;
    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 cert = new EdgeCustomCert("cert", EdgeCustomCertArgs.builder()
                .serialNumber(var_.serial_number())
                .certPem(var_.cert_pem())
                .privateKeyPem(var_.private_key_pme())
                .build());
    
        }
    }
    
    resources:
      cert:
        type: hsdp:EdgeCustomCert
        properties:
          serialNumber: ${var.serial_number}
          certPem: ${var.cert_pem}
          privateKeyPem: ${var.private_key_pme}
    

    Create EdgeCustomCert Resource

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

    Constructor syntax

    new EdgeCustomCert(name: string, args: EdgeCustomCertArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeCustomCert(resource_name: str,
                       args: EdgeCustomCertArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeCustomCert(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cert_pem: Optional[str] = None,
                       private_key_pem: Optional[str] = None,
                       serial_number: Optional[str] = None,
                       edge_custom_cert_id: Optional[str] = None,
                       name: Optional[str] = None,
                       principal: Optional[EdgeCustomCertPrincipalArgs] = None,
                       sync: Optional[bool] = None)
    func NewEdgeCustomCert(ctx *Context, name string, args EdgeCustomCertArgs, opts ...ResourceOption) (*EdgeCustomCert, error)
    public EdgeCustomCert(string name, EdgeCustomCertArgs args, CustomResourceOptions? opts = null)
    public EdgeCustomCert(String name, EdgeCustomCertArgs args)
    public EdgeCustomCert(String name, EdgeCustomCertArgs args, CustomResourceOptions options)
    
    type: hsdp:EdgeCustomCert
    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 EdgeCustomCertArgs
    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 EdgeCustomCertArgs
    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 EdgeCustomCertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeCustomCertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeCustomCertArgs
    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 edgeCustomCertResource = new Hsdp.EdgeCustomCert("edgeCustomCertResource", new()
    {
        CertPem = "string",
        PrivateKeyPem = "string",
        SerialNumber = "string",
        EdgeCustomCertId = "string",
        Name = "string",
        Principal = new Hsdp.Inputs.EdgeCustomCertPrincipalArgs
        {
            Endpoint = "string",
            Environment = "string",
            Oauth2ClientId = "string",
            Oauth2Password = "string",
            Password = "string",
            Region = "string",
            ServiceId = "string",
            ServicePrivateKey = "string",
            UaaPassword = "string",
            UaaUsername = "string",
            Username = "string",
        },
        Sync = false,
    });
    
    example, err := hsdp.NewEdgeCustomCert(ctx, "edgeCustomCertResource", &hsdp.EdgeCustomCertArgs{
    	CertPem:          pulumi.String("string"),
    	PrivateKeyPem:    pulumi.String("string"),
    	SerialNumber:     pulumi.String("string"),
    	EdgeCustomCertId: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Principal: &hsdp.EdgeCustomCertPrincipalArgs{
    		Endpoint:          pulumi.String("string"),
    		Environment:       pulumi.String("string"),
    		Oauth2ClientId:    pulumi.String("string"),
    		Oauth2Password:    pulumi.String("string"),
    		Password:          pulumi.String("string"),
    		Region:            pulumi.String("string"),
    		ServiceId:         pulumi.String("string"),
    		ServicePrivateKey: pulumi.String("string"),
    		UaaPassword:       pulumi.String("string"),
    		UaaUsername:       pulumi.String("string"),
    		Username:          pulumi.String("string"),
    	},
    	Sync: pulumi.Bool(false),
    })
    
    var edgeCustomCertResource = new EdgeCustomCert("edgeCustomCertResource", EdgeCustomCertArgs.builder()
        .certPem("string")
        .privateKeyPem("string")
        .serialNumber("string")
        .edgeCustomCertId("string")
        .name("string")
        .principal(EdgeCustomCertPrincipalArgs.builder()
            .endpoint("string")
            .environment("string")
            .oauth2ClientId("string")
            .oauth2Password("string")
            .password("string")
            .region("string")
            .serviceId("string")
            .servicePrivateKey("string")
            .uaaPassword("string")
            .uaaUsername("string")
            .username("string")
            .build())
        .sync(false)
        .build());
    
    edge_custom_cert_resource = hsdp.EdgeCustomCert("edgeCustomCertResource",
        cert_pem="string",
        private_key_pem="string",
        serial_number="string",
        edge_custom_cert_id="string",
        name="string",
        principal={
            "endpoint": "string",
            "environment": "string",
            "oauth2_client_id": "string",
            "oauth2_password": "string",
            "password": "string",
            "region": "string",
            "service_id": "string",
            "service_private_key": "string",
            "uaa_password": "string",
            "uaa_username": "string",
            "username": "string",
        },
        sync=False)
    
    const edgeCustomCertResource = new hsdp.EdgeCustomCert("edgeCustomCertResource", {
        certPem: "string",
        privateKeyPem: "string",
        serialNumber: "string",
        edgeCustomCertId: "string",
        name: "string",
        principal: {
            endpoint: "string",
            environment: "string",
            oauth2ClientId: "string",
            oauth2Password: "string",
            password: "string",
            region: "string",
            serviceId: "string",
            servicePrivateKey: "string",
            uaaPassword: "string",
            uaaUsername: "string",
            username: "string",
        },
        sync: false,
    });
    
    type: hsdp:EdgeCustomCert
    properties:
        certPem: string
        edgeCustomCertId: string
        name: string
        principal:
            endpoint: string
            environment: string
            oauth2ClientId: string
            oauth2Password: string
            password: string
            region: string
            serviceId: string
            servicePrivateKey: string
            uaaPassword: string
            uaaUsername: string
            username: string
        privateKeyPem: string
        serialNumber: string
        sync: false
    

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

    CertPem string
    The certificate in PEM format
    PrivateKeyPem string
    the private key of the certificate in PEM format
    SerialNumber string
    Device to attach the cert to
    EdgeCustomCertId string
    The id of the custom certificate
    Name string
    Name of the certificate
    Principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    Sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    CertPem string
    The certificate in PEM format
    PrivateKeyPem string
    the private key of the certificate in PEM format
    SerialNumber string
    Device to attach the cert to
    EdgeCustomCertId string
    The id of the custom certificate
    Name string
    Name of the certificate
    Principal EdgeCustomCertPrincipalArgs
    The optional principal to use for this resource
    Sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem String
    The certificate in PEM format
    privateKeyPem String
    the private key of the certificate in PEM format
    serialNumber String
    Device to attach the cert to
    edgeCustomCertId String
    The id of the custom certificate
    name String
    Name of the certificate
    principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    sync Boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem string
    The certificate in PEM format
    privateKeyPem string
    the private key of the certificate in PEM format
    serialNumber string
    Device to attach the cert to
    edgeCustomCertId string
    The id of the custom certificate
    name string
    Name of the certificate
    principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    sync boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    cert_pem str
    The certificate in PEM format
    private_key_pem str
    the private key of the certificate in PEM format
    serial_number str
    Device to attach the cert to
    edge_custom_cert_id str
    The id of the custom certificate
    name str
    Name of the certificate
    principal EdgeCustomCertPrincipalArgs
    The optional principal to use for this resource
    sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem String
    The certificate in PEM format
    privateKeyPem String
    the private key of the certificate in PEM format
    serialNumber String
    Device to attach the cert to
    edgeCustomCertId String
    The id of the custom certificate
    name String
    Name of the certificate
    principal Property Map
    The optional principal to use for this resource
    sync Boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EdgeCustomCert 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 EdgeCustomCert Resource

    Get an existing EdgeCustomCert 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?: EdgeCustomCertState, opts?: CustomResourceOptions): EdgeCustomCert
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cert_pem: Optional[str] = None,
            edge_custom_cert_id: Optional[str] = None,
            name: Optional[str] = None,
            principal: Optional[EdgeCustomCertPrincipalArgs] = None,
            private_key_pem: Optional[str] = None,
            serial_number: Optional[str] = None,
            sync: Optional[bool] = None) -> EdgeCustomCert
    func GetEdgeCustomCert(ctx *Context, name string, id IDInput, state *EdgeCustomCertState, opts ...ResourceOption) (*EdgeCustomCert, error)
    public static EdgeCustomCert Get(string name, Input<string> id, EdgeCustomCertState? state, CustomResourceOptions? opts = null)
    public static EdgeCustomCert get(String name, Output<String> id, EdgeCustomCertState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:EdgeCustomCert    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:
    CertPem string
    The certificate in PEM format
    EdgeCustomCertId string
    The id of the custom certificate
    Name string
    Name of the certificate
    Principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    PrivateKeyPem string
    the private key of the certificate in PEM format
    SerialNumber string
    Device to attach the cert to
    Sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    CertPem string
    The certificate in PEM format
    EdgeCustomCertId string
    The id of the custom certificate
    Name string
    Name of the certificate
    Principal EdgeCustomCertPrincipalArgs
    The optional principal to use for this resource
    PrivateKeyPem string
    the private key of the certificate in PEM format
    SerialNumber string
    Device to attach the cert to
    Sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem String
    The certificate in PEM format
    edgeCustomCertId String
    The id of the custom certificate
    name String
    Name of the certificate
    principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    privateKeyPem String
    the private key of the certificate in PEM format
    serialNumber String
    Device to attach the cert to
    sync Boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem string
    The certificate in PEM format
    edgeCustomCertId string
    The id of the custom certificate
    name string
    Name of the certificate
    principal EdgeCustomCertPrincipal
    The optional principal to use for this resource
    privateKeyPem string
    the private key of the certificate in PEM format
    serialNumber string
    Device to attach the cert to
    sync boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    cert_pem str
    The certificate in PEM format
    edge_custom_cert_id str
    The id of the custom certificate
    name str
    Name of the certificate
    principal EdgeCustomCertPrincipalArgs
    The optional principal to use for this resource
    private_key_pem str
    the private key of the certificate in PEM format
    serial_number str
    Device to attach the cert to
    sync bool
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync
    certPem String
    The certificate in PEM format
    edgeCustomCertId String
    The id of the custom certificate
    name String
    Name of the certificate
    principal Property Map
    The optional principal to use for this resource
    privateKeyPem String
    the private key of the certificate in PEM format
    serialNumber String
    Device to attach the cert to
    sync Boolean
    When set to true syncs the config after mutations. Default is true. Set this to false if you want to batch sync to your device using hsdp.EdgeSync

    Supporting Types

    EdgeCustomCertPrincipal, EdgeCustomCertPrincipalArgs

    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    ServicePrivateKey string
    UaaPassword string
    The UAA password to use
    UaaUsername string
    The UAA username to use
    Username string
    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    ServicePrivateKey string
    UaaPassword string
    The UAA password to use
    UaaUsername string
    The UAA username to use
    Username string
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    servicePrivateKey String
    uaaPassword String
    The UAA password to use
    uaaUsername String
    The UAA username to use
    username String
    endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment string
    oauth2ClientId string
    oauth2Password string
    password string
    region string
    Region to use. When not set, the provider config is used
    serviceId string
    servicePrivateKey string
    uaaPassword string
    The UAA password to use
    uaaUsername string
    The UAA username to use
    username string
    endpoint str
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment str
    oauth2_client_id str
    oauth2_password str
    password str
    region str
    Region to use. When not set, the provider config is used
    service_id str
    service_private_key str
    uaa_password str
    The UAA password to use
    uaa_username str
    The UAA username to use
    username str
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    servicePrivateKey String
    uaaPassword String
    The UAA password to use
    uaaUsername String
    The UAA username to use
    username String

    Import

    ing

    Importing a custom certificate is supported but not recommended.

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

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software