Prometheus

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

Initializers

from ros_cdk_arms import datasource
datasource.Prometheus(
  scope: Construct,
  id: str,
  cluster_id: typing.Union[str, IResolvable],
  refresh_options: 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_id	typing.Union[str, ros_cdk_core.IResolvable]	Property clusterId: The ID of the Prometheus instance.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

cluster_id^Required

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

Property clusterId: The ID of the Prometheus instance.

---

refresh_options^Optional

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

---

enable_resource_property_constraint^Optional

• 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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• 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 Prometheus instance.
attr_cluster_type	ros_cdk_core.IResolvable	Attribute ClusterType: The type of the instance.
attr_grafana_instance_id	ros_cdk_core.IResolvable	Attribute GrafanaInstanceId: The ID of the Grafana workspace.
attr_payment_type	ros_cdk_core.IResolvable	Attribute PaymentType: The billing method.
attr_prometheus_name	ros_cdk_core.IResolvable	Attribute PrometheusName: The name of the instance.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
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: The child instances of the Prometheus instance for GlobalView.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tags of the instance.
attr_user_id	ros_cdk_core.IResolvable	Attribute UserId: The user ID.
attr_vpc_id	ros_cdk_core.IResolvable	Attribute VpcId: The VPC ID.
attr_v_switch_id	ros_cdk_core.IResolvable	Attribute VSwitchId: The vSwitch ID.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_cluster_id^Required

attr_cluster_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the Prometheus instance.

---

attr_cluster_type^Required

attr_cluster_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ClusterType: The type of the instance.

---

attr_grafana_instance_id^Required

attr_grafana_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GrafanaInstanceId: The ID of the Grafana workspace.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: The billing method.

---

attr_prometheus_name^Required

attr_prometheus_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PrometheusName: The name of the instance.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

---

attr_security_group_id^Required

attr_security_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: The ID of the security group.

This parameter is returned only for Prometheus instances for ECS.

---

attr_sub_clusters_json^Required

attr_sub_clusters_json: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SubClustersJson: The child instances of the Prometheus instance for GlobalView.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the instance.

---

attr_user_id^Required

attr_user_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UserId: The user ID.

---

attr_vpc_id^Required

attr_vpc_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcId: The VPC ID.

This parameter is returned only for Prometheus instances for ECS.

---

attr_v_switch_id^Required

attr_v_switch_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The vSwitch ID.

This parameter is returned only for Prometheus instances for ECS.

---