Skip to content

MyBase

This class encapsulates and extends the ROS resource type ALIYUN::CDDC::MyBase.

Initializers

import com.aliyun.ros.cdk.cddc.MyBase;
MyBase.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 No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
ecsClassList com.aliyun.ros.cdk.core.IResolvable OR java.util.List> Property ecsClassList: ECS Class List.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engine: The database type.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: Payment type, currently only supports PrePaid.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The period of the subscription in months.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: The security group ID.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: Virtual switch ID.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: Availability Zone ID.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether to enable auto renew.
dedicatedHostGroupDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostGroupDescription: The name of the dedicated cluster.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostGroupId: The ID of the dedicated cluster.
ecsDeploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ecsDeploymentSetId: The ID of the deployment set.
ecsHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ecsHostName: For Windows operating systems: The host name must be 2 to 15 characters in length and can contain uppercase letters, lowercase letters, and digits.
ecsInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ecsInstanceName: The instance name.
ecsUniqueSuffix java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property ecsUniqueSuffix: Automatically add a sequential suffix to the HostName and InstanceName when you create multiple instances.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: The custom image ID.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: The network billing method.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property internetMaxBandwidthOut: The maximum outbound public bandwidth, in Mbit\/s.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPairName: The name of the key pair.
osPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property osPassword: The logon password for the host.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property passwordInherit: Use the default password of the image.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodType: Prepaid type, currently only supports Monthly (monthly subscription).
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userData: User-defined script data, the original data is up to 16KB.
userDataInBase64 java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property userDataInBase64: Indicates whether the custom data is Base64-encoded.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

ecsClassListRequired

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

Property ecsClassList: ECS Class List.


engineRequired

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

Property engine: The database type.

Valid values:

  • mysql
  • tair

payTypeRequired

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

Property payType: Payment type, currently only supports PrePaid.


periodRequired

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

Property period: The period of the subscription in months.


securityGroupIdRequired

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

Property securityGroupId: The security group ID.

Specify multiple security groups, separated by commas (,). Format: sg-t4neld965n89ocvt,sg-t4neld965n89ocvu


vpcIdRequired

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

Property vpcId: The ID of the VPC.


vSwitchIdRequired

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

Property vSwitchId: Virtual switch ID.


zoneIdRequired

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

Property zoneId: Availability Zone ID.


autoRenewOptional

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

Property autoRenew: Whether to enable auto renew.


dedicatedHostGroupDescriptionOptional

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

Property dedicatedHostGroupDescription: The name of the dedicated cluster.


dedicatedHostGroupIdOptional

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

Property dedicatedHostGroupId: The ID of the dedicated cluster.


ecsDeploymentSetIdOptional

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

Property ecsDeploymentSetId: The ID of the deployment set.


ecsHostNameOptional

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

Property ecsHostName: For Windows operating systems: The host name must be 2 to 15 characters in length and can contain uppercase letters, lowercase letters, and digits.

It cannot consist of only digits. For other operating systems (such as Linux): The host name must be 2 to 64 characters in length and can contain periods (.) to separate multiple segments. Each segment can contain uppercase letters, lowercase letters, and digits. Consecutive periods (.) are not allowed. The host name cannot start or end with a period (.).


ecsInstanceNameOptional

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

Property ecsInstanceName: The instance name.

It must be 2 to 128 characters in length. It must start with an uppercase letter, a lowercase letter, or a Chinese character. It cannot start with http:// or https://. It can contain Chinese characters, English letters, digits, colons (:), underscores (_), periods (.), or hyphens (-). The default value is the instance ID.


ecsUniqueSuffixOptional

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

Property ecsUniqueSuffix: Automatically add a sequential suffix to the HostName and InstanceName when you create multiple instances.

The sequential suffix starts from 001 and increments up to 999. Valid values:

  • true: Add.
  • false (default): Do not add. If HostName or InstanceName is set in a specific sorting format, and the name_suffix is not set (i.e., the naming format is name_prefix[begin_number,bits]), UniqueSuffix does not take effect. The names are sorted only in the specified order.

imageIdOptional

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

Property imageId: The custom image ID.

If you want to use the default image, do not specify this parameter.


internetChargeTypeOptional

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

Property internetChargeType: The network billing method.

Valid values include the following:


internetMaxBandwidthOutOptional

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

Property internetMaxBandwidthOut: The maximum outbound public bandwidth, in Mbit\/s.

Valid values: 0 to 100. Default value: 0. If you set this parameter to a value greater than 0, a public IP address is automatically created.


keyPairNameOptional

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

Property keyPairName: The name of the key pair.


osPasswordOptional

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

Property osPassword: The logon password for the host.

You can set it later. The password must meet the following requirements:

  • It must be 8 to 30 characters in length.
  • It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
  • Special characters: ()\~!@#$%^&*-_+=|{}[]:;'<>,.?/`
  • If you want to set the logon password later, leave this parameter empty.
  • If you want to set the logon password, use HTTPS to send requests to prevent password leakage.

passwordInheritOptional

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

Property passwordInherit: Use the default password of the image.

  • false (default): Do not use.
  • true: Use.

If you use the default password of the image, do not specify the OSPassword parameter.


periodTypeOptional

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

Property periodType: Prepaid type, currently only supports Monthly (monthly subscription).


resourceGroupIdOptional

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

Property resourceGroupId: Resource group id.


userDataOptional

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

Property userData: User-defined script data, the original data is up to 16KB.


userDataInBase64Optional

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

Property userDataInBase64: Indicates whether the custom data is Base64-encoded.


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.cddc.MyBase;
MyBase.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.
attrInstanceIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceIds: The instance id list of created ecs instances.
attrOrderIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OrderIds: The order id list.
props MyBaseProps 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

attrInstanceIdsRequired

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

Attribute InstanceIds: The instance id list of created ecs instances.


attrOrderIdsRequired

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

Attribute OrderIds: The order id list.


propsRequired

public MyBaseProps getProps();