Documentation
¶
Overview ¶
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Index ¶
- func Cluster_IsConstruct(x interface{}) *bool
- func MultiZoneCluster_IsConstruct(x interface{}) *bool
- func NewCluster_Override(c Cluster, scope alicloudroscdkcore.Construct, id *string, props *ClusterProps, ...)
- func NewMultiZoneCluster_Override(m MultiZoneCluster, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosCluster_Override(r RosCluster, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosMultiZoneCluster_Override(r RosMultiZoneCluster, scope alicloudroscdkcore.Construct, id *string, ...)
- func RosCluster_IsConstruct(x interface{}) *bool
- func RosCluster_IsRosElement(x interface{}) *bool
- func RosCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosCluster_ROS_RESOURCE_TYPE_NAME() *string
- func RosMultiZoneCluster_IsConstruct(x interface{}) *bool
- func RosMultiZoneCluster_IsRosElement(x interface{}) *bool
- func RosMultiZoneCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosMultiZoneCluster_ROS_RESOURCE_TYPE_NAME() *string
- type Cluster
- type ClusterProps
- type ICluster
- type IMultiZoneCluster
- type MultiZoneCluster
- type MultiZoneClusterProps
- type RosCluster
- type RosClusterProps
- type RosMultiZoneCluster
- type RosMultiZoneClusterProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Cluster_IsConstruct ¶
func Cluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func MultiZoneCluster_IsConstruct ¶
func MultiZoneCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewCluster_Override ¶
func NewCluster_Override(c Cluster, scope alicloudroscdkcore.Construct, id *string, props *ClusterProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewMultiZoneCluster_Override ¶
func NewMultiZoneCluster_Override(m MultiZoneCluster, scope alicloudroscdkcore.Construct, id *string, props *MultiZoneClusterProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosCluster_Override ¶
func NewRosCluster_Override(r RosCluster, scope alicloudroscdkcore.Construct, id *string, props *RosClusterProps, enableResourcePropertyConstraint *bool)
func NewRosMultiZoneCluster_Override ¶
func NewRosMultiZoneCluster_Override(r RosMultiZoneCluster, scope alicloudroscdkcore.Construct, id *string, props *RosMultiZoneClusterProps, enableResourcePropertyConstraint *bool)
func RosCluster_IsConstruct ¶
func RosCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosCluster_IsRosElement ¶
func 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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosCluster_IsRosResource ¶
func RosCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosCluster_ROS_RESOURCE_TYPE_NAME ¶
func RosCluster_ROS_RESOURCE_TYPE_NAME() *string
func RosMultiZoneCluster_IsConstruct ¶
func RosMultiZoneCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosMultiZoneCluster_IsRosElement ¶
func RosMultiZoneCluster_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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosMultiZoneCluster_IsRosResource ¶
func RosMultiZoneCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosMultiZoneCluster_ROS_RESOURCE_TYPE_NAME ¶
func RosMultiZoneCluster_ROS_RESOURCE_TYPE_NAME() *string
Types ¶
type Cluster ¶
type Cluster interface {
alicloudroscdkcore.Resource
ICluster
// Attribute ClusterId: The ID of the instance.
AttrClusterId() interface{}
// Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
AttrServiceConnAddrs() interface{}
// Attribute SlbConnAddrs: LIST of SlbConnAddr.
AttrSlbConnAddrs() interface{}
// Attribute ThriftConn: Thrift Connection address list.
AttrThriftConn() interface{}
// Attribute UiProxyConnAddrInfo: WebUI connection information list.
AttrUiProxyConnAddrInfo() interface{}
// Attribute ZkConnAddrs: List of ZkConnAddr.
AttrZkConnAddrs() interface{}
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
// 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.
Env() alicloudroscdkcore.IResourceEnvironment
Id() *string
SetId(val *string)
// The construct tree node associated with this construct.
Node() alicloudroscdkcore.ConstructNode
// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by ROS
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
Props() *ClusterProps
Ref() *string
Resource() alicloudroscdkcore.RosResource
SetResource(val alicloudroscdkcore.RosResource)
Scope() alicloudroscdkcore.Construct
SetScope(val alicloudroscdkcore.Construct)
// The stack in which this resource is defined.
Stack() alicloudroscdkcore.Stack
AddCondition(condition alicloudroscdkcore.RosCondition)
AddCount(count interface{})
AddDependency(resource alicloudroscdkcore.Resource)
AddResourceDesc(desc *string)
ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDependency() *[]*string
FetchResourceDesc() *string
GeneratePhysicalName() *string
GetAtt(name *string) alicloudroscdkcore.IResolvable
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// 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.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
SetMetadata(key *string, value interface{})
// 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.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
}
This class encapsulates and extends the ROS resource type `ALIYUN::HBase::Cluster`, which is used to create an ApsaraDB for HBase cluster.
func NewCluster ¶
func NewCluster(scope alicloudroscdkcore.Construct, id *string, props *ClusterProps, enableResourcePropertyConstraint *bool) Cluster
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ClusterProps ¶
type ClusterProps struct {
// Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.
CoreInstanceType interface{} `field:"required" json:"coreInstanceType" yaml:"coreInstanceType"`
// Property engine: The type of the service.
//
// Valid values:
// hbase
// hbaseue
// bds.
Engine interface{} `field:"required" json:"engine" yaml:"engine"`
// Property engineVersion: The version of the engine.
//
// Valid values:
// hbase:1.1, 2.0
// hbaseue:2.0
// bds:1.0
EngineVersion interface{} `field:"required" json:"engineVersion" yaml:"engineVersion"`
// Property nodeCount: The number of nodes.
//
// Valid values: 1 to 100.
// ApsaraDB for HBase in single-node mode: one node
// ApsaraDB for HBase that runs in cluster mode and uses disks: at least two nodes
// ApsaraDB for HBase that runs in cluster mode and uses local disks: at least three
// nodes.
NodeCount interface{} `field:"required" json:"nodeCount" yaml:"nodeCount"`
// Property payType: The billing method.
//
// Prepaid: The subscription billing method is used.
// Postpaid: The pay-as-you-go billing method is used.
PayType interface{} `field:"required" json:"payType" yaml:"payType"`
// Property zoneId: The ID of the zone.
ZoneId interface{} `field:"required" json:"zoneId" yaml:"zoneId"`
// Property autoRenewPeriod: The auto-renewal period.
//
// Unit: month.
// The default value of this parameter is 0. This value indicates that auto-renewal is
// disabled.
// If this parameter is set to 2, the instance is automatically renewed for a two-month
// subscription after the instance expires.
AutoRenewPeriod interface{} `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
// Property clusterName: The name of the instance.
//
// The name must be 2 to 128 characters in length, and can contain letters, digits, periods
// (.), underscores (_), and hyphens (-). It must start with a letter.
ClusterName interface{} `field:"optional" json:"clusterName" yaml:"clusterName"`
// Property coldStorageSize: The size of cold data storage.
//
// If this parameter is set to 0, cold data storage is disabled.
// If this parameter is set to a value greater than 0, cold data storage is enabled.
// The storage size ranges from 800 GB to 100,000 GB and the step size is 10 GB.
ColdStorageSize interface{} `field:"optional" json:"coldStorageSize" yaml:"coldStorageSize"`
// Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
//
// Default is false.
DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
// Property diskSize: The disk size of the node.
//
// Unit: GB.
// For ApsaraDB for HBase in single-node mode, the disk size ranges from 20 GB to 500
// GB and the step size is 1 GB.
// For ApsaraDB for HBase that runs in cluster mode and uses disks, the disk size ranges
// from 400 GB to 64,000 GB and the step size is 40 GB.
// For ApsaraDB for HBase that runs in cluster mode and uses local disks, the disk size
// varies by instance type. The following list provides the mappings between disks sizes
// and instance types:
// hbase.d1.4xlarge =44000
// hbase.d1.6xlarge =66000
// hbase.d1.8xlarge =88000
// hbase.i2.xlarge =894
// hbase.i2.2xlarge =1788
// hbase.i2.4xlarge =3576
// hbase.i2.8xlarge =7152
// hbase.d2s.5xlarge =58400
// hbase.d2s.10xlarge =109500
DiskSize interface{} `field:"optional" json:"diskSize" yaml:"diskSize"`
// Property diskType: The type of the disk.
//
// Valid values:
// cloud_efficiency
// cloud_ssd
// local_hdd_pro
// local_ssd_pro
// cloud_essd_pl1.
DiskType interface{} `field:"optional" json:"diskType" yaml:"diskType"`
// Property encryptionKey: The encrypted key ID is empty if the encryption is not enabled.
//
// It shows that the current cloud disk version is unable to close after the encryption is turned on.
EncryptionKey interface{} `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
// Property masterInstanceType: The instance type of the master node.
//
// You can call the DescribeAvailableResource operation to obtain the value of this parameter.
MasterInstanceType interface{} `field:"optional" json:"masterInstanceType" yaml:"masterInstanceType"`
// Property period: The subscription period.
//
// This parameter only takes effect when the PayType parameter is set to Prepaid.
// When the PeriodUnit parameter is set to year, the value of the Period parameter ranges
// from 1 to 5.
// When the PeriodUnit parameter is set to month, the value of the Period parameter ranges
// from 1 to 9.
Period interface{} `field:"optional" json:"period" yaml:"period"`
// Property periodUnit: The unit of the subscription period.
//
// Valid values:
// year
// month.
PeriodUnit interface{} `field:"optional" json:"periodUnit" yaml:"periodUnit"`
// Property resourceGroupId: The ID of the resource group.
//
// You can query the group ID in the resource group console.
// If you leave this parameter empty, the instance is allocated to the default resource
// group.
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
// Property securityIpList: The IP addresses in the whitelist.
//
// Example: 192.168.*.*\/24. The 0.0.0.0\/0 value cannot
// be added to the whitelist. Separate multiple IP addresses with commas (,).
SecurityIpList interface{} `field:"optional" json:"securityIpList" yaml:"securityIpList"`
// Property vpcId: The ID of the virtual private cloud (VPC).
//
// If you leave this parameter and the VSwitchId
// parameter empty, the classic network type is used. The VPC network type is preferred.
VpcId interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
// Property vSwitchId: The ID of the vSwitch.
VSwitchId interface{} `field:"optional" json:"vSwitchId" yaml:"vSwitchId"`
}
Properties for defining a `Cluster`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-cluster
type ICluster ¶ added in v1.6.0
type ICluster interface {
alicloudroscdkcore.IResource
// Attribute ClusterId: The ID of the instance.
AttrClusterId() interface{}
// Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
AttrServiceConnAddrs() interface{}
// Attribute SlbConnAddrs: LIST of SlbConnAddr.
AttrSlbConnAddrs() interface{}
// Attribute ThriftConn: Thrift Connection address list.
AttrThriftConn() interface{}
// Attribute UiProxyConnAddrInfo: WebUI connection information list.
AttrUiProxyConnAddrInfo() interface{}
// Attribute ZkConnAddrs: List of ZkConnAddr.
AttrZkConnAddrs() interface{}
Props() *ClusterProps
}
Represents a `Cluster`.
type IMultiZoneCluster ¶ added in v1.6.0
type IMultiZoneCluster interface {
alicloudroscdkcore.IResource
// Attribute ClusterId: The ID of the instance.
AttrClusterId() interface{}
// Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
AttrServiceConnAddrs() interface{}
// Attribute SlbConnAddrs: LIST of SlbConnAddr.
AttrSlbConnAddrs() interface{}
// Attribute ThriftConn: Thrift Connection address list.
AttrThriftConn() interface{}
// Attribute UiProxyConnAddrInfo: WebUI connection information list.
AttrUiProxyConnAddrInfo() interface{}
// Attribute ZkConnAddrs: List of ZkConnAddr.
AttrZkConnAddrs() interface{}
Props() *MultiZoneClusterProps
}
Represents a `MultiZoneCluster`.
type MultiZoneCluster ¶
type MultiZoneCluster interface {
alicloudroscdkcore.Resource
IMultiZoneCluster
// Attribute ClusterId: The ID of the instance.
AttrClusterId() interface{}
// Attribute ServiceConnAddrs: LIST of ServiceConnAddr.
AttrServiceConnAddrs() interface{}
// Attribute SlbConnAddrs: LIST of SlbConnAddr.
AttrSlbConnAddrs() interface{}
// Attribute ThriftConn: Thrift Connection address list.
AttrThriftConn() interface{}
// Attribute UiProxyConnAddrInfo: WebUI connection information list.
AttrUiProxyConnAddrInfo() interface{}
// Attribute ZkConnAddrs: List of ZkConnAddr.
AttrZkConnAddrs() interface{}
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
// 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.
Env() alicloudroscdkcore.IResourceEnvironment
Id() *string
SetId(val *string)
// The construct tree node associated with this construct.
Node() alicloudroscdkcore.ConstructNode
// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by ROS
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
Props() *MultiZoneClusterProps
Ref() *string
Resource() alicloudroscdkcore.RosResource
SetResource(val alicloudroscdkcore.RosResource)
Scope() alicloudroscdkcore.Construct
SetScope(val alicloudroscdkcore.Construct)
// The stack in which this resource is defined.
Stack() alicloudroscdkcore.Stack
AddCondition(condition alicloudroscdkcore.RosCondition)
AddCount(count interface{})
AddDependency(resource alicloudroscdkcore.Resource)
AddResourceDesc(desc *string)
ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDependency() *[]*string
FetchResourceDesc() *string
GeneratePhysicalName() *string
GetAtt(name *string) alicloudroscdkcore.IResolvable
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// 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.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
SetMetadata(key *string, value interface{})
// 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.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
}
This class encapsulates and extends the ROS resource type `ALIYUN::HBase::MultiZoneCluster`, which is used to create an ApsaraDB for HBase cluster that resides in multiple zones.
func NewMultiZoneCluster ¶
func NewMultiZoneCluster(scope alicloudroscdkcore.Construct, id *string, props *MultiZoneClusterProps, enableResourcePropertyConstraint *bool) MultiZoneCluster
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type MultiZoneClusterProps ¶
type MultiZoneClusterProps struct {
// Property arbiterVSwitchId: Arbitration virtual switch ID.
//
// The switch must be in the availability zone corresponding to ArbiterZoneId.
ArbiterVSwitchId interface{} `field:"required" json:"arbiterVSwitchId" yaml:"arbiterVSwitchId"`
// Property arbiterZoneId: Arbiter zond id.
ArbiterZoneId interface{} `field:"required" json:"arbiterZoneId" yaml:"arbiterZoneId"`
// Property archVersion: Version of the deployment architecture.
//
// Currently, only the hbaseue engine type is supported. The value can be 2.0.
ArchVersion interface{} `field:"required" json:"archVersion" yaml:"archVersion"`
// Property coreDiskSize: The value ranges from 400 GB to 64,000 GB.
//
// The step size is 40 GB.
CoreDiskSize interface{} `field:"required" json:"coreDiskSize" yaml:"coreDiskSize"`
// Property coreDiskType: Core node disk type.
//
// Valid values:
// cloud_efficiency
// cloud_ssd
// local_hdd_pro
// local_ssd_pro.
CoreDiskType interface{} `field:"required" json:"coreDiskType" yaml:"coreDiskType"`
// Property coreInstanceType: You can call the DescribeAvailableResource operation to obtain the value of this parameter.
CoreInstanceType interface{} `field:"required" json:"coreInstanceType" yaml:"coreInstanceType"`
// Property coreNodeCount: Number of Core nodes.
//
// The value of the number of Core nodes ranges from 2 to 20, and the increment is a multiple of 2.
CoreNodeCount interface{} `field:"required" json:"coreNodeCount" yaml:"coreNodeCount"`
// Property engine: Service type.
//
// Currently, only HBase enhanced version is supported. The value can be hbaseue.
Engine interface{} `field:"required" json:"engine" yaml:"engine"`
// Property engineVersion: The version of the engine.
//
// Valid values:
// hbaseue:2.0
EngineVersion interface{} `field:"required" json:"engineVersion" yaml:"engineVersion"`
// Property logDiskSize: log disk size.
//
// The value ranges from 400 GB to 64,000 GB. The step size is 40 GB.
LogDiskSize interface{} `field:"required" json:"logDiskSize" yaml:"logDiskSize"`
// Property logDiskType: Log node disk type.
//
// Valid values:
// cloud_efficiency
// cloud_ssd
// local_hdd_pro
// local_ssd_pro.
LogDiskType interface{} `field:"required" json:"logDiskType" yaml:"logDiskType"`
// Property logInstanceType: Log instance type.
LogInstanceType interface{} `field:"required" json:"logInstanceType" yaml:"logInstanceType"`
// Property logNodeCount: Log number of nodes.
//
// The value of log nodes ranges from 4 to 400 and is a multiple of 4.
LogNodeCount interface{} `field:"required" json:"logNodeCount" yaml:"logNodeCount"`
// Property multiZoneCombination: Availability zone combination.
MultiZoneCombination interface{} `field:"required" json:"multiZoneCombination" yaml:"multiZoneCombination"`
// Property payType: The billing method.
//
// Prepaid: The subscription billing method is used.
// Postpaid: The pay-as-you-go billing method is used.
PayType interface{} `field:"required" json:"payType" yaml:"payType"`
// Property primaryVSwitchId: The virtual switch ID of the instance in primary availability zone must be in the availability zone corresponding to PrimaryZoneId.
PrimaryVSwitchId interface{} `field:"required" json:"primaryVSwitchId" yaml:"primaryVSwitchId"`
// Property primaryZoneId: Availability zone ID of the primary availability zone instance.
PrimaryZoneId interface{} `field:"required" json:"primaryZoneId" yaml:"primaryZoneId"`
// Property standbyVSwitchId: The virtual switch ID of the standby availability zone instance must be in the corresponding availability zone of StandbyZoneId.
StandbyVSwitchId interface{} `field:"required" json:"standbyVSwitchId" yaml:"standbyVSwitchId"`
// Property standbyZoneId: Standby zone id.
StandbyZoneId interface{} `field:"required" json:"standbyZoneId" yaml:"standbyZoneId"`
// Property autoRenewPeriod: The auto-renewal period.
//
// Unit: month.
// The default value of this parameter is 0. This value indicates that auto-renewal is
// disabled.
// If this parameter is set to 2, the instance is automatically renewed for a two-month
// subscription after the instance expires.
AutoRenewPeriod interface{} `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
// Property clusterName: The name of the instance.
//
// The name must be 2 to 128 characters in length, and can contain letters, digits, periods
// (.), underscores (_), and hyphens (-). It must start with a letter.
ClusterName interface{} `field:"optional" json:"clusterName" yaml:"clusterName"`
// Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
//
// Default is false.
DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
// Property masterInstanceType: The instance type of the master node.
//
// You can call the DescribeAvailableResource operation to obtain the value of this parameter.
MasterInstanceType interface{} `field:"optional" json:"masterInstanceType" yaml:"masterInstanceType"`
// Property period: The subscription period.
//
// This parameter only takes effect when the PayType parameter is set to Prepaid.
// When the PeriodUnit parameter is set to year, the value of the Period parameter ranges
// from 1 to 5.
// When the PeriodUnit parameter is set to month, the value of the Period parameter ranges
// from 1 to 9.
Period interface{} `field:"optional" json:"period" yaml:"period"`
// Property periodUnit: The unit of the subscription period.
//
// Valid values:
// year
// month.
PeriodUnit interface{} `field:"optional" json:"periodUnit" yaml:"periodUnit"`
// Property resourceGroupId: The ID of the resource group.
//
// You can query the group ID in the resource group console.
// If you leave this parameter empty, the instance is allocated to the default resource
// group.
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
// Property securityIpList: The IP addresses in the whitelist.
//
// Example: 192.168.*.*\/24. The 0.0.0.0\/0 value cannot
// be added to the whitelist. Separate multiple IP addresses with commas (,).
SecurityIpList interface{} `field:"optional" json:"securityIpList" yaml:"securityIpList"`
// Property vpcId: The ID of the virtual private cloud (VPC).
//
// If you leave this parameter and the VSwitchId
// parameter empty, the classic network type is used. The VPC network type is preferred.
VpcId interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
}
Properties for defining a `MultiZoneCluster`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-multizonecluster
type RosCluster ¶
type RosCluster interface {
alicloudroscdkcore.RosResource
AttrClusterId() alicloudroscdkcore.IResolvable
AttrServiceConnAddrs() alicloudroscdkcore.IResolvable
AttrSlbConnAddrs() alicloudroscdkcore.IResolvable
AttrThriftConn() alicloudroscdkcore.IResolvable
AttrUiProxyConnAddrInfo() alicloudroscdkcore.IResolvable
AttrZkConnAddrs() alicloudroscdkcore.IResolvable
AutoRenewPeriod() interface{}
SetAutoRenewPeriod(val interface{})
ClusterName() interface{}
SetClusterName(val interface{})
ColdStorageSize() interface{}
SetColdStorageSize(val interface{})
CoreInstanceType() interface{}
SetCoreInstanceType(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
DeletionProtection() interface{}
SetDeletionProtection(val interface{})
DiskSize() interface{}
SetDiskSize(val interface{})
DiskType() interface{}
SetDiskType(val interface{})
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
EncryptionKey() interface{}
SetEncryptionKey(val interface{})
Engine() interface{}
SetEngine(val interface{})
EngineVersion() interface{}
SetEngineVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
MasterInstanceType() interface{}
SetMasterInstanceType(val interface{})
// The construct tree node associated with this construct.
Node() alicloudroscdkcore.ConstructNode
NodeCount() interface{}
SetNodeCount(val interface{})
PayType() interface{}
SetPayType(val interface{})
Period() interface{}
SetPeriod(val interface{})
PeriodUnit() interface{}
SetPeriodUnit(val interface{})
// 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 })`.
Ref() *string
ResourceGroupId() interface{}
SetResourceGroupId(val interface{})
// Options for this resource, such as condition, update policy etc.
RosOptions() alicloudroscdkcore.IRosResourceOptions
RosProperties() *map[string]interface{}
// ROS resource type.
RosResourceType() *string
SecurityIpList() interface{}
SetSecurityIpList(val interface{})
// The stack in which this element is defined.
//
// RosElements must be defined within a stack scope (directly or indirectly).
Stack() alicloudroscdkcore.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
VpcId() interface{}
SetVpcId(val interface{})
VSwitchId() interface{}
SetVSwitchId(val interface{})
ZoneId() interface{}
SetZoneId(val interface{})
AddCondition(con alicloudroscdkcore.RosCondition)
AddCount(count interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target alicloudroscdkcore.RosResource)
AddDesc(desc *string)
AddMetaData(key *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,
// “`typescript
// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
AddRosDependency(target *string)
// Sets the deletion policy of the resource based on the removal policy specified.
ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDesc() *string
FetchRosDependency() *[]*string
// 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.
GetAtt(attributeName *string) alicloudroscdkcore.Reference
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// 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.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
ValidateProperties(_properties interface{})
}
This class is a base encapsulation around the ROS resource type `ALIYUN::HBase::Cluster`, which is used to create an ApsaraDB for HBase cluster.
func NewRosCluster ¶
func NewRosCluster(scope alicloudroscdkcore.Construct, id *string, props *RosClusterProps, enableResourcePropertyConstraint *bool) RosCluster
type RosClusterProps ¶
type RosClusterProps struct {
CoreInstanceType interface{} `field:"required" json:"coreInstanceType" yaml:"coreInstanceType"`
Engine interface{} `field:"required" json:"engine" yaml:"engine"`
EngineVersion interface{} `field:"required" json:"engineVersion" yaml:"engineVersion"`
NodeCount interface{} `field:"required" json:"nodeCount" yaml:"nodeCount"`
PayType interface{} `field:"required" json:"payType" yaml:"payType"`
ZoneId interface{} `field:"required" json:"zoneId" yaml:"zoneId"`
AutoRenewPeriod interface{} `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
ClusterName interface{} `field:"optional" json:"clusterName" yaml:"clusterName"`
ColdStorageSize interface{} `field:"optional" json:"coldStorageSize" yaml:"coldStorageSize"`
DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
DiskSize interface{} `field:"optional" json:"diskSize" yaml:"diskSize"`
DiskType interface{} `field:"optional" json:"diskType" yaml:"diskType"`
EncryptionKey interface{} `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
MasterInstanceType interface{} `field:"optional" json:"masterInstanceType" yaml:"masterInstanceType"`
Period interface{} `field:"optional" json:"period" yaml:"period"`
PeriodUnit interface{} `field:"optional" json:"periodUnit" yaml:"periodUnit"`
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
SecurityIpList interface{} `field:"optional" json:"securityIpList" yaml:"securityIpList"`
VpcId interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
VSwitchId interface{} `field:"optional" json:"vSwitchId" yaml:"vSwitchId"`
}
Properties for defining a `RosCluster`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-cluster
type RosMultiZoneCluster ¶
type RosMultiZoneCluster interface {
alicloudroscdkcore.RosResource
ArbiterVSwitchId() interface{}
SetArbiterVSwitchId(val interface{})
ArbiterZoneId() interface{}
SetArbiterZoneId(val interface{})
ArchVersion() interface{}
SetArchVersion(val interface{})
AttrClusterId() alicloudroscdkcore.IResolvable
AttrServiceConnAddrs() alicloudroscdkcore.IResolvable
AttrSlbConnAddrs() alicloudroscdkcore.IResolvable
AttrThriftConn() alicloudroscdkcore.IResolvable
AttrUiProxyConnAddrInfo() alicloudroscdkcore.IResolvable
AttrZkConnAddrs() alicloudroscdkcore.IResolvable
AutoRenewPeriod() interface{}
SetAutoRenewPeriod(val interface{})
ClusterName() interface{}
SetClusterName(val interface{})
CoreDiskSize() interface{}
SetCoreDiskSize(val interface{})
CoreDiskType() interface{}
SetCoreDiskType(val interface{})
CoreInstanceType() interface{}
SetCoreInstanceType(val interface{})
CoreNodeCount() interface{}
SetCoreNodeCount(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
DeletionProtection() interface{}
SetDeletionProtection(val interface{})
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
Engine() interface{}
SetEngine(val interface{})
EngineVersion() interface{}
SetEngineVersion(val interface{})
LogDiskSize() interface{}
SetLogDiskSize(val interface{})
LogDiskType() interface{}
SetLogDiskType(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
LogInstanceType() interface{}
SetLogInstanceType(val interface{})
LogNodeCount() interface{}
SetLogNodeCount(val interface{})
MasterInstanceType() interface{}
SetMasterInstanceType(val interface{})
MultiZoneCombination() interface{}
SetMultiZoneCombination(val interface{})
// The construct tree node associated with this construct.
Node() alicloudroscdkcore.ConstructNode
PayType() interface{}
SetPayType(val interface{})
Period() interface{}
SetPeriod(val interface{})
PeriodUnit() interface{}
SetPeriodUnit(val interface{})
PrimaryVSwitchId() interface{}
SetPrimaryVSwitchId(val interface{})
PrimaryZoneId() interface{}
SetPrimaryZoneId(val interface{})
// 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 })`.
Ref() *string
ResourceGroupId() interface{}
SetResourceGroupId(val interface{})
// Options for this resource, such as condition, update policy etc.
RosOptions() alicloudroscdkcore.IRosResourceOptions
RosProperties() *map[string]interface{}
// ROS resource type.
RosResourceType() *string
SecurityIpList() interface{}
SetSecurityIpList(val interface{})
// The stack in which this element is defined.
//
// RosElements must be defined within a stack scope (directly or indirectly).
Stack() alicloudroscdkcore.Stack
StandbyVSwitchId() interface{}
SetStandbyVSwitchId(val interface{})
StandbyZoneId() interface{}
SetStandbyZoneId(val interface{})
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
VpcId() interface{}
SetVpcId(val interface{})
AddCondition(con alicloudroscdkcore.RosCondition)
AddCount(count interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target alicloudroscdkcore.RosResource)
AddDesc(desc *string)
AddMetaData(key *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,
// “`typescript
// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
AddRosDependency(target *string)
// Sets the deletion policy of the resource based on the removal policy specified.
ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDesc() *string
FetchRosDependency() *[]*string
// 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.
GetAtt(attributeName *string) alicloudroscdkcore.Reference
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// 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.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
ValidateProperties(_properties interface{})
}
This class is a base encapsulation around the ROS resource type `ALIYUN::HBase::MultiZoneCluster`, which is used to create an ApsaraDB for HBase cluster that resides in multiple zones.
func NewRosMultiZoneCluster ¶
func NewRosMultiZoneCluster(scope alicloudroscdkcore.Construct, id *string, props *RosMultiZoneClusterProps, enableResourcePropertyConstraint *bool) RosMultiZoneCluster
type RosMultiZoneClusterProps ¶
type RosMultiZoneClusterProps struct {
ArbiterVSwitchId interface{} `field:"required" json:"arbiterVSwitchId" yaml:"arbiterVSwitchId"`
ArbiterZoneId interface{} `field:"required" json:"arbiterZoneId" yaml:"arbiterZoneId"`
ArchVersion interface{} `field:"required" json:"archVersion" yaml:"archVersion"`
CoreDiskSize interface{} `field:"required" json:"coreDiskSize" yaml:"coreDiskSize"`
CoreDiskType interface{} `field:"required" json:"coreDiskType" yaml:"coreDiskType"`
CoreInstanceType interface{} `field:"required" json:"coreInstanceType" yaml:"coreInstanceType"`
CoreNodeCount interface{} `field:"required" json:"coreNodeCount" yaml:"coreNodeCount"`
Engine interface{} `field:"required" json:"engine" yaml:"engine"`
EngineVersion interface{} `field:"required" json:"engineVersion" yaml:"engineVersion"`
LogDiskSize interface{} `field:"required" json:"logDiskSize" yaml:"logDiskSize"`
LogDiskType interface{} `field:"required" json:"logDiskType" yaml:"logDiskType"`
LogInstanceType interface{} `field:"required" json:"logInstanceType" yaml:"logInstanceType"`
LogNodeCount interface{} `field:"required" json:"logNodeCount" yaml:"logNodeCount"`
MultiZoneCombination interface{} `field:"required" json:"multiZoneCombination" yaml:"multiZoneCombination"`
PayType interface{} `field:"required" json:"payType" yaml:"payType"`
PrimaryVSwitchId interface{} `field:"required" json:"primaryVSwitchId" yaml:"primaryVSwitchId"`
PrimaryZoneId interface{} `field:"required" json:"primaryZoneId" yaml:"primaryZoneId"`
StandbyVSwitchId interface{} `field:"required" json:"standbyVSwitchId" yaml:"standbyVSwitchId"`
StandbyZoneId interface{} `field:"required" json:"standbyZoneId" yaml:"standbyZoneId"`
AutoRenewPeriod interface{} `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
ClusterName interface{} `field:"optional" json:"clusterName" yaml:"clusterName"`
DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
MasterInstanceType interface{} `field:"optional" json:"masterInstanceType" yaml:"masterInstanceType"`
Period interface{} `field:"optional" json:"period" yaml:"period"`
PeriodUnit interface{} `field:"optional" json:"periodUnit" yaml:"periodUnit"`
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
SecurityIpList interface{} `field:"optional" json:"securityIpList" yaml:"securityIpList"`
VpcId interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
}
Properties for defining a `RosMultiZoneCluster`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbase-multizonecluster