CfnKeyPairProps
- class aws_cdk.aws_ec2.CfnKeyPairProps(*, key_name, key_type=None, public_key_material=None, tags=None)
Bases:
objectProperties for defining a
CfnKeyPair.- Parameters:
key_name (
str) – A unique name for the key pair. Constraints: Up to 255 ASCII characterskey_type (
Optional[str]) – The type of key pair. Note that ED25519 keys are not supported for Windows instances. If thePublicKeyMaterialproperty is specified, theKeyTypeproperty is ignored, and the key type is inferred from thePublicKeyMaterialvalue. Default:rsapublic_key_material (
Optional[str]) – The public key material. ThePublicKeyMaterialproperty is used to import a key pair. If this property is not specified, then a new key pair will be created.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags to apply to the key pair.
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_key_pair_props = ec2.CfnKeyPairProps( key_name="keyName", # the properties below are optional key_type="keyType", public_key_material="publicKeyMaterial", tags=[CfnTag( key="key", value="value" )] )
Attributes
- key_name
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
- key_type
The type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the
PublicKeyMaterialproperty is specified, theKeyTypeproperty is ignored, and the key type is inferred from thePublicKeyMaterialvalue.Default:
rsa
- public_key_material
The public key material.
The
PublicKeyMaterialproperty is used to import a key pair. If this property is not specified, then a new key pair will be created.
- tags
The tags to apply to the key pair.