KeyPairs
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::KeyPairs, which is used to query key pairs.
Initializers
import com.aliyun.ros.cdk.ecs.datasource.KeyPairs;
KeyPairs.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
// .keyPairFingerPrint(java.lang.String)
// .keyPairFingerPrint(IResolvable)
// .keyPairName(java.lang.String)
// .keyPairName(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
keyPairFingerPrint |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property keyPairFingerPrint: The fingerprint of the key pair. |
keyPairName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property keyPairName: he name of the key pair. |
refreshOptions |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: The ID of the resource group to which the key pair belongs. |
tags |
java.util.List |
Property tags: Tags of keypair. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
keyPairFingerPrintOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property 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.
keyPairNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property keyPairName: he name of the key pair.
You can use the asterisk () symbol as a wildcard in regular expressions to query key pairs by performing a fuzzy search. Sample patterns: SshKey: queries key pairs whose names end with SshKey, including the key pair named SshKey. SshKey: queries key pairs whose names start with SshKey, including the key pair named SshKey. SshKey*: queries key pairs whose names include SshKey, including the key pair named SshKey. SshKey: queries the key pair named SshKey.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group to which the key pair belongs.
If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.
tagsOptional
- Type: java.util.List
Property tags: Tags of keypair.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.ecs.datasource.KeyPairs;
KeyPairs.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrKeyPairNames |
com.aliyun.ros.cdk.core.IResolvable |
Attribute KeyPairNames: The list of key pair names. |
attrKeyPairs |
com.aliyun.ros.cdk.core.IResolvable |
Attribute KeyPairs: The list of key pairs. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrKeyPairNamesRequired
public IResolvable getAttrKeyPairNames();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute KeyPairNames: The list of key pair names.
attrKeyPairsRequired
public IResolvable getAttrKeyPairs();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute KeyPairs: The list of key pairs.