Class CreateKeyPairRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.CreateKeyPairRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateKeyPairRequest extends Ec2Request implements ToCopyableBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateKeyPairRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateKeyPairRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.KeyFormat
keyFormat()
The format of the key pair.String
keyFormatAsString()
The format of the key pair.String
keyName()
A unique name for the key pair.KeyType
keyType()
The type of key pair.String
keyTypeAsString()
The type of key pair.List<SdkField<?>>
sdkFields()
static Class<? extends CreateKeyPairRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to apply to the new key pair.CreateKeyPairRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
keyName
public final String keyName()
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
- Returns:
- A unique name for the key pair.
Constraints: Up to 255 ASCII characters
-
dryRun
public final 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 isUnauthorizedOperation
.- Returns:
- 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 isUnauthorizedOperation
.
-
keyType
public final KeyType keyType()
The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default:
rsa
If the service returns an enum value that is not available in the current SDK version,
keyType
will returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default:
rsa
- See Also:
KeyType
-
keyTypeAsString
public final String keyTypeAsString()
The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default:
rsa
If the service returns an enum value that is not available in the current SDK version,
keyType
will returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default:
rsa
- See Also:
KeyType
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to apply to the new key pair.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagSpecifications()
method.- Returns:
- The tags to apply to the new key pair.
-
keyFormat
public final KeyFormat keyFormat()
The format of the key pair.
Default:
pem
If the service returns an enum value that is not available in the current SDK version,
keyFormat
will returnKeyFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyFormatAsString()
.- Returns:
- The format of the key pair.
Default:
pem
- See Also:
KeyFormat
-
keyFormatAsString
public final String keyFormatAsString()
The format of the key pair.
Default:
pem
If the service returns an enum value that is not available in the current SDK version,
keyFormat
will returnKeyFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyFormatAsString()
.- Returns:
- The format of the key pair.
Default:
pem
- See Also:
KeyFormat
-
toBuilder
public CreateKeyPairRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateKeyPairRequest.Builder,CreateKeyPairRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateKeyPairRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateKeyPairRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-