Struct aws_sdk_ec2::client::fluent_builders::CreateKeyPair

pub struct CreateKeyPair { /* private fields */ }

Fluent builder constructing a request to CreateKeyPair.

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK 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 Elastic Compute Cloud User Guide.

Implementations

impl CreateKeyPair

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateKeyPair, AwsResponseRetryClassifier>, SdkError<CreateKeyPairError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateKeyPairOutput, SdkError<CreateKeyPairError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn key_name(self, input: impl Into<String>) -> Self

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

pub fn set_key_name(self, input: Option<String>) -> Self

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

pub fn dry_run(self, input: bool) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

pub fn key_type(self, input: KeyType) -> Self

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

Default: rsa

pub fn set_key_type(self, input: Option<KeyType>) -> Self

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

Default: rsa

pub fn tag_specifications(self, input: TagSpecification) -> Self

Appends an item to TagSpecifications.

To override the contents of this collection use set_tag_specifications.

The tags to apply to the new key pair.

pub fn set_tag_specifications(self, input: Option<Vec<TagSpecification>>) -> Self

The tags to apply to the new key pair.

pub fn key_format(self, input: KeyFormat) -> Self

The format of the key pair.

Default: pem

pub fn set_key_format(self, input: Option<KeyFormat>) -> Self

The format of the key pair.

Default: pem

Trait Implementations

impl Clone for CreateKeyPair

fn clone(&self) -> CreateKeyPair

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateKeyPair

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.