Skip to content

RosCluster

This class is a base encapsulation around the ROS resource type ALIYUN::MSE::Cluster, which is used to create a cluster.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmse"
alicloudroscdkmse.NewRosCluster(scope Construct, id *string, props RosClusterProps, enableResourcePropertyConstraint *bool) RosCluster
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct - scope in which this resource is defined.
id *string - scoped id of the resource.
props RosClusterProps - resource properties.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

scope in which this resource is defined.


idRequired

  • Type: *string

scoped id of the resource.


propsRequired

resource properties.


enableResourcePropertyConstraintRequired

  • Type: *bool

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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


AddCondition

func AddCondition(con RosCondition)

conRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: *string

The path of the value to delete.


AddDependsOn

func AddDependsOn(target RosResource)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AddDesc

func AddDesc(desc *string)

descRequired

  • Type: *string

AddMetaData

func AddMetaData(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

AddOverride

func AddOverride(path *string, value interface{})

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: *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: interface{}

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: *string

The path to the property.


AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: *string

The path of the property.


valueRequired

  • Type: interface{}

The value.


AddRosDependency

func AddRosDependency(target *string)

targetRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

optionsOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

GetAtt

func GetAtt(attributeName *string) Reference

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: *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 "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmse"
alicloudroscdkmse.RosCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmse"
alicloudroscdkmse.RosCluster_IsRosElement(x interface{}) *bool

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: interface{}

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmse"
alicloudroscdkmse.RosCluster_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

constructRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
CreationStack []string No description.
LogicalId *string The logical ID for this stack element.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this element is defined.
Ref *string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType *string ROS resource type.
AttrAclEntryList github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrAclId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrAppVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterAliasName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterSpecification github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrClusterVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrConfigAuthEnabled github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrConfigSecretEnabled github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrConnectionType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrCpu github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDiskCapacity github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDiskType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrHealthStatus github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInstanceCount github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInstanceId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInternetAddress github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInternetDomain github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInternetPort github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIntranetAddress github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIntranetDomain github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIntranetPort github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMcpEnabled github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMemoryCapacity github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMseVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrNetType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPayInfo github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPubNetworkFlow github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrVpcId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrVSwitchId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
ClusterSpecification interface{} No description.
ClusterType interface{} No description.
ClusterVersion interface{} No description.
EnableResourcePropertyConstraint *bool No description.
InstanceCount interface{} No description.
NetType interface{} No description.
AcceptLanguage interface{} No description.
AclEntryList interface{} No description.
ClusterAliasName interface{} No description.
ConnectionType interface{} No description.
DiskType interface{} No description.
MseVersion interface{} No description.
PrivateSlbSpecification interface{} No description.
PubNetworkFlow interface{} No description.
PubSlbSpecification interface{} No description.
RequestPars interface{} No description.
VpcId interface{} No description.
VSwitchId interface{} No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func LogicalId() *string
  • Type: *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

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

func Ref() *string
  • Type: *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

func RosOptions() IRosResourceOptions
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

func RosResourceType() *string
  • Type: *string

ROS resource type.


AttrAclEntryListRequired

func AttrAclEntryList() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrAclIdRequired

func AttrAclId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrAppVersionRequired

func AttrAppVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterAliasNameRequired

func AttrClusterAliasName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterIdRequired

func AttrClusterId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterNameRequired

func AttrClusterName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterSpecificationRequired

func AttrClusterSpecification() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterTypeRequired

func AttrClusterType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrClusterVersionRequired

func AttrClusterVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrConfigAuthEnabledRequired

func AttrConfigAuthEnabled() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrConfigSecretEnabledRequired

func AttrConfigSecretEnabled() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrConnectionTypeRequired

func AttrConnectionType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCpuRequired

func AttrCpu() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDiskCapacityRequired

func AttrDiskCapacity() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDiskTypeRequired

func AttrDiskType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrHealthStatusRequired

func AttrHealthStatus() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInstanceCountRequired

func AttrInstanceCount() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInstanceIdRequired

func AttrInstanceId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInternetAddressRequired

func AttrInternetAddress() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInternetDomainRequired

func AttrInternetDomain() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInternetPortRequired

func AttrInternetPort() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIntranetAddressRequired

func AttrIntranetAddress() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIntranetDomainRequired

func AttrIntranetDomain() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIntranetPortRequired

func AttrIntranetPort() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMcpEnabledRequired

func AttrMcpEnabled() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMemoryCapacityRequired

func AttrMemoryCapacity() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMseVersionRequired

func AttrMseVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrNetTypeRequired

func AttrNetType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPayInfoRequired

func AttrPayInfo() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPubNetworkFlowRequired

func AttrPubNetworkFlow() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrVpcIdRequired

func AttrVpcId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrVSwitchIdRequired

func AttrVSwitchId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

ClusterSpecificationRequired

func ClusterSpecification() interface{}
  • Type: interface{}

ClusterTypeRequired

func ClusterType() interface{}
  • Type: interface{}

ClusterVersionRequired

func ClusterVersion() interface{}
  • Type: interface{}

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

InstanceCountRequired

func InstanceCount() interface{}
  • Type: interface{}

NetTypeRequired

func NetType() interface{}
  • Type: interface{}

AcceptLanguageOptional

func AcceptLanguage() interface{}
  • Type: interface{}

AclEntryListOptional

func AclEntryList() interface{}
  • Type: interface{}

ClusterAliasNameOptional

func ClusterAliasName() interface{}
  • Type: interface{}

ConnectionTypeOptional

func ConnectionType() interface{}
  • Type: interface{}

DiskTypeOptional

func DiskType() interface{}
  • Type: interface{}

MseVersionOptional

func MseVersion() interface{}
  • Type: interface{}

PrivateSlbSpecificationOptional

func PrivateSlbSpecification() interface{}
  • Type: interface{}

PubNetworkFlowOptional

func PubNetworkFlow() interface{}
  • Type: interface{}

PubSlbSpecificationOptional

func PubSlbSpecification() interface{}
  • Type: interface{}

RequestParsOptional

func RequestPars() interface{}
  • Type: interface{}

VpcIdOptional

func VpcId() interface{}
  • Type: interface{}

VSwitchIdOptional

func VSwitchId() interface{}
  • Type: interface{}

Constants

Name Type Description
RosResourceTypeName *string The resource type name for this resource class.

RosResourceTypeNameRequired

func RosResourceTypeName() *string
  • Type: *string

The resource type name for this resource class.