Skip to content

PrometheusUrl

This class encapsulates and extends the ROS resource type DATASOURCE::ARMS::PrometheusUrl, which is used to query all URLs of a cluster, including the URLs for remote read, remote write, Pushgateway, and Grafana.

Initializers

from ros_cdk_arms import datasource
datasource.PrometheusUrl(
  scope: Construct,
  id: str,
  cluster_id: typing.Union[str, IResolvable] = None,
  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: Cluster ID.
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.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_idOptional

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

Property clusterId: Cluster ID.


refresh_optionsOptional

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

from ros_cdk_arms import datasource
datasource.PrometheusUrl.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: Cluster ID.
attr_cluster_type ros_cdk_core.IResolvable Attribute ClusterType: Cluster type.
attr_grafana_url ros_cdk_core.IResolvable Attribute GrafanaUrl: Internal HTTP API URL (Grafana read URL).
attr_internet_grafana_url ros_cdk_core.IResolvable Attribute InternetGrafanaUrl: Internet HTTP API URL (Grafana read URL).
attr_internet_open_telemetry_url ros_cdk_core.IResolvable Attribute InternetOpenTelemetryUrl: Internet OpenTelemetry URL.
attr_internet_push_gateway_url ros_cdk_core.IResolvable Attribute InternetPushGatewayUrl: Internet push gateway URL.
attr_internet_remote_read_url ros_cdk_core.IResolvable Attribute InternetRemoteReadUrl: Internet remote read URL.
attr_internet_remote_write_url ros_cdk_core.IResolvable Attribute InternetRemoteWriteUrl: Internet remote write URL.
attr_open_telemetry_url ros_cdk_core.IResolvable Attribute OpenTelemetryUrl: Internal OpenTelemetry URL.
attr_push_gateway_url ros_cdk_core.IResolvable Attribute PushGatewayUrl: Internal push gateway URL.
attr_remote_read_url ros_cdk_core.IResolvable Attribute RemoteReadUrl: Internal remote read URL.
attr_remote_write_url ros_cdk_core.IResolvable Attribute RemoteWriteUrl: Internal remote write URL.
attr_token ros_cdk_core.IResolvable Attribute Token: The token for Grafana read URL.

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: Cluster ID.


attr_cluster_typeRequired

attr_cluster_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterType: Cluster type.


attr_grafana_urlRequired

attr_grafana_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GrafanaUrl: Internal HTTP API URL (Grafana read URL).


attr_internet_grafana_urlRequired

attr_internet_grafana_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetGrafanaUrl: Internet HTTP API URL (Grafana read URL).


attr_internet_open_telemetry_urlRequired

attr_internet_open_telemetry_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetOpenTelemetryUrl: Internet OpenTelemetry URL.


attr_internet_push_gateway_urlRequired

attr_internet_push_gateway_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetPushGatewayUrl: Internet push gateway URL.


attr_internet_remote_read_urlRequired

attr_internet_remote_read_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetRemoteReadUrl: Internet remote read URL.


attr_internet_remote_write_urlRequired

attr_internet_remote_write_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetRemoteWriteUrl: Internet remote write URL.


attr_open_telemetry_urlRequired

attr_open_telemetry_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OpenTelemetryUrl: Internal OpenTelemetry URL.


attr_push_gateway_urlRequired

attr_push_gateway_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PushGatewayUrl: Internal push gateway URL.


attr_remote_read_urlRequired

attr_remote_read_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RemoteReadUrl: Internal remote read URL.


attr_remote_write_urlRequired

attr_remote_write_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RemoteWriteUrl: Internal remote write URL.


attr_tokenRequired

attr_token: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Token: The token for Grafana read URL.