import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import type { CreateKeyPairRequest, KeyPair } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateKeyPairCommand}. */ export interface CreateKeyPairCommandInput extends CreateKeyPairRequest { } /** * @public * * The output of {@link CreateKeyPairCommand}. */ export interface CreateKeyPairCommandOutput extends KeyPair, __MetadataBearer { } declare const CreateKeyPairCommand_base: { new (input: CreateKeyPairCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateKeyPairCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the * specified format. Amazon EC2 stores the public key and displays the private * key for you to save to a file. The private key is returned as an unencrypted PEM encoded * PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a * key with the specified name already exists, Amazon EC2 returns an error.

*

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. * If you prefer, you can create your own key pair using a third-party tool and upload it * to any Region using ImportKeyPair.

*

You can have up to 5,000 key pairs per Amazon Web Services Region.

*

For more information, see Amazon EC2 key pairs in the * Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EC2Client, CreateKeyPairCommand } from "@aws-sdk/client-ec2"; // ES Modules import * // const { EC2Client, CreateKeyPairCommand } = require("@aws-sdk/client-ec2"); // CommonJS import * // import type { EC2ClientConfig } from "@aws-sdk/client-ec2"; * const config = {}; // type is EC2ClientConfig * const client = new EC2Client(config); * const input = { // CreateKeyPairRequest * KeyName: "STRING_VALUE", // required * KeyType: "rsa" || "ed25519", * TagSpecifications: [ // TagSpecificationList * { // TagSpecification * ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "image-usage-report" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "outpost-lag" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "service-link-virtual-interface" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-metering-policy" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "vpc-encryption-control" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token" || "capacity-block" || "mac-modification-task" || "ipam-prefix-list-resolver" || "ipam-policy" || "ipam-prefix-list-resolver-target" || "secondary-interface" || "secondary-network" || "secondary-subnet" || "capacity-manager-data-export" || "vpn-concentrator", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * ], * KeyFormat: "pem" || "ppk", * DryRun: true || false, * }; * const command = new CreateKeyPairCommand(input); * const response = await client.send(command); * // { // KeyPair * // KeyPairId: "STRING_VALUE", * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // KeyName: "STRING_VALUE", * // KeyFingerprint: "STRING_VALUE", * // KeyMaterial: "STRING_VALUE", * // }; * * ``` * * @param CreateKeyPairCommandInput - {@link CreateKeyPairCommandInput} * @returns {@link CreateKeyPairCommandOutput} * @see {@link CreateKeyPairCommandInput} for command's `input` shape. * @see {@link CreateKeyPairCommandOutput} for command's `response` shape. * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. * * @throws {@link EC2ServiceException} *

Base exception class for all service exceptions from EC2 service.

* * * @example To create a key pair * ```javascript * // This example creates a key pair named my-key-pair. * const input = { * KeyName: "my-key-pair" * }; * const command = new CreateKeyPairCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class CreateKeyPairCommand extends CreateKeyPairCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateKeyPairRequest; output: KeyPair; }; sdk: { input: CreateKeyPairCommandInput; output: CreateKeyPairCommandOutput; }; }; }