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 { SSHKeyPair } from '@alicloud/ros-cdk-ecs'
new SSHKeyPair(scope: Construct, id: string, props: SSHKeyPairProps, enableResourcePropertyConstraint?: boolean)
Name | Type | Description |
---|---|---|
scope |
@alicloud/ros-cdk-core.Construct |
No description. |
id |
string |
No description. |
props |
SSHKeyPairProps |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
scope
Required
- Type: @alicloud/ros-cdk-core.Construct
id
Required
- Type: string
props
Required
- Type: SSHKeyPairProps
enableResourcePropertyConstraint
Optional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import { SSHKeyPair } from '@alicloud/ros-cdk-ecs'
SSHKeyPair.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
Name | Type | Description |
---|---|---|
node |
@alicloud/ros-cdk-core.ConstructNode |
The construct tree node associated with this construct. |
ref |
string |
No description. |
stack |
@alicloud/ros-cdk-core.Stack |
The stack in which this resource is defined. |
resource |
@alicloud/ros-cdk-core.RosResource |
No description. |
attrKeyPairFingerPrint |
@alicloud/ros-cdk-core.IResolvable |
Attribute KeyPairFingerPrint: The fingerprint of the key pair. |
attrKeyPairName |
@alicloud/ros-cdk-core.IResolvable |
Attribute KeyPairName: SSH Key pair name. |
attrPrivateKeyBody |
@alicloud/ros-cdk-core.IResolvable |
Attribute PrivateKeyBody: The private key of the key pair. |
node
Required
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public readonly ref: string;
- Type: string
stack
Required
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resource
Optional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrKeyPairFingerPrint
Required
public readonly attrKeyPairFingerPrint: IResolvable;
- Type: @alicloud/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 readonly attrKeyPairName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute KeyPairName: SSH Key pair name.
attrPrivateKeyBody
Required
public readonly attrPrivateKeyBody: IResolvable;
- Type: @alicloud/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.