Application
- Implements: IApplication
This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Application.
Initializers
import com.aliyun.ros.cdk.polardb.Application;
Application.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.applicationType(java.lang.String)
.applicationType(IResolvable)
.architecture(java.lang.String)
.architecture(IResolvable)
.dbClusterId(java.lang.String)
.dbClusterId(IResolvable)
// .autoCreatePolarFs(java.lang.Boolean)
// .autoCreatePolarFs(IResolvable)
// .components(IResolvable)
// .components(java.util.List<IResolvable)
// .components(ComponentsProperty>)
// .description(java.lang.String)
// .description(IResolvable)
// .payType(java.lang.String)
// .payType(IResolvable)
// .period(java.lang.Number)
// .period(IResolvable)
// .polarFsInstanceId(java.lang.String)
// .polarFsInstanceId(IResolvable)
// .securityGroupId(java.lang.String)
// .securityGroupId(IResolvable)
// .securityIpList(java.lang.String)
// .securityIpList(IResolvable)
// .vpcId(java.lang.String)
// .vpcId(IResolvable)
// .vSwitchId(java.lang.String)
// .vSwitchId(IResolvable)
// .zoneId(java.lang.String)
// .zoneId(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. |
applicationType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property applicationType: The type of the application. |
architecture | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property architecture: The architecture of the application. |
dbClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbClusterId: The ID of the database cluster. |
autoCreatePolarFs | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoCreatePolarFs: Specifies whether to automatically create a PolarFS cold storage instance. |
components | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property components: A list of custom child components for the application. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the application. |
payType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property payType: The billing method of the cluster. |
period | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property period: The subscription period type. |
polarFsInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property polarFsInstanceId: The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance. |
securityGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityGroupId: The ID of the security group. |
securityIpList | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityIpList: The IP address whitelist. |
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: The vSwitch. |
zoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property zoneId: The zone. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
applicationTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property applicationType: The type of the application.
Valid values:
- supabase: Creates a managed Supabase application.
- raycluster: Creates a managed Ray Cluster application.
- polarclaw: Creates a managed PolarClaw application.
architectureRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property architecture: The architecture of the application.
This parameter is required.
dbClusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbClusterId: The ID of the database cluster.
autoCreatePolarFsOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoCreatePolarFs: Specifies whether to automatically create a PolarFS cold storage instance.
Valid values:
- false (default): Does not automatically create the instance.
- true: Automatically creates the instance.
componentsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
ComponentsProperty>
Property components: A list of custom child components for the application.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the application.
payTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property payType: The billing method of the cluster.
Valid values: Postpaid: pay-as-you-go Prepaid: subscription
periodOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: The subscription period type.
polarFsInstanceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property polarFsInstanceId: The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance.
This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application. This feature is currently supported only by the following applications:
- supabase
- raycluster
securityGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupId: The ID of the security group.
securityIpListOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityIpList: The IP address whitelist.
If you do not specify this parameter, the default value 127.0.0.1 is used.
vpcIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the VPC.
vSwitchIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The vSwitch.
The default value is the current vSwitch in the primary zone of the instance.
zoneIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property zoneId: The zone.
The default value is the primary zone of the instance.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.polardb.Application;
Application.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrApplicationId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ApplicationId: The ID of the application. |
props | ApplicationProps | 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
attrApplicationIdRequired
public java.lang.Object getAttrApplicationId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ApplicationId: The ID of the application.
propsRequired
public ApplicationProps getProps();
- Type: ApplicationProps