Skip to content

RosCluster

This class is a base encapsulation around the ROS resource type ALIYUN::ACS::Cluster.

Initializers 

import com.aliyun.ros.cdk.acs.RosCluster;
RosCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .name(java.lang.String)
    .name(IResolvable)
//  .addons(IResolvable)
//  .addons(java.util.List<IResolvable)
//  .addons(AddonsProperty>)
//  .clusterSpec(java.lang.String)
//  .clusterSpec(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .endpointPublicAccess(java.lang.Boolean)
//  .endpointPublicAccess(IResolvable)
//  .ipStack(java.lang.String)
//  .ipStack(IResolvable)
//  .kubernetesVersion(java.lang.String)
//  .kubernetesVersion(IResolvable)
//  .loadBalancerSpec(java.lang.String)
//  .loadBalancerSpec(IResolvable)
//  .loggingType(java.lang.String)
//  .loggingType(IResolvable)
//  .maintenanceWindow(IResolvable)
//  .maintenanceWindow(MaintenanceWindowProperty)
//  .podVSwitchIds(IResolvable)
//  .podVSwitchIds(java.util.List<java.lang.String)
//  .podVSwitchIds(IResolvable>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceCidr(java.lang.String)
//  .serviceCidr(IResolvable)
//  .serviceDiscoveryTypes(IResolvable)
//  .serviceDiscoveryTypes(java.util.List<java.lang.String)
//  .serviceDiscoveryTypes(IResolvable>)
//  .slsProjectName(java.lang.String)
//  .slsProjectName(IResolvable)
//  .snatEntry(java.lang.Boolean)
//  .snatEntry(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeZone(java.lang.String)
//  .timeZone(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchIds(IResolvable)
//  .vSwitchIds(java.util.List<java.lang.String)
//  .vSwitchIds(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.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
addons com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAddonsProperty> No description.
clusterSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
endpointPublicAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
ipStack java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kubernetesVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loggingType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
maintenanceWindow com.aliyun.ros.cdk.core.IResolvable OR MaintenanceWindowProperty No description.
podVSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceDiscoveryTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
slsProjectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
snatEntry java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
timeZone 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.
vSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List 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

nameRequired

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

addonsOptional

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

clusterSpecOptional

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

deletionProtectionOptional

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

endpointPublicAccessOptional

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

ipStackOptional

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

kubernetesVersionOptional

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

loadBalancerSpecOptional

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

loggingTypeOptional

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

maintenanceWindowOptional

podVSwitchIdsOptional

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

resourceGroupIdOptional

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

serviceCidrOptional

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

serviceDiscoveryTypesOptional

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

slsProjectNameOptional

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

snatEntryOptional

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

tagsOptional

timeZoneOptional

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

vpcIdOptional

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

vSwitchIdsOptional

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

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.acs.RosCluster;
RosCluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.acs.RosCluster;
RosCluster.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.acs.RosCluster;
RosCluster.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.
attrApiServerSlbId com.aliyun.ros.cdk.core.IResolvable No description.
attrClusterId com.aliyun.ros.cdk.core.IResolvable No description.
attrDefaultUserKubeConfig com.aliyun.ros.cdk.core.IResolvable No description.
attrIngressSlbId com.aliyun.ros.cdk.core.IResolvable No description.
attrNodes com.aliyun.ros.cdk.core.IResolvable No description.
attrPrivateUserKubConfig com.aliyun.ros.cdk.core.IResolvable No description.
attrScalingConfigurationId com.aliyun.ros.cdk.core.IResolvable No description.
attrScalingGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrScalingRuleId com.aliyun.ros.cdk.core.IResolvable No description.
attrTaskId com.aliyun.ros.cdk.core.IResolvable No description.
attrWorkerRamRoleName com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
addons com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAddonsProperty> No description.
clusterSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
endpointPublicAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
ipStack java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kubernetesVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loggingType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
maintenanceWindow com.aliyun.ros.cdk.core.IResolvable OR MaintenanceWindowProperty No description.
podVSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceDiscoveryTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
slsProjectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
snatEntry java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
timeZone 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.
vSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List 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.

attrApiServerSlbIdRequired 

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

attrClusterIdRequired 

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

attrDefaultUserKubeConfigRequired 

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

attrIngressSlbIdRequired 

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

attrNodesRequired 

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

attrPrivateUserKubConfigRequired 

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

attrScalingConfigurationIdRequired 

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

attrScalingGroupIdRequired 

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

attrScalingRuleIdRequired 

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

attrTaskIdRequired 

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

attrWorkerRamRoleNameRequired 

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

enableResourcePropertyConstraintRequired 

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

nameRequired 

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

addonsOptional 

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

clusterSpecOptional 

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

deletionProtectionOptional 

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

endpointPublicAccessOptional 

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

ipStackOptional 

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

kubernetesVersionOptional 

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

loadBalancerSpecOptional 

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

loggingTypeOptional 

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

maintenanceWindowOptional 

public java.lang.Object getMaintenanceWindow();

podVSwitchIdsOptional 

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

resourceGroupIdOptional 

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

serviceCidrOptional 

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

serviceDiscoveryTypesOptional 

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

slsProjectNameOptional 

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

snatEntryOptional 

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

tagsOptional 

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

timeZoneOptional 

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

vpcIdOptional 

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

vSwitchIdsOptional 

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

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