interface CfnKeyPairProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.CfnKeyPairProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnKeyPairProps
Java	software.amazon.awscdk.services.ec2.CfnKeyPairProps
Python	aws_cdk.aws_ec2.CfnKeyPairProps
TypeScript	aws-cdk-lib » aws_ec2 » CfnKeyPairProps

Properties for defining a CfnKeyPair.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnKeyPairProps: ec2.CfnKeyPairProps = {
  keyName: 'keyName',

  // the properties below are optional
  keyFormat: 'keyFormat',
  keyType: 'keyType',
  publicKeyMaterial: 'publicKeyMaterial',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
keyName	string	A unique name for the key pair.
keyFormat?	string	The format of the key pair.
keyType?	string	The type of key pair. Note that ED25519 keys are not supported for Windows instances.
publicKeyMaterial?	string	The public key material.
tags?	CfnTag[]	The tags to apply to the key pair.

---

keyName

Type: string

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname

---

keyFormat?

Type: string (optional, default: "pem")

The format of the key pair.

Default: pem

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyformat

---

keyType?

Type: string (optional, default: "rsa")

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

If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.

Default: rsa

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype

---

publicKeyMaterial?

Type: string (optional)

The public key material.

The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial

---

tags?

Type: CfnTag[] (optional)

The tags to apply to the key pair.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-tags