KeyPair L2 construct
An EC2 Key Pair.
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,
});
# vpc: ec2.Vpc
# instance_type: ec2.InstanceType
key_pair = ec2.KeyPair(self, "KeyPair",
type=ec2.KeyPairType.ED25519,
format=ec2.KeyPairFormat.PEM
)
instance = ec2.Instance(self, "Instance",
vpc=vpc,
instance_type=instance_type,
machine_image=ec2.MachineImage.latest_amazon_linux2023(),
# Use the custom key pair
key_pair=key_pair
)
Vpc vpc;
InstanceType instanceType;
KeyPair keyPair = KeyPair.Builder.create(this, "KeyPair")
.type(KeyPairType.ED25519)
.format(KeyPairFormat.PEM)
.build();
Instance instance = Instance.Builder.create(this, "Instance")
.vpc(vpc)
.instanceType(instanceType)
.machineImage(MachineImage.latestAmazonLinux2023())
// Use the custom key pair
.keyPair(keyPair)
.build();
// Install: dotnet add package Amazon.CDK.Lib
Vpc vpc;
InstanceType instanceType;
var keyPair = new KeyPair(this, "KeyPair", new KeyPairProps {
Type = KeyPairType.ED25519,
Format = KeyPairFormat.PEM
});
var instance = new Instance(this, "Instance", new InstanceProps {
Vpc = vpc,
InstanceType = instanceType,
MachineImage = MachineImage.LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair = keyPair
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc
var instanceType InstanceType
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
Type: ec2.KeyPairType_ED25519,
Format: ec2.KeyPairFormat_PEM,
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair: KeyPair,
})
Initializer
new KeyPair(scope: Construct, id: string, props?: KeyPairProps)
KeyPair(scope: Construct, id: str, props: typing.Optional[KeyPairProps] = None)
new KeyPair(Construct scope, String id, KeyPairProps props)
new KeyPair(Construct scope, string id, KeyPairProps? props = null)
NewKeyPair(Scope Construct, Id *string, Props KeyPairProps)
Construct Props
default
Default: the resource is in the same account as the stack it belongs to
environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#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.
default
Default: take environment from account, region parameters, or use Stack environment.
formatKeyPairFormatformatKeyPairFormatformatKeyPairFormatFormatKeyPairFormatFormatKeyPairFormat= PEM#keyPairNamestringkey_pair_namestrkeyPairNameStringKeyPairNamestringKeyPairName*string= A generated name#physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#notes · default
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis 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.
Default: The physical name will be allocated by CloudFormation at deployment time
publicKeyMaterialstringpublic_key_materialstrpublicKeyMaterialStringPublicKeyMaterialstringPublicKeyMaterial*string= a public and private key will be…#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.
default
Default: a public and private key will be generated
default
Default: the resource is in the same region as the stack it belongs to
typeKeyPairTypetypeKeyPairTypetypeKeyPairTypeTypeKeyPairTypeTypeKeyPairType= RSA (ignored if keyMaterial is p…#default
Default: RSA (ignored if keyMaterial is provided)
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
formatKeyPairFormatformatKeyPairFormatformatKeyPairFormatFormatKeyPairFormatFormatKeyPairFormatrequired#hasImportedMaterialbooleanhas_imported_materialboolhasImportedMaterialBooleanHasImportedMaterialboolHasImportedMaterial*boolrequired#Keys with imported material do not have their private key material stored or returned automatically.
keyPairFingerprintstringkey_pair_fingerprintstrkeyPairFingerprintStringKeyPairFingerprintstringKeyPairFingerprint*stringrequired#keyPairRefKeyPairReferencekey_pair_refKeyPairReferencekeyPairRefKeyPairReferenceKeyPairRefKeyPairReferenceKeyPairRefKeyPairReferencerequired#privateKeyIStringParameterprivate_keyIStringParameterprivateKeyIStringParameterPrivateKeyIStringParameterPrivateKeyIStringParameterrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromKeyPairAttributes(scope: Construct, id: string, attrs: KeyPairAttributes): IKeyPair@staticmethod def from_key_pair_attributes(scope: Construct, id: str, attrs: KeyPairAttributes) -> IKeyPairpublic static IKeyPair fromKeyPairAttributes(Construct scope, String id, KeyPairAttributes attrs)public static IKeyPair FromKeyPairAttributes(Construct scope, string id, KeyPairAttributes attrs)func FromKeyPairAttributes(Scope Construct, Id *string, Attrs KeyPairAttributes) IKeyPairstatic#fromKeyPairName(scope: Construct, id: string, keyPairName: string): IKeyPair@staticmethod def from_key_pair_name(scope: Construct, id: str, key_pair_name: str) -> IKeyPairpublic static IKeyPair fromKeyPairName(Construct scope, String id, String keyPairName)public static IKeyPair FromKeyPairName(Construct scope, string id, string keyPairName)func FromKeyPairName(Scope Construct, Id *string, KeyPairName *string) IKeyPairstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.