ClusterApplicationResources
- Implements: com.aliyun.ros.cdk.cs.datasource.IClusterApplicationResources
This class encapsulates and extends the ROS resource type DATASOURCE::CS::ClusterApplicationResources.
Initializers
import com.aliyun.ros.cdk.cs.datasource.ClusterApplicationResources;
ClusterApplicationResources.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.clusterId(java.lang.String)
.clusterId(IResolvable)
.kind(java.lang.String)
.kind(IResolvable)
// .apiVersion(java.lang.String)
// .apiVersion(IResolvable)
// .firstMatch(java.lang.Boolean)
// .firstMatch(IResolvable)
// .jsonPath(java.lang.String)
// .jsonPath(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .namespace(java.lang.String)
// .namespace(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. |
clusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterId: The ID of the kubernetes cluster. |
kind | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property kind: The kind of kubernetes resources to query. |
apiVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property apiVersion: The api version of kubernetes resource to query. |
firstMatch | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property firstMatch: Only the first matching result in jsonpath's filtered results is returned. |
jsonPath | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property jsonPath: Json path expression to filter the output. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the kubernetes resource to query. |
namespace | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property namespace: The namespace of kubernetes containing the resource. |
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
clusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterId: The ID of the kubernetes cluster.
kindRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property kind: The kind of kubernetes resources to query.
apiVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property apiVersion: The api version of kubernetes resource to query.
firstMatchOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property firstMatch: Only the first matching result in jsonpath's filtered results is returned.
Default False
jsonPathOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property jsonPath: Json path expression to filter the output.
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the kubernetes resource to query.
namespaceOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property namespace: The namespace of kubernetes containing the resource.
Default value is default
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.cs.datasource.ClusterApplicationResources;
ClusterApplicationResources.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. |
attrResponse | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Response: Query result of kubernetes resource(s). |
props | ClusterApplicationResourcesProps | 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
attrResponseRequired
public java.lang.Object getAttrResponse();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Response: Query result of kubernetes resource(s).
propsRequired
public ClusterApplicationResourcesProps getProps();