Prometheus
- Implements: com.aliyun.ros.cdk.arms.datasource.IPrometheus
This class encapsulates and extends the ROS resource type DATASOURCE::ARMS::Prometheus.
Initializers
import com.aliyun.ros.cdk.arms.datasource.Prometheus;
Prometheus.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.clusterId(java.lang.String)
.clusterId(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 Prometheus 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
clusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterId: The ID of the Prometheus 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.arms.datasource.Prometheus;
Prometheus.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. |
attrClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterId: The ID of the Prometheus instance. |
attrClusterType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterType: The type of the instance. |
attrGrafanaInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GrafanaInstanceId: The ID of the Grafana workspace. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The billing method. |
attrPrometheusName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PrometheusName: The name of the instance. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group to which the instance belongs. |
attrSecurityGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecurityGroupId: The ID of the security group. |
attrSubClustersJson | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SubClustersJson: The child instances of the Prometheus instance for GlobalView. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the instance. |
attrUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserId: The user ID. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The VPC ID. |
attrVSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchId: The vSwitch ID. |
props | PrometheusProps | 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
attrClusterIdRequired
public java.lang.Object getAttrClusterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterId: The ID of the Prometheus instance.
attrClusterTypeRequired
public java.lang.Object getAttrClusterType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterType: The type of the instance.
attrGrafanaInstanceIdRequired
public java.lang.Object getAttrGrafanaInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GrafanaInstanceId: The ID of the Grafana workspace.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The billing method.
attrPrometheusNameRequired
public java.lang.Object getAttrPrometheusName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PrometheusName: The name of the instance.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrSecurityGroupIdRequired
public java.lang.Object getAttrSecurityGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityGroupId: The ID of the security group.
This parameter is returned only for Prometheus instances for ECS.
attrSubClustersJsonRequired
public java.lang.Object getAttrSubClustersJson();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SubClustersJson: The child instances of the Prometheus instance for GlobalView.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the instance.
attrUserIdRequired
public java.lang.Object getAttrUserId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserId: The user ID.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The VPC ID.
This parameter is returned only for Prometheus instances for ECS.
attrVSwitchIdRequired
public java.lang.Object getAttrVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: The vSwitch ID.
This parameter is returned only for Prometheus instances for ECS.
propsRequired
public PrometheusProps getProps();
- Type: PrometheusProps