Skip to content

Environment

  • Implements: com.aliyun.ros.cdk.arms.datasource.IEnvironment

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

Initializers

import com.aliyun.ros.cdk.arms.datasource.Environment;
Environment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .environmentId(java.lang.String)
    .environmentId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
environmentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property environmentId: The first ID of the resource.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

environmentIdRequired

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

Property environmentId: The first ID of the resource.


refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.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.

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.arms.datasource.Environment;
Environment.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.
attrBindResourceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BindResourceId: The id or vpcId of the bound container instance.
attrBindResourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BindResourceType: Binding resource type.
attrBindVpcCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BindVpcCidr: The network segment of the bound vpc.
attrEnvironmentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentId: The first ID of the resource.
attrEnvironmentName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentName: The name of the resource.
attrEnvironmentSubType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentSubType: Subtype of environment.
attrEnvironmentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentType: Type of environment.
attrFeePackage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute FeePackage: Paid package.
attrGrafanaDatasourceUid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GrafanaDatasourceUid: The uid of the Grafana data source.
attrGrafanaFolderUid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GrafanaFolderUid: Binding Grafana directory uid.
attrManagedType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ManagedType: Hosting type.
attrPrometheusInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrometheusInstanceId: The ID of the prometheus instance.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tag of the resource.
attrUserId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UserId: User ID.
props EnvironmentProps 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

attrBindResourceIdRequired

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

Attribute BindResourceId: The id or vpcId of the bound container instance.


attrBindResourceTypeRequired

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

Attribute BindResourceType: Binding resource type.


attrBindVpcCidrRequired

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

Attribute BindVpcCidr: The network segment of the bound vpc.


attrEnvironmentIdRequired

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

Attribute EnvironmentId: The first ID of the resource.


attrEnvironmentNameRequired

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

Attribute EnvironmentName: The name of the resource.


attrEnvironmentSubTypeRequired

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

Attribute EnvironmentSubType: Subtype of environment.


attrEnvironmentTypeRequired

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

Attribute EnvironmentType: Type of environment.


attrFeePackageRequired

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

Attribute FeePackage: Paid package.


attrGrafanaDatasourceUidRequired

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

Attribute GrafanaDatasourceUid: The uid of the Grafana data source.


attrGrafanaFolderUidRequired

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

Attribute GrafanaFolderUid: Binding Grafana directory uid.


attrManagedTypeRequired

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

Attribute ManagedType: Hosting type.


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.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrTagsRequired

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

Attribute Tags: The tag of the resource.


attrUserIdRequired

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

Attribute UserId: User ID.


propsRequired

public EnvironmentProps getProps();