2023-03-15 16:14:29 -04:00
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
2024-01-16 10:41:11 -05:00
2023-03-15 16:14:29 -04:00
/**
* Before running this C++ code example, set up your development environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html
*
* For information on the structure of the code examples and how to build and run the examples, see
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html.
*
**/
2021-11-15 13:15:43 +00:00
// snippet-start:[ec2.cpp.delete_key_pair.inc]
# include <aws/ec2/EC2Client.h>
# include <aws/ec2/model/DeleteKeyPairRequest.h>
# include <iostream>
// snippet-end:[ec2.cpp.delete_key_pair.inc]
2023-03-15 16:14:29 -04:00
# include "ec2_samples.h"
2021-11-15 13:15:43 +00:00
2024-08-02 10:24:50 -04:00
// snippet-start:[cpp.example_code.ec2.DeleteKeyPair]
2023-03-15 16:14:29 -04:00
//! Delete an Amazon Elastic Compute Cloud (Amazon EC2) instance key pair.
/*!
\param keyPairName: A name for a key pair.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
2021-11-15 13:15:43 +00:00
*/
2023-03-15 16:14:29 -04:00
2024-08-02 10:24:50 -04:00
bool AwsDoc : : EC2 : : deleteKeyPair ( const Aws : : String & keyPairName ,
2023-03-15 16:14:29 -04:00
const Aws : : Client : : ClientConfiguration & clientConfiguration ) {
// snippet-start:[ec2.cpp.delete_key_pair.code]
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 ;
2024-08-02 10:24:50 -04:00
} else {
2023-03-15 16:14:29 -04:00
std : : cout < < " Successfully deleted key pair named " < < keyPairName < <
std : : endl ;
}
// snippet-end:[ec2.cpp.delete_key_pair.code]
return outcome . IsSuccess ( ) ;
}
2024-08-02 10:24:50 -04:00
// snippet-end:[cpp.example_code.ec2.DeleteKeyPair]
2023-03-15 16:14:29 -04:00
/*
* main function
*
* Usage: 'run_delete_key_pair <key_pair_name>'
*
* Prerequisites: A key pair to delete.
*
*/
# ifndef TESTING_BUILD
int main ( int argc , char * * argv ) {
if ( argc ! = 2 ) {
std : : cout < < " run_delete_key_pair <key_pair_name> "
< < std : : endl ;
2021-11-15 13:15:43 +00:00
return 1 ;
}
Aws : : SDKOptions options ;
Aws : : InitAPI ( options ) ;
{
2023-03-15 16:14:29 -04:00
Aws : : Client : : ClientConfiguration clientConfig ;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws : : String keyPairName = argv [ 1 ] ;
2024-08-02 10:24:50 -04:00
AwsDoc : : EC2 : : deleteKeyPair ( keyPairName , clientConfig ) ;
2021-11-15 13:15:43 +00:00
}
Aws : : ShutdownAPI ( options ) ;
return 0 ;
}
2023-03-15 16:14:29 -04:00
# endif // TESTING_BUILD
