pulumi-aws-kotlin/com.pulumi.aws.lightsail.kotlin/KeyPairArgs

KeyPairArgs

data class KeyPairArgs(val name: Output<String>? = null, val namePrefix: Output<String>? = null, val pgpKey: Output<String>? = null, val publicKey: Output<String>? = null) : ConvertibleToJava<KeyPairArgs>

Provides a Lightsail Key Pair, for use with Lightsail Instances. These key pairs are separate from EC2 Key Pairs, and must be created or imported for use with Lightsail.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see "Regions and Availability Zones in Amazon Lightsail" for more details

Example Usage

Create New Key Pair

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.KeyPair;
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 lgKeyPair = new KeyPair("lgKeyPair");
    }
}

Create New Key Pair with PGP Encrypted Private Key

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.KeyPair;
import com.pulumi.aws.lightsail.KeyPairArgs;
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 lgKeyPair = new KeyPair("lgKeyPair", KeyPairArgs.builder()
            .pgpKey("keybase:keybaseusername")
            .build());
    }
}

Existing Public Key Import

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.KeyPair;
import com.pulumi.aws.lightsail.KeyPairArgs;
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 lgKeyPair = new KeyPair("lgKeyPair", KeyPairArgs.builder()
            .publicKey(Files.readString(Paths.get("~/.ssh/id_rsa.pub")))
            .build());
    }
}

Import

Lightsail Key Pairs cannot be imported, because the private and public key are only available on initial creation.

Constructors

KeyPairArgs

constructor(name: Output<String>? = null, namePrefix: Output<String>? = null, pgpKey: Output<String>? = null, publicKey: Output<String>? = null)

Properties

name

val name: Output<String>? = null

The name of the Lightsail Key Pair. If omitted, a unique name will be generated by this provider

namePrefix

val namePrefix: Output<String>? = null

pgpKey

val pgpKey: Output<String>? = null

An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair

publicKey

val publicKey: Output<String>? = null

The public key material. This public key will be imported into Lightsail

Functions

toJava

open override fun toJava(): KeyPairArgs