Docs Packages
  1. Packages
  2. ngrok
  3. API Docs
  4. SshCertificateAuthority
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

ngrok.SshCertificateAuthority

Explore with Pulumi AI

ngrok logo
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ngrok = PiersKarsenbarg.Ngrok;

return await Deployment.RunAsync(() => 
{
    var example = new Ngrok.SshCertificateAuthority("example", new()
    {
        Description = "Staging Environment Hosts",
        PrivateKeyType = "ed25519",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ngrok.NewSshCertificateAuthority(ctx, "example", &ngrok.SshCertificateAuthorityArgs{
			Description:    pulumi.String("Staging Environment Hosts"),
			PrivateKeyType: pulumi.String("ed25519"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ngrok.SshCertificateAuthority;
import com.pulumi.ngrok.SshCertificateAuthorityArgs;
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 example = new SshCertificateAuthority("example", SshCertificateAuthorityArgs.builder()        
            .description("Staging Environment Hosts")
            .privateKeyType("ed25519")
            .build());

    }
}

    import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok

example = ngrok.SshCertificateAuthority("example",
    description="Staging Environment Hosts",
    private_key_type="ed25519")

    import * as pulumi from "@pulumi/pulumi";
import * as ngrok from "@pierskarsenbarg/ngrok";

const example = new ngrok.SshCertificateAuthority("example", {
    description: "Staging Environment Hosts",
    privateKeyType: "ed25519",
});

    resources:
  example:
    type: ngrok:SshCertificateAuthority
    properties:
      description: Staging Environment Hosts
      privateKeyType: ed25519

    Create SshCertificateAuthority Resource

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

    Constructor syntax

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

@overload
def SshCertificateAuthority(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            description: Optional[str] = None,
                            elliptic_curve: Optional[str] = None,
                            key_size: Optional[int] = None,
                            key_type: Optional[str] = None,
                            metadata: Optional[str] = None,
                            private_key_type: Optional[str] = None,
                            public_key: Optional[str] = None)
    func NewSshCertificateAuthority(ctx *Context, name string, args *SshCertificateAuthorityArgs, opts ...ResourceOption) (*SshCertificateAuthority, error)
    public SshCertificateAuthority(string name, SshCertificateAuthorityArgs? args = null, CustomResourceOptions? opts = null)
    public SshCertificateAuthority(String name, SshCertificateAuthorityArgs args)
public SshCertificateAuthority(String name, SshCertificateAuthorityArgs args, CustomResourceOptions options)

    type: ngrok:SshCertificateAuthority
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 SshCertificateAuthorityArgs
    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 SshCertificateAuthorityArgs
    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 SshCertificateAuthorityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshCertificateAuthorityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshCertificateAuthorityArgs
    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 sshCertificateAuthorityResource = new Ngrok.SshCertificateAuthority("sshCertificateAuthorityResource", new()
{
    Description = "string",
    EllipticCurve = "string",
    KeySize = 0,
    KeyType = "string",
    Metadata = "string",
    PrivateKeyType = "string",
    PublicKey = "string",
});

    example, err := ngrok.NewSshCertificateAuthority(ctx, "sshCertificateAuthorityResource", &ngrok.SshCertificateAuthorityArgs{
	Description:    pulumi.String("string"),
	EllipticCurve:  pulumi.String("string"),
	KeySize:        pulumi.Int(0),
	KeyType:        pulumi.String("string"),
	Metadata:       pulumi.String("string"),
	PrivateKeyType: pulumi.String("string"),
	PublicKey:      pulumi.String("string"),
})

    var sshCertificateAuthorityResource = new SshCertificateAuthority("sshCertificateAuthorityResource", SshCertificateAuthorityArgs.builder()        
    .description("string")
    .ellipticCurve("string")
    .keySize(0)
    .keyType("string")
    .metadata("string")
    .privateKeyType("string")
    .publicKey("string")
    .build());

    ssh_certificate_authority_resource = ngrok.SshCertificateAuthority("sshCertificateAuthorityResource",
    description="string",
    elliptic_curve="string",
    key_size=0,
    key_type="string",
    metadata="string",
    private_key_type="string",
    public_key="string")

    const sshCertificateAuthorityResource = new ngrok.SshCertificateAuthority("sshCertificateAuthorityResource", {
    description: "string",
    ellipticCurve: "string",
    keySize: 0,
    keyType: "string",
    metadata: "string",
    privateKeyType: "string",
    publicKey: "string",
});

    type: ngrok:SshCertificateAuthority
properties:
    description: string
    ellipticCurve: string
    keySize: 0
    keyType: string
    metadata: string
    privateKeyType: string
    publicKey: string

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

    Description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    EllipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    KeySize int
    the key size to use when creating an RSA key. one of 2048 or 4096
    KeyType string
    the type of private key for this SSH Certificate Authority
    Metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    PrivateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    PublicKey string
    raw public key for this SSH Certificate Authority
    Description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    EllipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    KeySize int
    the key size to use when creating an RSA key. one of 2048 or 4096
    KeyType string
    the type of private key for this SSH Certificate Authority
    Metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    PrivateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    PublicKey string
    raw public key for this SSH Certificate Authority
    description String
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve String
    the type of elliptic curve to use when creating an ECDSA key
    keySize Integer
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType String
    the type of private key for this SSH Certificate Authority
    metadata String
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType String
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey String
    raw public key for this SSH Certificate Authority
    description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    keySize number
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType string
    the type of private key for this SSH Certificate Authority
    metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey string
    raw public key for this SSH Certificate Authority
    description str
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    elliptic_curve str
    the type of elliptic curve to use when creating an ECDSA key
    key_size int
    the key size to use when creating an RSA key. one of 2048 or 4096
    key_type str
    the type of private key for this SSH Certificate Authority
    metadata str
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    private_key_type str
    the type of private key to generate. one of rsa, ecdsa, ed25519
    public_key str
    raw public key for this SSH Certificate Authority
    description String
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve String
    the type of elliptic curve to use when creating an ECDSA key
    keySize Number
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType String
    the type of private key for this SSH Certificate Authority
    metadata String
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType String
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey String
    raw public key for this SSH Certificate Authority

    Outputs

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

    Get an existing SshCertificateAuthority 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?: SshCertificateAuthorityState, opts?: CustomResourceOptions): SshCertificateAuthority
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        elliptic_curve: Optional[str] = None,
        key_size: Optional[int] = None,
        key_type: Optional[str] = None,
        metadata: Optional[str] = None,
        private_key_type: Optional[str] = None,
        public_key: Optional[str] = None) -> SshCertificateAuthority
    func GetSshCertificateAuthority(ctx *Context, name string, id IDInput, state *SshCertificateAuthorityState, opts ...ResourceOption) (*SshCertificateAuthority, error)
    public static SshCertificateAuthority Get(string name, Input<string> id, SshCertificateAuthorityState? state, CustomResourceOptions? opts = null)
    public static SshCertificateAuthority get(String name, Output<String> id, SshCertificateAuthorityState 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:
    Description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    EllipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    KeySize int
    the key size to use when creating an RSA key. one of 2048 or 4096
    KeyType string
    the type of private key for this SSH Certificate Authority
    Metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    PrivateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    PublicKey string
    raw public key for this SSH Certificate Authority
    Description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    EllipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    KeySize int
    the key size to use when creating an RSA key. one of 2048 or 4096
    KeyType string
    the type of private key for this SSH Certificate Authority
    Metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    PrivateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    PublicKey string
    raw public key for this SSH Certificate Authority
    description String
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve String
    the type of elliptic curve to use when creating an ECDSA key
    keySize Integer
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType String
    the type of private key for this SSH Certificate Authority
    metadata String
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType String
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey String
    raw public key for this SSH Certificate Authority
    description string
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve string
    the type of elliptic curve to use when creating an ECDSA key
    keySize number
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType string
    the type of private key for this SSH Certificate Authority
    metadata string
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType string
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey string
    raw public key for this SSH Certificate Authority
    description str
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    elliptic_curve str
    the type of elliptic curve to use when creating an ECDSA key
    key_size int
    the key size to use when creating an RSA key. one of 2048 or 4096
    key_type str
    the type of private key for this SSH Certificate Authority
    metadata str
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    private_key_type str
    the type of private key to generate. one of rsa, ecdsa, ed25519
    public_key str
    raw public key for this SSH Certificate Authority
    description String
    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
    ellipticCurve String
    the type of elliptic curve to use when creating an ECDSA key
    keySize Number
    the key size to use when creating an RSA key. one of 2048 or 4096
    keyType String
    the type of private key for this SSH Certificate Authority
    metadata String
    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
    privateKeyType String
    the type of private key to generate. one of rsa, ecdsa, ed25519
    publicKey String
    raw public key for this SSH Certificate Authority

    Package Details

    Repository
    ngrok pierskarsenbarg/pulumi-ngrok
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ngrok Terraform Provider.
    ngrok logo
    ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
    pierskarsenbarg/pulumi-ngrok