Skip to content

Prometheus

This class encapsulates and extends the ROS resource type ALIYUN::ARMS::Prometheus.

Initializers 

import ros_cdk_arms
ros_cdk_arms.Prometheus(
  scope: Construct,
  id: str,
  cluster_type: typing.Union[str, IResolvable],
  grafana_instance_id: typing.Union[str, IResolvable],
  prometheus_name: typing.Union[str, IResolvable],
  cluster_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  sub_clusters_json: typing.Union[typing.List[typing.Any], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterType: Instance type.
grafana_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property grafanaInstanceId: Grafana workspace ID.
prometheus_name typing.Union[str, ros_cdk_core.IResolvable] Property prometheusName: The name of the resource.
cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property clusterId: The ID of the cluster.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: The ID of the custom resource group.
sub_clusters_json typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] Property subClustersJson: The child instances of the Prometheus instance for GlobalView.
tags typing.List[TagsProperty] Property tags: Tags of prometheus.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC).
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the vSwitch.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterType: Instance type.

grafana_instance_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property grafanaInstanceId: Grafana workspace ID.

prometheus_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property prometheusName: The name of the resource.

cluster_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterId: The ID of the cluster.

This parameter is required if you set ClusterType to ManagedKubernetes.

resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

security_group_idOptional

  • Type: typing.Union[str, 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.

sub_clusters_jsonOptional

  • Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property subClustersJson: The child instances of the Prometheus instance for GlobalView.

tagsOptional

Property tags: Tags of prometheus.

vpc_idOptional

  • Type: typing.Union[str, 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.

v_switch_idOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_arms
ros_cdk_arms.Prometheus.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cluster_id ros_cdk_core.IResolvable Attribute ClusterId: The ID of the cluster.
attr_cluster_type ros_cdk_core.IResolvable Attribute ClusterType: Instance type.
attr_grafana_instance_id ros_cdk_core.IResolvable Attribute GrafanaInstanceId: Grafana workspace ID.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Payment Type.
attr_prometheus_name ros_cdk_core.IResolvable Attribute PrometheusName: The name of the resource.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_security_group_id ros_cdk_core.IResolvable Attribute SecurityGroupId: The ID of the security group.
attr_sub_clusters_json ros_cdk_core.IResolvable Attribute SubClustersJson: Subcluster information of globalVeiw cluster.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags of the prometheus.
attr_user_id ros_cdk_core.IResolvable Attribute UserId: User ID.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC).
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The ID of the vSwitch.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cluster_idRequired 

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the cluster.

attr_cluster_typeRequired 

attr_cluster_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterType: Instance type.

attr_grafana_instance_idRequired 

attr_grafana_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GrafanaInstanceId: Grafana workspace ID.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Payment Type.

attr_prometheus_nameRequired 

attr_prometheus_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrometheusName: The name of the resource.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_security_group_idRequired 

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: The ID of the security group.

attr_sub_clusters_jsonRequired 

attr_sub_clusters_json: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SubClustersJson: Subcluster information of globalVeiw cluster.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the prometheus.

attr_user_idRequired 

attr_user_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserId: User ID.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The ID of the virtual private cloud (VPC).

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The ID of the vSwitch.