Prometheus
This class encapsulates and extends the ROS resource type ALIYUN::ARMS::Prometheus, which is used to create a Prometheus instance.
Initializers
import com.aliyun.ros.cdk.arms.Prometheus;
Prometheus.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.clusterType(java.lang.String)
.clusterType(IResolvable)
.grafanaInstanceId(java.lang.String)
.grafanaInstanceId(IResolvable)
.prometheusName(java.lang.String)
.prometheusName(IResolvable)
// .clusterId(java.lang.String)
// .clusterId(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .securityGroupId(java.lang.String)
// .securityGroupId(IResolvable)
// .subClustersJson(java.util.List<java.lang.Object>)
// .subClustersJson(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .vpcId(java.lang.String)
// .vpcId(IResolvable)
// .vSwitchId(java.lang.String)
// .vSwitchId(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. |
clusterType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property clusterType: Instance type. |
grafanaInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property grafanaInstanceId: Grafana workspace ID. |
prometheusName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property prometheusName: The name of the resource. |
clusterId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property clusterId: The ID of the cluster. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: The ID of the resource group. |
securityGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property securityGroupId: The ID of the custom resource group. |
subClustersJson |
java.util.List |
Property subClustersJson: The child instances of the Prometheus instance for GlobalView. |
tags |
java.util.List<TagsProperty> |
Property tags: Tags of prometheus. |
vpcId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property vpcId: The ID of the virtual private cloud (VPC). |
vSwitchId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property vSwitchId: The ID of the vSwitch. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
clusterTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterType: Instance type.
grafanaInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property grafanaInstanceId: Grafana workspace ID.
prometheusNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property prometheusName: The name of the resource.
clusterIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterId: The ID of the cluster.
This parameter is required if you set ClusterType to ManagedKubernetes.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
securityGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupId: The ID of the custom resource group.
You can specify this parameter to bind the instance to the resource group.
subClustersJsonOptional
- Type: java.util.List
OR com.aliyun.ros.cdk.core.IResolvable
Property subClustersJson: The child instances of the Prometheus instance for GlobalView.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of prometheus.
vpcIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the virtual private cloud (VPC).
This parameter is required if you set ClusterType to ecs or create a serverless Kubernetes (ASK) managed cluster.
vSwitchIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The ID of the vSwitch.
This parameter is required if you set ClusterType to ecs or create an ASK managed cluster.
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.arms.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. |
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 |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ClusterId: The ID of the cluster. |
attrClusterType |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ClusterType: Instance type. |
attrGrafanaInstanceId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute GrafanaInstanceId: Grafana workspace ID. |
attrPaymentType |
com.aliyun.ros.cdk.core.IResolvable |
Attribute PaymentType: Payment Type. |
attrPrometheusName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute PrometheusName: The name of the resource. |
attrResourceGroupId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ResourceGroupId: The ID of the resource group. |
attrSecurityGroupId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute SecurityGroupId: The ID of the security group. |
attrSubClustersJson |
com.aliyun.ros.cdk.core.IResolvable |
Attribute SubClustersJson: Subcluster information of globalVeiw cluster. |
attrTags |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Tags: The tags of the prometheus. |
attrUserId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute UserId: User ID. |
attrVpcId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute VpcId: The ID of the virtual private cloud (VPC). |
attrVSwitchId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute VSwitchId: The ID of the vSwitch. |
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
attrClusterIdRequired
public IResolvable getAttrClusterId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterId: The ID of the cluster.
attrClusterTypeRequired
public IResolvable getAttrClusterType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterType: Instance type.
attrGrafanaInstanceIdRequired
public IResolvable getAttrGrafanaInstanceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute GrafanaInstanceId: Grafana workspace ID.
attrPaymentTypeRequired
public IResolvable getAttrPaymentType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: Payment Type.
attrPrometheusNameRequired
public IResolvable getAttrPrometheusName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute PrometheusName: The name of the resource.
attrResourceGroupIdRequired
public IResolvable getAttrResourceGroupId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupIdRequired
public IResolvable getAttrSecurityGroupId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityGroupId: The ID of the security group.
attrSubClustersJsonRequired
public IResolvable getAttrSubClustersJson();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute SubClustersJson: Subcluster information of globalVeiw cluster.
attrTagsRequired
public IResolvable getAttrTags();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the prometheus.
attrUserIdRequired
public IResolvable getAttrUserId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute UserId: User ID.
attrVpcIdRequired
public IResolvable getAttrVpcId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The ID of the virtual private cloud (VPC).
attrVSwitchIdRequired
public IResolvable getAttrVSwitchId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: The ID of the vSwitch.