Skip to content

IKeyPair

Represents a KeyPair.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_key_pair_finger_print typing.Union[str, ros_cdk_core.IResolvable] Attribute KeyPairFingerPrint: The fingerprint of the key pair.
attr_key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Attribute KeyPairName: SSH Key pair name.
attr_private_key_body typing.Union[str, ros_cdk_core.IResolvable] Attribute PrivateKeyBody: The private key of the key pair.
props KeyPairProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_key_pair_finger_printRequired

attr_key_pair_finger_print: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute KeyPairFingerPrint: The fingerprint of the key pair.

The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716. For more information, see RFC 4716.


attr_key_pair_nameRequired

attr_key_pair_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute KeyPairName: SSH Key pair name.


attr_private_key_bodyRequired

attr_private_key_body: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PrivateKeyBody: The private key of the key pair.

The private key is encoded with PEM in the PKCS#8 format.


propsRequired

props: KeyPairProps