Skip to content

PrometheusInstance

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

Initializers

import com.aliyun.ros.cdk.cms2.PrometheusInstance;
PrometheusInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .prometheusInstanceName(java.lang.String)
    .prometheusInstanceName(IResolvable)
//  .archiveDuration(java.lang.Number)
//  .archiveDuration(IResolvable)
//  .authFreeReadPolicy(java.lang.String)
//  .authFreeReadPolicy(IResolvable)
//  .authFreeWritePolicy(java.lang.String)
//  .authFreeWritePolicy(IResolvable)
//  .basicMetricQueryLimit(java.lang.Boolean)
//  .basicMetricQueryLimit(IResolvable)
//  .enableAuthFreeRead(java.lang.Boolean)
//  .enableAuthFreeRead(IResolvable)
//  .enableAuthFreeWrite(java.lang.Boolean)
//  .enableAuthFreeWrite(IResolvable)
//  .enableAuthToken(java.lang.Boolean)
//  .enableAuthToken(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .storageDuration(java.lang.Number)
//  .storageDuration(IResolvable)
//  .workspace(java.lang.String)
//  .workspace(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.
prometheusInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prometheusInstanceName: The name of the Prometheus instance.
archiveDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property archiveDuration: The archive duration of the Prometheus instance.
authFreeReadPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property authFreeReadPolicy: The authentication-free read policy of the Prometheus instance.
authFreeWritePolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property authFreeWritePolicy: The authentication-free write policy of the Prometheus instance.
basicMetricQueryLimit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property basicMetricQueryLimit: The basic metric query limit of the Prometheus instance.
enableAuthFreeRead java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableAuthFreeRead: Whether to enable authentication-free read for the Prometheus instance.
enableAuthFreeWrite java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableAuthFreeWrite: Whether to enable authentication-free write for the Prometheus instance.
enableAuthToken java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableAuthToken: Whether to enable authentication token for the Prometheus instance.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The payment type of the Prometheus instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the Prometheus instance.
storageDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageDuration: The storage duration of the Prometheus instance.
workspace java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workspace: The workspace of the Prometheus instance.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

prometheusInstanceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property prometheusInstanceName: The name of the Prometheus instance.


archiveDurationOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property archiveDuration: The archive duration of the Prometheus instance.


authFreeReadPolicyOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


authFreeWritePolicyOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


basicMetricQueryLimitOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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


enableAuthFreeReadOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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


enableAuthFreeWriteOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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


enableAuthTokenOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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


paymentTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The payment type of the Prometheus instance.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.


statusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: The status of the Prometheus instance.


storageDurationOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageDuration: The storage duration of the Prometheus instance.


workspaceOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workspace: The workspace of the Prometheus instance.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.cms2.PrometheusInstance;
PrometheusInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrHttpApiInterUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpApiInterUrl: The HTTP API inter URL of the Prometheus instance.
attrHttpApiIntraUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpApiIntraUrl: The HTTP API intra URL of the Prometheus instance.
attrPrometheusInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrometheusInstanceId: The ID of the Prometheus instance.
attrPushGatewayInterUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PushGatewayInterUrl: The push gateway inter URL of the Prometheus instance.
attrPushGatewayIntraUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PushGatewayIntraUrl: The push gateway intra URL of the Prometheus instance.
attrRemoteReadInterUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RemoteReadInterUrl: The remote read inter URL of the Prometheus instance.
attrRemoteReadIntraUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RemoteReadIntraUrl: The remote read intra URL of the Prometheus instance.
attrRemoteWriteInterUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RemoteWriteInterUrl: The remote write inter URL of the Prometheus instance.
attrRemoteWriteIntraUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RemoteWriteIntraUrl: The remote write intra URL of the Prometheus instance.
props PrometheusInstanceProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


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

attrHttpApiInterUrlRequired

public java.lang.Object getAttrHttpApiInterUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHttpApiIntraUrlRequired

public java.lang.Object getAttrHttpApiIntraUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrPrometheusInstanceIdRequired

public java.lang.Object getAttrPrometheusInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrometheusInstanceId: The ID of the Prometheus instance.


attrPushGatewayInterUrlRequired

public java.lang.Object getAttrPushGatewayInterUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrPushGatewayIntraUrlRequired

public java.lang.Object getAttrPushGatewayIntraUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRemoteReadInterUrlRequired

public java.lang.Object getAttrRemoteReadInterUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRemoteReadIntraUrlRequired

public java.lang.Object getAttrRemoteReadIntraUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRemoteWriteInterUrlRequired

public java.lang.Object getAttrRemoteWriteInterUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRemoteWriteIntraUrlRequired

public java.lang.Object getAttrRemoteWriteIntraUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


propsRequired

public PrometheusInstanceProps getProps();