Skip to content

RosInstance

This class is a base encapsulation around the ROS resource type DATASOURCE::MONGODB::Instance, which is used to query the information about an ApsaraDB for MongoDB instance.

Initializers 

import com.aliyun.ros.cdk.mongodb.datasource.RosInstance;
RosInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions 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

instanceIdRequired

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

refreshOptionsOptional

  • 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.mongodb.datasource.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.mongodb.datasource.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.mongodb.datasource.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.
attrAccountDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrAccountName com.aliyun.ros.cdk.core.IResolvable No description.
attrAutoRenew com.aliyun.ros.cdk.core.IResolvable No description.
attrAutoRenewDuration com.aliyun.ros.cdk.core.IResolvable No description.
attrBackupInterval com.aliyun.ros.cdk.core.IResolvable No description.
attrBackupRetentionPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrDbInstanceClass com.aliyun.ros.cdk.core.IResolvable No description.
attrDbInstanceDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrDbInstanceReleaseProtection com.aliyun.ros.cdk.core.IResolvable No description.
attrDbInstanceStorage com.aliyun.ros.cdk.core.IResolvable No description.
attrDbInstanceType com.aliyun.ros.cdk.core.IResolvable No description.
attrEnableBackupLog com.aliyun.ros.cdk.core.IResolvable No description.
attrEngine com.aliyun.ros.cdk.core.IResolvable No description.
attrEngineVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrExpireTime com.aliyun.ros.cdk.core.IResolvable No description.
attrHiddenZoneId com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrKindCode com.aliyun.ros.cdk.core.IResolvable No description.
attrLastDowngradeTime com.aliyun.ros.cdk.core.IResolvable No description.
attrLockMode com.aliyun.ros.cdk.core.IResolvable No description.
attrLogBackupRetentionPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrMaintainEndTime com.aliyun.ros.cdk.core.IResolvable No description.
attrMaintainStartTime com.aliyun.ros.cdk.core.IResolvable No description.
attrMongosList com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkAddresses com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkType com.aliyun.ros.cdk.core.IResolvable No description.
attrParameters com.aliyun.ros.cdk.core.IResolvable No description.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable No description.
attrPreferredBackupPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrPreferredBackupTime com.aliyun.ros.cdk.core.IResolvable No description.
attrProtocolType com.aliyun.ros.cdk.core.IResolvable No description.
attrReadonlyReplicas com.aliyun.ros.cdk.core.IResolvable No description.
attrReplicaSetsConnections com.aliyun.ros.cdk.core.IResolvable No description.
attrReplicationFactor com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrSecondaryZoneId com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityIpList com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityIps com.aliyun.ros.cdk.core.IResolvable No description.
attrShardList com.aliyun.ros.cdk.core.IResolvable No description.
attrSnapshotBackupType com.aliyun.ros.cdk.core.IResolvable No description.
attrSslExpiredTime com.aliyun.ros.cdk.core.IResolvable No description.
attrSslStatus com.aliyun.ros.cdk.core.IResolvable No description.
attrStorageEngine com.aliyun.ros.cdk.core.IResolvable No description.
attrTags com.aliyun.ros.cdk.core.IResolvable No description.
attrTdeStatus com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcAuthMode com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcId com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
attrZoneId com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions 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.

attrAccountDescriptionRequired 

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

attrAccountNameRequired 

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

attrAutoRenewRequired 

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

attrAutoRenewDurationRequired 

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

attrBackupIntervalRequired 

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

attrBackupRetentionPeriodRequired 

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

attrCreateTimeRequired 

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

attrDbInstanceClassRequired 

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

attrDbInstanceDescriptionRequired 

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

attrDbInstanceReleaseProtectionRequired 

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

attrDbInstanceStorageRequired 

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

attrDbInstanceTypeRequired 

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

attrEnableBackupLogRequired 

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

attrEngineRequired 

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

attrEngineVersionRequired 

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

attrExpireTimeRequired 

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

attrHiddenZoneIdRequired 

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

attrInstanceIdRequired 

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

attrKindCodeRequired 

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

attrLastDowngradeTimeRequired 

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

attrLockModeRequired 

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

attrLogBackupRetentionPeriodRequired 

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

attrMaintainEndTimeRequired 

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

attrMaintainStartTimeRequired 

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

attrMongosListRequired 

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

attrNetworkAddressesRequired 

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

attrNetworkTypeRequired 

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

attrParametersRequired 

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

attrPaymentTypeRequired 

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

attrPreferredBackupPeriodRequired 

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

attrPreferredBackupTimeRequired 

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

attrProtocolTypeRequired 

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

attrReadonlyReplicasRequired 

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

attrReplicaSetsConnectionsRequired 

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

attrReplicationFactorRequired 

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

attrResourceGroupIdRequired 

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

attrSecondaryZoneIdRequired 

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

attrSecurityGroupIdRequired 

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

attrSecurityIpListRequired 

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

attrSecurityIpsRequired 

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

attrShardListRequired 

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

attrSnapshotBackupTypeRequired 

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

attrSslExpiredTimeRequired 

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

attrSslStatusRequired 

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

attrStorageEngineRequired 

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

attrTagsRequired 

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

attrTdeStatusRequired 

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

attrVpcAuthModeRequired 

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

attrVpcIdRequired 

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

attrVSwitchIdRequired 

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

attrZoneIdRequired 

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

enableResourcePropertyConstraintRequired 

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

instanceIdRequired 

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

refreshOptionsOptional 

public java.lang.Object getRefreshOptions();
  • 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.