Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. ngrok
  3. API Docs
  4. SshUserCertificate
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

ngrok.SshUserCertificate

Explore with Pulumi AI

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

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Ngrok.SshUserCertificate("example", new()
    {
        Description = "temporary access to staging machine",
        Principals = new[]
        {
            "ec2-user",
            "root",
        },
        PublicKey = "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop",
        SshCertificateAuthorityId = "sshca_25auH5JtiUPW9eMiXYzujvcpkGW",
        ValidUntil = "2022-05-26T08:23:47Z",
    });

});

    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.NewSshUserCertificate(ctx, "example", &ngrok.SshUserCertificateArgs{
			Description: pulumi.String("temporary access to staging machine"),
			Principals: pulumi.StringArray{
				pulumi.String("ec2-user"),
				pulumi.String("root"),
			},
			PublicKey:                 pulumi.String("ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop"),
			SshCertificateAuthorityId: pulumi.String("sshca_25auH5JtiUPW9eMiXYzujvcpkGW"),
			ValidUntil:                pulumi.String("2022-05-26T08:23:47Z"),
		})
		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.SshUserCertificate;
import com.pulumi.ngrok.SshUserCertificateArgs;
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 SshUserCertificate("example", SshUserCertificateArgs.builder()        
            .description("temporary access to staging machine")
            .principals(            
                "ec2-user",
                "root")
            .publicKey("ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop")
            .sshCertificateAuthorityId("sshca_25auH5JtiUPW9eMiXYzujvcpkGW")
            .validUntil("2022-05-26T08:23:47Z")
            .build());

    }
}

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

const example = new ngrok.SshUserCertificate("example", {
    description: "temporary access to staging machine",
    principals: [
        "ec2-user",
        "root",
    ],
    publicKey: "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop",
    sshCertificateAuthorityId: "sshca_25auH5JtiUPW9eMiXYzujvcpkGW",
    validUntil: "2022-05-26T08:23:47Z",
});

    import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok

example = ngrok.SshUserCertificate("example",
    description="temporary access to staging machine",
    principals=[
        "ec2-user",
        "root",
    ],
    public_key="ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop",
    ssh_certificate_authority_id="sshca_25auH5JtiUPW9eMiXYzujvcpkGW",
    valid_until="2022-05-26T08:23:47Z")

    resources:
  example:
    type: ngrok:SshUserCertificate
    properties:
      description: temporary access to staging machine
      principals:
        - ec2-user
        - root
      publicKey: ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop
      sshCertificateAuthorityId: sshca_25auH5JtiUPW9eMiXYzujvcpkGW
      validUntil: 2022-05-26T08:23:47Z

    Create SshUserCertificate Resource

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

    Constructor syntax

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

@overload
def SshUserCertificate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       public_key: Optional[str] = None,
                       ssh_certificate_authority_id: Optional[str] = None,
                       certificate: Optional[str] = None,
                       critical_options: Optional[Mapping[str, str]] = None,
                       description: Optional[str] = None,
                       extensions: Optional[Mapping[str, str]] = None,
                       key_type: Optional[str] = None,
                       metadata: Optional[str] = None,
                       principals: Optional[Sequence[str]] = None,
                       valid_after: Optional[str] = None,
                       valid_until: Optional[str] = None)
    func NewSshUserCertificate(ctx *Context, name string, args SshUserCertificateArgs, opts ...ResourceOption) (*SshUserCertificate, error)
    public SshUserCertificate(string name, SshUserCertificateArgs args, CustomResourceOptions? opts = null)
    public SshUserCertificate(String name, SshUserCertificateArgs args)
public SshUserCertificate(String name, SshUserCertificateArgs args, CustomResourceOptions options)

    type: ngrok:SshUserCertificate
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 SshUserCertificateArgs
    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 SshUserCertificateArgs
    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 SshUserCertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshUserCertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshUserCertificateArgs
    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 sshUserCertificateResource = new Ngrok.SshUserCertificate("sshUserCertificateResource", new()
{
    PublicKey = "string",
    SshCertificateAuthorityId = "string",
    Certificate = "string",
    CriticalOptions = 
    {
        { "string", "string" },
    },
    Description = "string",
    Extensions = 
    {
        { "string", "string" },
    },
    KeyType = "string",
    Metadata = "string",
    Principals = new[]
    {
        "string",
    },
    ValidAfter = "string",
    ValidUntil = "string",
});

    example, err := ngrok.NewSshUserCertificate(ctx, "sshUserCertificateResource", &ngrok.SshUserCertificateArgs{
	PublicKey:                 pulumi.String("string"),
	SshCertificateAuthorityId: pulumi.String("string"),
	Certificate:               pulumi.String("string"),
	CriticalOptions: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Extensions: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KeyType:  pulumi.String("string"),
	Metadata: pulumi.String("string"),
	Principals: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValidAfter: pulumi.String("string"),
	ValidUntil: pulumi.String("string"),
})

    var sshUserCertificateResource = new SshUserCertificate("sshUserCertificateResource", SshUserCertificateArgs.builder()
    .publicKey("string")
    .sshCertificateAuthorityId("string")
    .certificate("string")
    .criticalOptions(Map.of("string", "string"))
    .description("string")
    .extensions(Map.of("string", "string"))
    .keyType("string")
    .metadata("string")
    .principals("string")
    .validAfter("string")
    .validUntil("string")
    .build());

    ssh_user_certificate_resource = ngrok.SshUserCertificate("sshUserCertificateResource",
    public_key="string",
    ssh_certificate_authority_id="string",
    certificate="string",
    critical_options={
        "string": "string",
    },
    description="string",
    extensions={
        "string": "string",
    },
    key_type="string",
    metadata="string",
    principals=["string"],
    valid_after="string",
    valid_until="string")

    const sshUserCertificateResource = new ngrok.SshUserCertificate("sshUserCertificateResource", {
    publicKey: "string",
    sshCertificateAuthorityId: "string",
    certificate: "string",
    criticalOptions: {
        string: "string",
    },
    description: "string",
    extensions: {
        string: "string",
    },
    keyType: "string",
    metadata: "string",
    principals: ["string"],
    validAfter: "string",
    validUntil: "string",
});

    type: ngrok:SshUserCertificate
