SSHKeyPair

This class encapsulates and extends the ROS resource type ALIYUN::ECS::SSHKeyPair, which is used to create an SSH key pair or import an existing SSH key pair to access an Elastic Compute Service (ECS) instance.

Initializers

import com.aliyun.ros.cdk.ecs.SSHKeyPair;
SSHKeyPair.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .keyPairName(java.lang.String)
    .keyPairName(IResolvable)
//  .publicKeyBody(java.lang.String)
//  .publicKeyBody(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
keyPairName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property keyPairName: SSH key pair name.
publicKeyBody	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property publicKeyBody: SSH Public key.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: Resource group id.
tags	java.util.List<TagsProperty>	Property tags: Tags to attach to instance.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

keyPairName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property keyPairName: SSH key pair name.

It must be unique. [2, 128] characters. All character sets are supported. Do not start with a special character, digit, http://, or https://. It can contain digits, ".", "_", or "-".

---

publicKeyBody^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property publicKeyBody: SSH Public key.

If PublicKeyBody is specified, existed public key body will be imported instead of creating new SSH key pair.

---

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

---

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.ecs.SSHKeyPair;
SSHKeyPair.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrKeyPairFingerPrint	com.aliyun.ros.cdk.core.IResolvable	Attribute KeyPairFingerPrint: The fingerprint of the key pair.
attrKeyPairName	com.aliyun.ros.cdk.core.IResolvable	Attribute KeyPairName: SSH Key pair name.
attrPrivateKeyBody	com.aliyun.ros.cdk.core.IResolvable	Attribute PrivateKeyBody: The private key of the key pair.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrKeyPairFingerPrint^Required

public IResolvable getAttrKeyPairFingerPrint();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute KeyPairFingerPrint: The fingerprint of the key pair.

The public key fingerprint format defined in RFC4716: MD5 message digest algorithm. Refer to http://tools.ietf.org/html/rfc4716.

---

attrKeyPairName^Required

public IResolvable getAttrKeyPairName();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute KeyPairName: SSH Key pair name.

---

attrPrivateKeyBody^Required

public IResolvable getAttrPrivateKeyBody();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrivateKeyBody: The private key of the key pair.

Content of the RSA private key in the PKCS#8 format of the unencrypted PEM encoding. Refer to: https://www.openssl.org/docs/apps/pkcs8.html.User only can get the private key one time when and only when SSH key pair is created.

---