Package software.amazon.awssdk.services.ec2.model

Interface CreateKeyPairRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>, Ec2Request.Builder, SdkBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateKeyPairRequest

public static interface CreateKeyPairRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>

Method Summary

Modifier and Type	Method	Description
CreateKeyPairRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
CreateKeyPairRequest.Builder	keyFormat(String keyFormat)	The format of the key pair.
CreateKeyPairRequest.Builder	keyFormat(KeyFormat keyFormat)	The format of the key pair.
CreateKeyPairRequest.Builder	keyName(String keyName)	A unique name for the key pair.
CreateKeyPairRequest.Builder	keyType(String keyType)	The type of key pair.
CreateKeyPairRequest.Builder	keyType(KeyType keyType)	The type of key pair.
CreateKeyPairRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateKeyPairRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateKeyPairRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications)	The tags to apply to the new key pair.
CreateKeyPairRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)	The tags to apply to the new key pair.
CreateKeyPairRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications)	The tags to apply to the new key pair.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

keyName

CreateKeyPairRequest.Builder keyName(String keyName)

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Parameters:

keyName - A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Returns:

Returns a reference to this object so that method calls can be chained together.

dryRun

CreateKeyPairRequest.Builder dryRun(Boolean dryRun)

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.

Parameters:

dryRun - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyType

CreateKeyPairRequest.Builder keyType(String keyType)

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

Default: rsa

Parameters:

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

Default: rsa

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyType
• KeyType

keyType

CreateKeyPairRequest.Builder keyType(KeyType keyType)

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

Default: rsa

Parameters:

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

Default: rsa

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyType
• KeyType

tagSpecifications

CreateKeyPairRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the new key pair.

Parameters:

tagSpecifications - The tags to apply to the new key pair.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateKeyPairRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the new key pair.

Parameters:

tagSpecifications - The tags to apply to the new key pair.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateKeyPairRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the new key pair.

This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tagSpecifications(java.util.Collection<TagSpecification>)

keyFormat

CreateKeyPairRequest.Builder keyFormat(String keyFormat)

The format of the key pair.

Default: pem

Parameters:

keyFormat - The format of the key pair.

Default: pem

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyFormat
• KeyFormat

keyFormat

CreateKeyPairRequest.Builder keyFormat(KeyFormat keyFormat)

The format of the key pair.

Default: pem

Parameters:

keyFormat - The format of the key pair.

Default: pem

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyFormat
• KeyFormat

overrideConfiguration

CreateKeyPairRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateKeyPairRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.