Skip to content

RosMyBase

This class is a base encapsulation around the ROS resource type ALIYUN::CDDC::MyBase, which is used to create a host in a Proprietary MyBase dedicated cluster in ApsaraDB for MyBase.

Initializers 

import com.aliyun.ros.cdk.cddc.RosMyBase;
RosMyBase.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ecsClassList(IResolvable)
    .ecsClassList(java.util.List<java.util.Map<java.lang.String, java.lang.Object>>)
    .engine(java.lang.String)
    .engine(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .period(java.lang.Number)
    .period(IResolvable)
    .securityGroupId(java.lang.String)
    .securityGroupId(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .dedicatedHostGroupDescription(java.lang.String)
//  .dedicatedHostGroupDescription(IResolvable)
//  .dedicatedHostGroupId(java.lang.String)
//  .dedicatedHostGroupId(IResolvable)
//  .ecsDeploymentSetId(java.lang.String)
//  .ecsDeploymentSetId(IResolvable)
//  .ecsHostName(java.lang.String)
//  .ecsHostName(IResolvable)
//  .ecsInstanceName(java.lang.String)
//  .ecsInstanceName(IResolvable)
//  .ecsUniqueSuffix(java.lang.Boolean)
//  .ecsUniqueSuffix(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .osPassword(java.lang.String)
//  .osPassword(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .userDataInBase64(java.lang.Boolean)
//  .userDataInBase64(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.
ecsClassList com.aliyun.ros.cdk.core.IResolvable OR java.util.List> No description.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId 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.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsDeploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsUniqueSuffix java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
osPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
userDataInBase64 java.lang.Boolean 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

ecsClassListRequired

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

engineRequired

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

payTypeRequired

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

periodRequired

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

securityGroupIdRequired

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

vpcIdRequired

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

vSwitchIdRequired

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

zoneIdRequired

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

autoRenewOptional

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

dedicatedHostGroupDescriptionOptional

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

dedicatedHostGroupIdOptional

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

ecsDeploymentSetIdOptional

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

ecsHostNameOptional

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

ecsInstanceNameOptional

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

ecsUniqueSuffixOptional

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

imageIdOptional

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

internetChargeTypeOptional

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

internetMaxBandwidthOutOptional

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

keyPairNameOptional

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

osPasswordOptional

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

passwordInheritOptional

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

periodTypeOptional

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

resourceGroupIdOptional

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

userDataOptional

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

userDataInBase64Optional

  • Type: java.lang.Boolean 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.cddc.RosMyBase;
RosMyBase.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.cddc.RosMyBase;
RosMyBase.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.cddc.RosMyBase;
RosMyBase.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.
attrInstanceIds com.aliyun.ros.cdk.core.IResolvable No description.
attrOrderIds com.aliyun.ros.cdk.core.IResolvable No description.
ecsClassList com.aliyun.ros.cdk.core.IResolvable OR java.util.List> No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId 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.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsDeploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsUniqueSuffix java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
osPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
userDataInBase64 java.lang.Boolean 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.

attrInstanceIdsRequired 

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

attrOrderIdsRequired 

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

ecsClassListRequired 

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

enableResourcePropertyConstraintRequired 

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

engineRequired 

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

payTypeRequired 

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

periodRequired 

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

securityGroupIdRequired 

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

vpcIdRequired 

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

zoneIdRequired 

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

autoRenewOptional 

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

dedicatedHostGroupDescriptionOptional 

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

dedicatedHostGroupIdOptional 

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

ecsDeploymentSetIdOptional 

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

ecsHostNameOptional 

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

ecsInstanceNameOptional 

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

ecsUniqueSuffixOptional 

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

imageIdOptional 

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

internetChargeTypeOptional 

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

internetMaxBandwidthOutOptional 

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

keyPairNameOptional 

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

osPasswordOptional 

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

passwordInheritOptional 

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

periodTypeOptional 

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

resourceGroupIdOptional 

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

userDataOptional 

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

userDataInBase64Optional 

public java.lang.Object getUserDataInBase64();
  • Type: java.lang.Boolean 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