Skip to content

RosInstance

This class is a base encapsulation around the ROS resource type ALIYUN::ElasticSearch::Instance.

Initializers 

import com.aliyun.ros.cdk.elasticsearch.RosInstance;
RosInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dataNode(DataNodeProperty)
    .dataNode(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .version(java.lang.String)
    .version(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableKibanaPrivate(java.lang.Boolean)
//  .enableKibanaPrivate(IResolvable)
//  .enableKibanaPublic(java.lang.Boolean)
//  .enableKibanaPublic(IResolvable)
//  .enablePublic(java.lang.Boolean)
//  .enablePublic(IResolvable)
//  .instanceCategory(java.lang.String)
//  .instanceCategory(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .kibanaNode(IResolvable)
//  .kibanaNode(KibanaNodeProperty)
//  .kibanaWhitelist(java.util.List<java.lang.Object>)
//  .kibanaWhitelist(IResolvable)
//  .masterNode(IResolvable)
//  .masterNode(MasterNodeProperty)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateWhitelist(java.util.List<java.lang.Object>)
//  .privateWhitelist(IResolvable)
//  .publicWhitelist(java.util.List<java.lang.Object>)
//  .publicWhitelist(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .ymlConfig(IResolvable)
//  .ymlConfig(YMLConfigProperty)
//  .zoneCount(java.lang.Number)
//  .zoneCount(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
dataNode DataNodeProperty OR com.aliyun.ros.cdk.core.IResolvable No description.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
version java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableKibanaPrivate java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enableKibanaPublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enablePublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kibanaNode com.aliyun.ros.cdk.core.IResolvable OR KibanaNodeProperty No description.
kibanaWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
masterNode com.aliyun.ros.cdk.core.IResolvable OR MasterNodeProperty No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
publicWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
ymlConfig com.aliyun.ros.cdk.core.IResolvable OR YMLConfigProperty No description.
zoneCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

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

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

dataNodeRequired

passwordRequired

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

versionRequired

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

vSwitchIdRequired

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

descriptionOptional

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

enableKibanaPrivateOptional

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

enableKibanaPublicOptional

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

enablePublicOptional

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

instanceCategoryOptional

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

instanceChargeTypeOptional

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

kibanaNodeOptional

kibanaWhitelistOptional

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

masterNodeOptional

periodOptional

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

periodUnitOptional

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

privateWhitelistOptional

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

publicWhitelistOptional

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

resourceGroupIdOptional

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

tagsOptional

ymlConfigOptional

zoneCountOptional

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

zoneIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
addCondition No description.
addCount No description.
addDeletionOverride Syntactic sugar for addOverride(path, undefined).
addDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc No description.
addMetaData No description.
addOverride Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride Adds an override to a resource property.
addRosDependency No description.
applyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
getAtt Returns a token for an runtime attribute of this resource.

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.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

  • 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

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

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

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

valueRequired

  • Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

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

optionsOptional

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

getAtt 

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: java.lang.String

The name of the attribute.

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.
isRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource Check whether the given construct is a RosResource.

isConstruct 

import com.aliyun.ros.cdk.elasticsearch.RosInstance;
RosInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.elasticsearch.RosInstance;
RosInstance.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.elasticsearch.RosInstance;
RosInstance.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrDomain com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceChargeType com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrKibanaDomain com.aliyun.ros.cdk.core.IResolvable No description.
attrKibanaPort com.aliyun.ros.cdk.core.IResolvable No description.
attrPort com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicDomain com.aliyun.ros.cdk.core.IResolvable No description.
attrStatus com.aliyun.ros.cdk.core.IResolvable No description.
attrVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
dataNode DataNodeProperty OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
version java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableKibanaPrivate java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enableKibanaPublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enablePublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kibanaNode com.aliyun.ros.cdk.core.IResolvable OR KibanaNodeProperty No description.
kibanaWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
masterNode com.aliyun.ros.cdk.core.IResolvable OR MasterNodeProperty No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
publicWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
ymlConfig com.aliyun.ros.cdk.core.IResolvable OR YMLConfigProperty No description.
zoneCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

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

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

public java.lang.String getLogicalId();
  • Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptionsRequired 

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

rosResourceTypeRequired 

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.

attrDomainRequired 

public IResolvable getAttrDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInstanceChargeTypeRequired 

public IResolvable getAttrInstanceChargeType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrKibanaDomainRequired 

public IResolvable getAttrKibanaDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrKibanaPortRequired 

public IResolvable getAttrKibanaPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPortRequired 

public IResolvable getAttrPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPublicDomainRequired 

public IResolvable getAttrPublicDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrStatusRequired 

public IResolvable getAttrStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVersionRequired 

public IResolvable getAttrVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

dataNodeRequired 

public java.lang.Object getDataNode();

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

passwordRequired 

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

versionRequired 

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

vSwitchIdRequired 

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

descriptionOptional 

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

enableKibanaPrivateOptional 

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

enableKibanaPublicOptional 

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

enablePublicOptional 

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

instanceCategoryOptional 

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

instanceChargeTypeOptional 

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

kibanaNodeOptional 

public java.lang.Object getKibanaNode();

kibanaWhitelistOptional 

public java.lang.Object getKibanaWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

masterNodeOptional 

public java.lang.Object getMasterNode();

periodOptional 

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

periodUnitOptional 

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

privateWhitelistOptional 

public java.lang.Object getPrivateWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

publicWhitelistOptional 

public java.lang.Object getPublicWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

resourceGroupIdOptional 

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

ymlConfigOptional 

public java.lang.Object getYmlConfig();

zoneCountOptional 

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

zoneIdOptional 

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

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.

Structs