datasource

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DBCluster_IsConstruct 

func DBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBClusters_IsConstruct 

func DBClusters_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewDBCluster_Override 

func NewDBCluster_Override(d DBCluster, scope alicloudroscdkcore.Construct, id *string, props *DBClusterProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBClusters_Override 

func NewDBClusters_Override(d DBClusters, scope alicloudroscdkcore.Construct, id *string, props *DBClustersProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosDBCluster_Override 

func NewRosDBCluster_Override(r RosDBCluster, scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterProps, enableResourcePropertyConstraint *bool)

func NewRosDBClusters_Override 

func NewRosDBClusters_Override(r RosDBClusters, scope alicloudroscdkcore.Construct, id *string, props *RosDBClustersProps, enableResourcePropertyConstraint *bool)

func RosDBCluster_IsConstruct 

func RosDBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBCluster_IsRosElement 

func RosDBCluster_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 RosDBCluster_IsRosResource 

func RosDBCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBCluster_ROS_RESOURCE_TYPE_NAME 

func RosDBCluster_ROS_RESOURCE_TYPE_NAME() *string

func RosDBClusters_IsConstruct 

func RosDBClusters_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBClusters_IsRosElement 

func RosDBClusters_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 RosDBClusters_IsRosResource 

func RosDBClusters_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBClusters_ROS_RESOURCE_TYPE_NAME 

func RosDBClusters_ROS_RESOURCE_TYPE_NAME() *string

Types

type DBCluster 

type DBCluster interface {
	alicloudroscdkcore.Resource
	// Attribute AliUid: Alibaba Cloud account.
	AttrAliUid() alicloudroscdkcore.IResolvable
	// Attribute Bid: The ID of the business process flow.
	AttrBid() alicloudroscdkcore.IResolvable
	// Attribute Category: Copy configuration, value description:.
	AttrCategory() alicloudroscdkcore.IResolvable
	// Attribute CommodityCode: Buy Product Code.
	AttrCommodityCode() alicloudroscdkcore.IResolvable
	// Attribute ConnectionString: Connection string.
	AttrConnectionString() alicloudroscdkcore.IResolvable
	// Attribute CreateTime: The creation time of the resource.
	AttrCreateTime() alicloudroscdkcore.IResolvable
	// Attribute DBClusterId: Instance ID.
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	// Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
	AttrDbClusterIpArrayName() alicloudroscdkcore.IResolvable
	// Attribute DBClusterName: The cluster description information.
	AttrDbClusterName() alicloudroscdkcore.IResolvable
	// Attribute DbClusterNetworkType: Network type.
	//
	// Currently, only VPC is supported.
	AttrDbClusterNetworkType() alicloudroscdkcore.IResolvable
	// Attribute DBClusterType: Instance type.
	AttrDbClusterType() alicloudroscdkcore.IResolvable
	// Attribute DbNodeClass: Set the node type.
	AttrDbNodeClass() alicloudroscdkcore.IResolvable
	// Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
	AttrDbNodeCount() alicloudroscdkcore.IResolvable
	// Attribute DbNodeStorage: Single-node storage space.
	//
	// Value range: 100 GB to 32000GB.
	AttrDbNodeStorage() alicloudroscdkcore.IResolvable
	// Attribute EncryptionKey: Key management service KMS key ID.
	AttrEncryptionKey() alicloudroscdkcore.IResolvable
	// Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	AttrEncryptionType() alicloudroscdkcore.IResolvable
	// Attribute Engine: Engine.
	AttrEngine() alicloudroscdkcore.IResolvable
	// Attribute EngineVersion: The engine version.
	AttrEngineVersion() alicloudroscdkcore.IResolvable
	// Attribute ExpireTime: The expiration time.
	AttrExpireTime() alicloudroscdkcore.IResolvable
	// Attribute IsExpired: If the instance has expired.
	AttrIsExpired() alicloudroscdkcore.IResolvable
	// Attribute LockMode: The lock mode.
	AttrLockMode() alicloudroscdkcore.IResolvable
	// Attribute LockReason: Lock reason.
	AttrLockReason() alicloudroscdkcore.IResolvable
	// Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
	AttrMaintainTime() alicloudroscdkcore.IResolvable
	// Attribute PaymentType: The paymen type of the resource.
	AttrPaymentType() alicloudroscdkcore.IResolvable
	// Attribute Port: Connection port.
	AttrPort() alicloudroscdkcore.IResolvable
	// Attribute PublicConnectionString: A public IP address for the connection.
	AttrPublicConnectionString() alicloudroscdkcore.IResolvable
	// Attribute PublicIpAddr: Public IP address.
	AttrPublicIpAddr() alicloudroscdkcore.IResolvable
	// Attribute PublicPort: Public network port.
	AttrPublicPort() alicloudroscdkcore.IResolvable
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	// Attribute ScaleOutStatus: Scale state.
	AttrScaleOutStatus() alicloudroscdkcore.IResolvable
	// Attribute SecurityIps: The whitelist supports the following two formats:.
	AttrSecurityIps() alicloudroscdkcore.IResolvable
	// Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
	AttrStorageType() alicloudroscdkcore.IResolvable
	// Attribute SupportBackup: Support fallback scheme.
	AttrSupportBackup() alicloudroscdkcore.IResolvable
	// Attribute SupportHttpsPort: The system supports http port number.
	AttrSupportHttpsPort() alicloudroscdkcore.IResolvable
	// Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
	AttrSupportMysqlPort() alicloudroscdkcore.IResolvable
	// Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
	AttrSupportOss() alicloudroscdkcore.IResolvable
	// Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
	AttrVpcCloudInstanceId() alicloudroscdkcore.IResolvable
	// Attribute VpcId: VPC ID.
	AttrVpcId() alicloudroscdkcore.IResolvable
	// Attribute VpcIpAddr: VPC IP address.
	AttrVpcIpAddr() alicloudroscdkcore.IResolvable
	// Attribute VSwitchId: Switch ID.
	AttrVSwitchId() alicloudroscdkcore.IResolvable
	// Attribute ZoneId: On behalf of the zone resource attribute field.
	AttrZoneId() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	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() *DBClusterProps
	SetProps(val *DBClusterProps)
	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)
	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 `DATASOURCE::ClickHouse::DBCluster`, which is used to query the information about an ApsaraDB for ClickHouse cluster.

func NewDBCluster 

func NewDBCluster(scope alicloudroscdkcore.Construct, id *string, props *DBClusterProps, enableResourcePropertyConstraint *bool) DBCluster

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClusterProps 

type DBClusterProps struct {
	// Property dbClusterId: Instance ID.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
	//
	// Valid values:
	// - Never: Never refresh the datasource resource when the stack is updated.
	// - Always: Always refresh the datasource resource when the stack is updated.
	// Default is Never.
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `DBCluster`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-clickhouse-dbcluster

type DBClusters 

type DBClusters interface {
	alicloudroscdkcore.Resource
	// Attribute DBClusterIds: The list of db cluster IDs.
	AttrDbClusterIds() alicloudroscdkcore.IResolvable
	// Attribute DBClusters: The list of db clusters.
	AttrDbClusters() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	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() *DBClustersProps
	SetProps(val *DBClustersProps)
	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)
	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 `DATASOURCE::ClickHouse::DBClusters`, which is used to query the information about ApsaraDB for ClickHouse clusters.

func NewDBClusters 

func NewDBClusters(scope alicloudroscdkcore.Construct, id *string, props *DBClustersProps, enableResourcePropertyConstraint *bool) DBClusters

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClustersProps 

type DBClustersProps struct {
	// Property dbClusterId: Instance ID.
	DbClusterId interface{} `field:"optional" json:"dbClusterId" yaml:"dbClusterId"`
	// Property dbClusterName: The cluster description information.
	DbClusterName interface{} `field:"optional" json:"dbClusterName" yaml:"dbClusterName"`
	// Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
	//
	// Valid values:
	// - Never: Never refresh the datasource resource when the stack is updated.
	// - Always: Always refresh the datasource resource when the stack is updated.
	// Default is Never.
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `DBClusters`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-clickhouse-dbclusters

type RosDBCluster 

type RosDBCluster interface {
	alicloudroscdkcore.RosResource
	AttrAliUid() alicloudroscdkcore.IResolvable
	AttrBid() alicloudroscdkcore.IResolvable
	AttrCategory() alicloudroscdkcore.IResolvable
	AttrCommodityCode() alicloudroscdkcore.IResolvable
	AttrConnectionString() alicloudroscdkcore.IResolvable
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	AttrDbClusterIpArrayName() alicloudroscdkcore.IResolvable
	AttrDbClusterName() alicloudroscdkcore.IResolvable
	AttrDbClusterNetworkType() alicloudroscdkcore.IResolvable
	AttrDbClusterType() alicloudroscdkcore.IResolvable
	AttrDbNodeClass() alicloudroscdkcore.IResolvable
	AttrDbNodeCount() alicloudroscdkcore.IResolvable
	AttrDbNodeStorage() alicloudroscdkcore.IResolvable
	AttrEncryptionKey() alicloudroscdkcore.IResolvable
	AttrEncryptionType() alicloudroscdkcore.IResolvable
	AttrEngine() alicloudroscdkcore.IResolvable
	AttrEngineVersion() alicloudroscdkcore.IResolvable
	AttrExpireTime() alicloudroscdkcore.IResolvable
	AttrIsExpired() alicloudroscdkcore.IResolvable
	AttrLockMode() alicloudroscdkcore.IResolvable
	AttrLockReason() alicloudroscdkcore.IResolvable
	AttrMaintainTime() alicloudroscdkcore.IResolvable
	AttrPaymentType() alicloudroscdkcore.IResolvable
	AttrPort() alicloudroscdkcore.IResolvable
	AttrPublicConnectionString() alicloudroscdkcore.IResolvable
	AttrPublicIpAddr() alicloudroscdkcore.IResolvable
	AttrPublicPort() alicloudroscdkcore.IResolvable
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	AttrScaleOutStatus() alicloudroscdkcore.IResolvable
	AttrSecurityIps() alicloudroscdkcore.IResolvable
	AttrStorageType() alicloudroscdkcore.IResolvable
	AttrSupportBackup() alicloudroscdkcore.IResolvable
	AttrSupportHttpsPort() alicloudroscdkcore.IResolvable
	AttrSupportMysqlPort() alicloudroscdkcore.IResolvable
	AttrSupportOss() alicloudroscdkcore.IResolvable
	AttrVpcCloudInstanceId() alicloudroscdkcore.IResolvable
	AttrVpcId() alicloudroscdkcore.IResolvable
	AttrVpcIpAddr() alicloudroscdkcore.IResolvable
	AttrVSwitchId() alicloudroscdkcore.IResolvable
	AttrZoneId() alicloudroscdkcore.IResolvable
	// 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
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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
	RefreshOptions() interface{}
	SetRefreshOptions(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// 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{}
	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)
	// 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 `DATASOURCE::ClickHouse::DBCluster`, which is used to query the information about an ApsaraDB for ClickHouse cluster.

func NewRosDBCluster 

func NewRosDBCluster(scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterProps, enableResourcePropertyConstraint *bool) RosDBCluster

type RosDBClusterProps 

type RosDBClusterProps struct {
	DbClusterId    interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `RosDBCluster`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-clickhouse-dbcluster

type RosDBClusters 

type RosDBClusters interface {
	alicloudroscdkcore.RosResource
	AttrDbClusterIds() alicloudroscdkcore.IResolvable
	AttrDbClusters() alicloudroscdkcore.IResolvable
	// 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
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbClusterName() interface{}
	SetDbClusterName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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
	RefreshOptions() interface{}
	SetRefreshOptions(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// 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{}
	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)
	// 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 `DATASOURCE::ClickHouse::DBClusters`, which is used to query the information about ApsaraDB for ClickHouse clusters.

func NewRosDBClusters 

func NewRosDBClusters(scope alicloudroscdkcore.Construct, id *string, props *RosDBClustersProps, enableResourcePropertyConstraint *bool) RosDBClusters

type RosDBClustersProps 

type RosDBClustersProps struct {
	DbClusterId    interface{} `field:"optional" json:"dbClusterId" yaml:"dbClusterId"`
	DbClusterName  interface{} `field:"optional" json:"dbClusterName" yaml:"dbClusterName"`
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `RosDBClusters`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-clickhouse-dbclusters

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.