Instance
- Implements: com.aliyun.ros.cdk.kms.datasource.IInstance
This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Instance, which is used to query the information about a Key Management Service (KMS) instance.
Initializers
import com.aliyun.ros.cdk.kms.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(IResolvable)
.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. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the KMS instance. |
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. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the KMS instance.
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.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
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.kms.datasource.Instance;
Instance.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. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the KMS instance is created. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the KMS instance. |
attrInstanceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceName: The name of the KMS instance. |
attrKeyNum | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute KeyNum: The number of keys that can be created for the KMS instance. |
attrSecretNum | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecretNum: The number of secrets that can be created for the KMS instance. |
attrSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Spec: The computation performance level of the KMS instance. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The virtual private cloud (VPC) with which the KMS instance is associated.. |
attrVpcNum | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcNum: The number of managed accesses. |
attrVswitchIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VswitchIds: The VSwitch in the VPC. |
attrZoneIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneIds: The zone with which the KMS instance is associated. |
props | InstanceProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the KMS instance is created.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the KMS instance.
attrInstanceNameRequired
public java.lang.Object getAttrInstanceName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceName: The name of the KMS instance.
attrKeyNumRequired
public java.lang.Object getAttrKeyNum();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute KeyNum: The number of keys that can be created for the KMS instance.
attrSecretNumRequired
public java.lang.Object getAttrSecretNum();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecretNum: The number of secrets that can be created for the KMS instance.
attrSpecRequired
public java.lang.Object getAttrSpec();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Spec: The computation performance level of the KMS instance.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The virtual private cloud (VPC) with which the KMS instance is associated..
attrVpcNumRequired
public java.lang.Object getAttrVpcNum();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcNum: The number of managed accesses.
The maximum number of VPCs that can access this KMS instance.
attrVswitchIdsRequired
public java.lang.Object getAttrVswitchIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VswitchIds: The VSwitch in the VPC.
attrZoneIdsRequired
public java.lang.Object getAttrZoneIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneIds: The zone with which the KMS instance is associated.
propsRequired
public InstanceProps getProps();
- Type: InstanceProps