CfnKeyPairProps

class aws_cdk.aws_ec2.CfnKeyPairProps(*, key_name, key_format=None, key_type=None, public_key_material=None, tags=None)

Bases: object

Properties for defining a CfnKeyPair.

Parameters:

key_name (str) – A unique name for the key pair. Constraints: Up to 255 ASCII characters
key_format (Optional[str]) – The format of the key pair. Default: pem Default: - “pem”
key_type (Optional[str]) – 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 Default: - “rsa”
public_key_material (Optional[str]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to apply to the key pair.

See:

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.
from aws_cdk import aws_ec2 as ec2

cfn_key_pair_props = ec2.CfnKeyPairProps(
    key_name="keyName",

    # the properties below are optional
    key_format="keyFormat",
    key_type="keyType",
    public_key_material="publicKeyMaterial",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)