PrometheusInstance

• Implements: IPrometheusInstance

This class encapsulates and extends the ROS resource type ALIYUN::CMS2::PrometheusInstance.

Initializers

import ros_cdk_cms2
ros_cdk_cms2.PrometheusInstance(
  scope: Construct,
  id: str,
  prometheus_instance_name: typing.Union[str, IResolvable],
  archive_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  auth_free_read_policy: typing.Union[str, IResolvable] = None,
  auth_free_write_policy: typing.Union[str, IResolvable] = None,
  basic_metric_query_limit: typing.Union[bool, IResolvable] = None,
  enable_auth_free_read: typing.Union[bool, IResolvable] = None,
  enable_auth_free_write: typing.Union[bool, IResolvable] = None,
  enable_auth_token: typing.Union[bool, IResolvable] = None,
  payment_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  storage_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  workspace: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

prometheus_instance_name^Required

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

Property prometheusInstanceName: The name of the Prometheus instance.

archive_duration^Optional

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

Property archiveDuration: The archive duration of the Prometheus instance.

auth_free_read_policy^Optional

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

Property authFreeReadPolicy: The authentication-free read policy of the Prometheus instance.

auth_free_write_policy^Optional

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

Property authFreeWritePolicy: The authentication-free write policy of the Prometheus instance.

basic_metric_query_limit^Optional

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

Property basicMetricQueryLimit: The basic metric query limit of the Prometheus instance.

enable_auth_free_read^Optional

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

Property enableAuthFreeRead: Whether to enable authentication-free read for the Prometheus instance.

enable_auth_free_write^Optional

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

Property enableAuthFreeWrite: Whether to enable authentication-free write for the Prometheus instance.

enable_auth_token^Optional

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

Property enableAuthToken: Whether to enable authentication token for the Prometheus instance.

payment_type^Optional

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

Property paymentType: The payment type of the Prometheus instance.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

status^Optional

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

Property status: The status of the Prometheus instance.

storage_duration^Optional

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

Property storageDuration: The storage duration of the Prometheus instance.

workspace^Optional

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

Property workspace: The workspace of the Prometheus instance.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_cms2
ros_cdk_cms2.PrometheusInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

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_http_api_inter_url^Required

attr_http_api_inter_url: typing.Union[str, IResolvable]

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

Attribute HttpApiInterUrl: The HTTP API inter URL of the Prometheus instance.

attr_http_api_intra_url^Required

attr_http_api_intra_url: typing.Union[str, IResolvable]

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

Attribute HttpApiIntraUrl: The HTTP API intra URL of the Prometheus instance.

attr_prometheus_instance_id^Required

attr_prometheus_instance_id: typing.Union[str, IResolvable]

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

Attribute PrometheusInstanceId: The ID of the Prometheus instance.

attr_push_gateway_inter_url^Required

attr_push_gateway_inter_url: typing.Union[str, IResolvable]

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

Attribute PushGatewayInterUrl: The push gateway inter URL of the Prometheus instance.

attr_push_gateway_intra_url^Required

attr_push_gateway_intra_url: typing.Union[str, IResolvable]

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

Attribute PushGatewayIntraUrl: The push gateway intra URL of the Prometheus instance.

attr_remote_read_inter_url^Required

attr_remote_read_inter_url: typing.Union[str, IResolvable]

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

Attribute RemoteReadInterUrl: The remote read inter URL of the Prometheus instance.

attr_remote_read_intra_url^Required

attr_remote_read_intra_url: typing.Union[str, IResolvable]

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

Attribute RemoteReadIntraUrl: The remote read intra URL of the Prometheus instance.

attr_remote_write_inter_url^Required

attr_remote_write_inter_url: typing.Union[str, IResolvable]

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

Attribute RemoteWriteInterUrl: The remote write inter URL of the Prometheus instance.

attr_remote_write_intra_url^Required

attr_remote_write_intra_url: typing.Union[str, IResolvable]

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

Attribute RemoteWriteIntraUrl: The remote write intra URL of the Prometheus instance.

props^Required

props: PrometheusInstanceProps

• Type: PrometheusInstanceProps