properties:
    certificate: string
    criticalOptions:
        string: string
    description: string
    extensions:
        string: string
    keyType: string
    metadata: string
    principals:
        - string
    publicKey: string
    sshCertificateAuthorityId: string
    validAfter: string
    validUntil: string

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

    PublicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    SshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    Certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    CriticalOptions Dictionary<string, string>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    Description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    Extensions Dictionary<string, string>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    KeyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    Metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    Principals List<string>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    ValidAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    ValidUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    PublicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    SshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    Certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    CriticalOptions map[string]string
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    Description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    Extensions map[string]string
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    KeyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    Metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    Principals []string
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    ValidAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    ValidUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    publicKey String
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId String
    the ssh certificate authority that is used to sign this ssh user certificate
    certificate String
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions Map<String,String>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description String
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Map<String,String>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType String
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata String
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals List<String>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    validAfter String
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil String
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    publicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions {[key: string]: string}
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions {[key: string]: string}
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals string[]
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    validAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    public_key str
    a public key in OpenSSH Authorized Keys format that this certificate signs
    ssh_certificate_authority_id str
    the ssh certificate authority that is used to sign this ssh user certificate
    certificate str
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    critical_options Mapping[str, str]
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description str
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Mapping[str, str]
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    key_type str
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata str
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals Sequence[str]
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    valid_after str
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    valid_until str
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    publicKey String
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId String
    the ssh certificate authority that is used to sign this ssh user certificate
    certificate String
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions Map<String>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description String
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Map<String>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType String
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata String
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals List<String>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    validAfter String
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil String
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

    Outputs

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

    Get an existing SshUserCertificate 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?: SshUserCertificateState, opts?: CustomResourceOptions): SshUserCertificate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate: Optional[str] = None,
        critical_options: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        extensions: Optional[Mapping[str, str]] = None,
        key_type: Optional[str] = None,
        metadata: Optional[str] = None,
        principals: Optional[Sequence[str]] = None,
        public_key: Optional[str] = None,
        ssh_certificate_authority_id: Optional[str] = None,
        valid_after: Optional[str] = None,
        valid_until: Optional[str] = None) -> SshUserCertificate
    func GetSshUserCertificate(ctx *Context, name string, id IDInput, state *SshUserCertificateState, opts ...ResourceOption) (*SshUserCertificate, error)
    public static SshUserCertificate Get(string name, Input<string> id, SshUserCertificateState? state, CustomResourceOptions? opts = null)
    public static SshUserCertificate get(String name, Output<String> id, SshUserCertificateState state, CustomResourceOptions options)
    resources:  _:    type: ngrok:SshUserCertificate    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:
    Certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    CriticalOptions Dictionary<string, string>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    Description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    Extensions Dictionary<string, string>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    KeyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    Metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    Principals List<string>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    PublicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    SshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    ValidAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    ValidUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    Certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    CriticalOptions map[string]string
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    Description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    Extensions map[string]string
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    KeyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    Metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    Principals []string
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    PublicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    SshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    ValidAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    ValidUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    certificate String
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions Map<String,String>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description String
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Map<String,String>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType String
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata String
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals List<String>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    publicKey String
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId String
    the ssh certificate authority that is used to sign this ssh user certificate
    validAfter String
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil String
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    certificate string
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions {[key: string]: string}
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description string
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions {[key: string]: string}
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType string
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata string
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals string[]
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    publicKey string
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId string
    the ssh certificate authority that is used to sign this ssh user certificate
    validAfter string
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil string
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    certificate str
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    critical_options Mapping[str, str]
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description str
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Mapping[str, str]
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    key_type str
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata str
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals Sequence[str]
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    public_key str
    a public key in OpenSSH Authorized Keys format that this certificate signs
    ssh_certificate_authority_id str
    the ssh certificate authority that is used to sign this ssh user certificate
    valid_after str
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    valid_until str
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
    certificate String
    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
    criticalOptions Map<String>
    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
    description String
    human-readable description of this SSH User Certificate. optional, max 255 bytes.
    extensions Map<String>
    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
    keyType String
    the key type of the public_key, one of rsa, ecdsa or ed25519
    metadata String
    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
    principals List<String>
    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
    publicKey String
    a public key in OpenSSH Authorized Keys format that this certificate signs
    sshCertificateAuthorityId String
    the ssh certificate authority that is used to sign this ssh user certificate
    validAfter String
    the time when the ssh host certificate becomes valid, in RFC 3339 format.
    validUntil String
    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

    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