aws-cdk-lib.aws_ec2.KeyPairProps

KeyPairProps Struct

The properties of a Key Pair.

KeyPairProps

extends

• ResourceProps

used as props by

• KeyPair

Source

aws-ec2/lib/key-pair.ts

Type last changed

v2.116.0 · 22 Dec 2023

Example

declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;

const keyPair = new ec2.KeyPair(this, 'KeyPair', {
  type: ec2.KeyPairType.ED25519,
  format: ec2.KeyPairFormat.PEM,
});
const instance = new ec2.Instance(this, 'Instance', {
  vpc,
  instanceType,
  machineImage: ec2.MachineImage.latestAmazonLinux2023(),
  // Use the custom key pair
  keyPair,
});

Properties

accountstringaccountstraccountStringAccountstringAccount*string#

The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string#

ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

formatKeyPairFormatformatKeyPairFormatformatKeyPairFormatFormatKeyPairFormatFormatKeyPairFormat= PEM#

The format of the key pair.

keyPairNamestringkey_pair_namestrkeyPairNameStringKeyPairNamestringKeyPairName*string#

A unique name for the key pair.

Default: A generated name

physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string#

The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

publicKeyMaterialstringpublic_key_materialstrpublicKeyMaterialStringPublicKeyMaterialstringPublicKeyMaterial*string#

The public key material.

Default: a public and private key will be generated

If this is provided the key is considered "imported". For imported keys, it is assumed that you already have the private key material so the private key material will not be returned or stored in AWS Systems Manager Parameter Store.

regionstringregionstrregionStringRegionstringRegion*string#

The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

typeKeyPairTypetypeKeyPairTypetypeKeyPairTypeTypeKeyPairTypeTypeKeyPairType#

The type of key pair.

Default: RSA (ignored if keyMaterial is provided)