使用 AWS SDK 删除 Amazon EC2 安全密钥对

以下代码示例显示如何删除 Amazon EC2 安全密钥对。

操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：

• 开始使用实例

.NET

AWS SDK for .NET

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

    /// <summary>
    /// Delete an Amazon EC2 key pair.
    /// </summary>
    /// <param name="keyPairName">The name of the key pair to delete.</param>
    /// <returns>A Boolean value indicating the success of the action.</returns>
    public async Task<bool> DeleteKeyPair(string keyPairName)
    {
        try
        {
            await _amazonEC2.DeleteKeyPairAsync(new DeleteKeyPairRequest(keyPairName)).ConfigureAwait(false);
            return true;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Couldn't delete the key pair because: {ex.Message}");
            return false;
        }
    }

    /// <summary>
    /// Delete the temporary file where the key pair information was saved.
    /// </summary>
    /// <param name="tempFileName">The path to the temporary file.</param>
    public void DeleteTempFile(string tempFileName)
    {
        if (File.Exists(tempFileName))
        {
            File.Delete(tempFileName);
        }
    }

• 有关 API 详细信息，请参阅《AWS SDK for .NET API 参考》中的 DeleteKeyPair。

C++

适用于 C++ 的 SDK

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

    Aws::EC2::EC2Client ec2Client(clientConfiguration);
    Aws::EC2::Model::DeleteKeyPairRequest request;

    request.SetKeyName(keyPairName);
    const Aws::EC2::Model::DeleteKeyPairOutcome outcome = ec2Client.DeleteKeyPair(
            request);

    if (!outcome.IsSuccess()) {
        std::cerr << "Failed to delete key pair " << keyPairName <<
                  ":" << outcome.GetError().GetMessage() << std::endl;
    }
    else {
        std::cout << "Successfully deleted key pair named " << keyPairName <<
                  std::endl;
    }

• 有关 API 详细信息，请参阅《AWS SDK for C++ API 参考》中的 DeleteKeyPair。

Java

SDK for Java 2.x

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

    public static void deleteKeys(Ec2Client ec2, String keyPair) {

        try {
            DeleteKeyPairRequest request = DeleteKeyPairRequest.builder()
                .keyName(keyPair)
                .build();

            ec2.deleteKeyPair(request);
            System.out.printf("Successfully deleted key pair named %s", keyPair);

        } catch (Ec2Exception e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }

• 有关 API 详细信息，请参阅《AWS SDK for Java 2.x API 参考》中的 DeleteKeyPair。

JavaScript

SDK for JavaScript (v3)

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

import { DeleteKeyPairCommand } from "@aws-sdk/client-ec2";

import { client } from "../libs/client.js";

export const main = async () => {
  const command = new DeleteKeyPairCommand({
    KeyName: "KEY_PAIR_NAME",
  });

  try {
    await client.send(command);
    console.log("Successfully deleted key pair.");
  } catch (err) {
    console.error(err);
  }
};

• 有关 API 详细信息，请参阅《AWS SDK for JavaScript API 参考》中的 DeleteKeyPair。

Kotlin

SDK for Kotlin

注意

这是适用于预览版中特征的预发行文档。本文档随时可能更改。

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

suspend fun deleteKeys(keyPair: String?) {

    val request = DeleteKeyPairRequest {
        keyName = keyPair
    }

    Ec2Client { region = "us-west-2" }.use { ec2 ->
        ec2.deleteKeyPair(request)
        println("Successfully deleted key pair named $keyPair")
    }
}

• 有关 API 详细信息，请参阅《AWS SDK for Kotlin API 参考》中的 DeleteKeyPair。

Python

适用于 Python (Boto3) 的 SDK

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

class KeyPairWrapper:
    """Encapsulates Amazon Elastic Compute Cloud (Amazon EC2) key pair actions."""

    def __init__(self, ec2_resource, key_file_dir, key_pair=None):
        """
        :param ec2_resource: A Boto3 Amazon EC2 resource. This high-level resource
                             is used to create additional high-level objects
                             that wrap low-level Amazon EC2 service actions.
        :param key_file_dir: The folder where the private key information is stored.
                             This should be a secure folder.
        :param key_pair: A Boto3 KeyPair object. This is a high-level object that
                         wraps key pair actions.
        """
        self.ec2_resource = ec2_resource
        self.key_pair = key_pair
        self.key_file_path = None
        self.key_file_dir = key_file_dir

    @classmethod
    def from_resource(cls):
        ec2_resource = boto3.resource("ec2")
        return cls(ec2_resource, tempfile.TemporaryDirectory())


    def delete(self):
        """
        Deletes a key pair.
        """
        if self.key_pair is None:
            logger.info("No key pair to delete.")
            return

        key_name = self.key_pair.name
        try:
            self.key_pair.delete()
            self.key_pair = None
        except ClientError as err:
            logger.error(
                "Couldn't delete key %s. Here's why: %s : %s",
                key_name,
                err.response["Error"]["Code"],
                err.response["Error"]["Message"],
            )
            raise

• 有关 API 详细信息，请参阅《AWS SDK for Python（Boto3）API 参考》中的 DeleteKeyPair。

SAP ABAP

适用于 SAP ABAP 的 SDK

注意

在 GitHub 上查看更多内容。在 AWS 代码示例存储库 中查找完整示例，了解如何进行设置和运行。

    TRY.
        lo_ec2->deletekeypair( iv_keyname = iv_key_name ).
        MESSAGE 'Amazon EC2 key pair deleted.' TYPE 'I'.
      CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
        DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
        MESSAGE lv_error TYPE 'E'.
    ENDTRY.

• 有关 API 详细信息，请参阅《AWS SDK for SAP ABAP API 参考》中的 DeleteKeyPair。

有关 AWS 软件开发工具包开发人员指南和代码示例的完整列表，请参阅 将 Amazon EC2 与 AWS SDK 结合使用。本主题还包括有关入门的信息以及有关先前的软件开发工具包版本的详细信息。