Documentation ¶
Index ¶
- func DBClusters_IsConstruct(x interface{}) *bool
- func DBNodeClasses_IsConstruct(x interface{}) *bool
- func GlobalDatabaseNetwork_IsConstruct(x interface{}) *bool
- func GlobalDatabaseNetworks_IsConstruct(x interface{}) *bool
- func NewDBClusters_Override(d DBClusters, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewDBNodeClasses_Override(d DBNodeClasses, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewGlobalDatabaseNetwork_Override(g GlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewGlobalDatabaseNetworks_Override(g GlobalDatabaseNetworks, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewParameterGroup_Override(p ParameterGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewParameterGroups_Override(p ParameterGroups, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosDBClusters_Override(r RosDBClusters, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosDBNodeClasses_Override(r RosDBNodeClasses, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosGlobalDatabaseNetwork_Override(r RosGlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosGlobalDatabaseNetworks_Override(r RosGlobalDatabaseNetworks, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosParameterGroup_Override(r RosParameterGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosParameterGroups_Override(r RosParameterGroups, scope alicloudroscdkcore.Construct, id *string, ...)
- func ParameterGroup_IsConstruct(x interface{}) *bool
- func ParameterGroups_IsConstruct(x interface{}) *bool
- func RosDBClusters_IsConstruct(x interface{}) *bool
- func RosDBClusters_IsRosElement(x interface{}) *bool
- func RosDBClusters_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosDBClusters_ROS_RESOURCE_TYPE_NAME() *string
- func RosDBNodeClasses_IsConstruct(x interface{}) *bool
- func RosDBNodeClasses_IsRosElement(x interface{}) *bool
- func RosDBNodeClasses_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosDBNodeClasses_ROS_RESOURCE_TYPE_NAME() *string
- func RosGlobalDatabaseNetwork_IsConstruct(x interface{}) *bool
- func RosGlobalDatabaseNetwork_IsRosElement(x interface{}) *bool
- func RosGlobalDatabaseNetwork_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGlobalDatabaseNetwork_ROS_RESOURCE_TYPE_NAME() *string
- func RosGlobalDatabaseNetworks_IsConstruct(x interface{}) *bool
- func RosGlobalDatabaseNetworks_IsRosElement(x interface{}) *bool
- func RosGlobalDatabaseNetworks_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGlobalDatabaseNetworks_ROS_RESOURCE_TYPE_NAME() *string
- func RosParameterGroup_IsConstruct(x interface{}) *bool
- func RosParameterGroup_IsRosElement(x interface{}) *bool
- func RosParameterGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosParameterGroup_ROS_RESOURCE_TYPE_NAME() *string
- func RosParameterGroups_IsConstruct(x interface{}) *bool
- func RosParameterGroups_IsRosElement(x interface{}) *bool
- func RosParameterGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosParameterGroups_ROS_RESOURCE_TYPE_NAME() *string
- type DBClusters
- type DBClustersProps
- type DBNodeClasses
- type DBNodeClassesProps
- type GlobalDatabaseNetwork
- type GlobalDatabaseNetworkProps
- type GlobalDatabaseNetworks
- type GlobalDatabaseNetworksProps
- type ParameterGroup
- type ParameterGroupProps
- type ParameterGroups
- type ParameterGroupsProps
- type RosDBClusters
- type RosDBClustersProps
- type RosDBNodeClasses
- type RosDBNodeClassesProps
- type RosGlobalDatabaseNetwork
- type RosGlobalDatabaseNetworkProps
- type RosGlobalDatabaseNetworks
- type RosGlobalDatabaseNetworksProps
- type RosParameterGroup
- type RosParameterGroupProps
- type RosParameterGroups
- type RosParameterGroupsProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DBClusters_IsConstruct ¶
func DBClusters_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func DBNodeClasses_IsConstruct ¶
func DBNodeClasses_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func GlobalDatabaseNetwork_IsConstruct ¶
func GlobalDatabaseNetwork_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func GlobalDatabaseNetworks_IsConstruct ¶
func GlobalDatabaseNetworks_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
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 NewDBNodeClasses_Override ¶
func NewDBNodeClasses_Override(d DBNodeClasses, scope alicloudroscdkcore.Construct, id *string, props *DBNodeClassesProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewGlobalDatabaseNetwork_Override ¶
func NewGlobalDatabaseNetwork_Override(g GlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewGlobalDatabaseNetworks_Override ¶
func NewGlobalDatabaseNetworks_Override(g GlobalDatabaseNetworks, scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworksProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewParameterGroup_Override ¶
func NewParameterGroup_Override(p ParameterGroup, scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewParameterGroups_Override ¶
func NewParameterGroups_Override(p ParameterGroups, scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupsProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosDBClusters_Override ¶
func NewRosDBClusters_Override(r RosDBClusters, scope alicloudroscdkcore.Construct, id *string, props *RosDBClustersProps, enableResourcePropertyConstraint *bool)
func NewRosDBNodeClasses_Override ¶
func NewRosDBNodeClasses_Override(r RosDBNodeClasses, scope alicloudroscdkcore.Construct, id *string, props *RosDBNodeClassesProps, enableResourcePropertyConstraint *bool)
func NewRosGlobalDatabaseNetwork_Override ¶
func NewRosGlobalDatabaseNetwork_Override(r RosGlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool)
func NewRosGlobalDatabaseNetworks_Override ¶
func NewRosGlobalDatabaseNetworks_Override(r RosGlobalDatabaseNetworks, scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworksProps, enableResourcePropertyConstraint *bool)
func NewRosParameterGroup_Override ¶
func NewRosParameterGroup_Override(r RosParameterGroup, scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupProps, enableResourcePropertyConstraint *bool)
func NewRosParameterGroups_Override ¶
func NewRosParameterGroups_Override(r RosParameterGroups, scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupsProps, enableResourcePropertyConstraint *bool)
func ParameterGroup_IsConstruct ¶
func ParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func ParameterGroups_IsConstruct ¶
func ParameterGroups_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
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
func RosDBNodeClasses_IsConstruct ¶
func RosDBNodeClasses_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosDBNodeClasses_IsRosElement ¶
func RosDBNodeClasses_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 RosDBNodeClasses_IsRosResource ¶
func RosDBNodeClasses_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosDBNodeClasses_ROS_RESOURCE_TYPE_NAME ¶
func RosDBNodeClasses_ROS_RESOURCE_TYPE_NAME() *string
func RosGlobalDatabaseNetwork_IsConstruct ¶
func RosGlobalDatabaseNetwork_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGlobalDatabaseNetwork_IsRosElement ¶
func RosGlobalDatabaseNetwork_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 RosGlobalDatabaseNetwork_IsRosResource ¶
func RosGlobalDatabaseNetwork_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGlobalDatabaseNetwork_ROS_RESOURCE_TYPE_NAME ¶
func RosGlobalDatabaseNetwork_ROS_RESOURCE_TYPE_NAME() *string
func RosGlobalDatabaseNetworks_IsConstruct ¶
func RosGlobalDatabaseNetworks_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGlobalDatabaseNetworks_IsRosElement ¶
func RosGlobalDatabaseNetworks_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 RosGlobalDatabaseNetworks_IsRosResource ¶
func RosGlobalDatabaseNetworks_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGlobalDatabaseNetworks_ROS_RESOURCE_TYPE_NAME ¶
func RosGlobalDatabaseNetworks_ROS_RESOURCE_TYPE_NAME() *string
func RosParameterGroup_IsConstruct ¶
func RosParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosParameterGroup_IsRosElement ¶
func RosParameterGroup_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 RosParameterGroup_IsRosResource ¶
func RosParameterGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosParameterGroup_ROS_RESOURCE_TYPE_NAME ¶
func RosParameterGroup_ROS_RESOURCE_TYPE_NAME() *string
func RosParameterGroups_IsConstruct ¶
func RosParameterGroups_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosParameterGroups_IsRosElement ¶
func RosParameterGroups_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 RosParameterGroups_IsRosResource ¶
func RosParameterGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosParameterGroups_ROS_RESOURCE_TYPE_NAME ¶
func RosParameterGroups_ROS_RESOURCE_TYPE_NAME() *string
Types ¶
type DBClusters ¶
type DBClusters interface { alicloudroscdkcore.Resource // Attribute DbClusterIds: The ID of the cluster. 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::POLARDB::DBClusters`, which is used to query the information about PolarDB 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: The ID of the cluster. DbClusterId interface{} `field:"optional" json:"dbClusterId" yaml:"dbClusterId"` // Property dbType: The database engine that the cluster runs. DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` // Property dbVersion: The version of the database engine that the cluster runs. // // The range of the MySQL version number is as follows: // *** 5.6 * * * // *** 5.7 * * * // *** 8.0 * * * // The value range of PostgreSQL version number is as follows: // *** 11 * * * // *** 14 * * * // The Oracle version number is 11. DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` // Property description: The description of the cluster. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property expired: Indicates whether the cluster has expired. // // Valid values: // true // false. Expired interface{} `field:"optional" json:"expired" yaml:"expired"` // 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"` // Property resourceGroupId: The ID of the resource group. ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"` }
Properties for defining a `DBClusters`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-dbclusters
type DBNodeClasses ¶
type DBNodeClasses interface { alicloudroscdkcore.Resource // Attribute DBNodeClasses: The list of db node classes. AttrDbNodeClasses() alicloudroscdkcore.IResolvable // Attribute DBNodeClassIds: The list of db node class ids. AttrDbNodeClassIds() 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() *DBNodeClassesProps SetProps(val *DBNodeClassesProps) 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::POLARDB::DBNodeClasses`, which is used to query available PolarDB cluster resources.
func NewDBNodeClasses ¶
func NewDBNodeClasses(scope alicloudroscdkcore.Construct, id *string, props *DBNodeClassesProps, enableResourcePropertyConstraint *bool) DBNodeClasses
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type DBNodeClassesProps ¶
type DBNodeClassesProps struct { // Property payType: The billing method. // // Valid values: // Postpaid: the pay-as-you-go billing method // Prepaid: the subscription billing method. PayType interface{} `field:"required" json:"payType" yaml:"payType"` // Property dbNodeClass: The node type. // // For more information, see Specifications of compute nodes. DbNodeClass interface{} `field:"optional" json:"dbNodeClass" yaml:"dbNodeClass"` // Property dbType: The database engine. // // Valid values: // MySQL // PostgreSQL // Oracle. DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` // Property dbVersion: The version number of the database engine Valid values for the MySQL database engine: 5.6 5.7 8 Valid value for the PostgreSQL database engine: 11 Valid value for the Oracle database engine: 11 Note If you specify the DBType parameter, you must specify this parameter. DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` // 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"` // Property zoneId: The ID of the zone where PolarDB resources that you want to query reside. // // Note You can call the DescribeRegions operation to query information about zones. ZoneId interface{} `field:"optional" json:"zoneId" yaml:"zoneId"` }
Properties for defining a `DBNodeClasses`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-dbnodeclasses
type GlobalDatabaseNetwork ¶
type GlobalDatabaseNetwork interface { alicloudroscdkcore.Resource // Attribute Connections: The information about the connection to the cluster. AttrConnections() alicloudroscdkcore.IResolvable // Attribute CreateTime: The time at which the GDN was created. AttrCreateTime() alicloudroscdkcore.IResolvable // Attribute DbClusters: The clusters that are included in the GDN. AttrDbClusters() alicloudroscdkcore.IResolvable // Attribute DbType: The type of the database engine. // // Only MySQL is supported. AttrDbType() alicloudroscdkcore.IResolvable // Attribute DbVersion: The version of the database engine. // // Only version 8.0 is supported. AttrDbVersion() alicloudroscdkcore.IResolvable // Attribute GdnDescription: The description of the GDN. // // The description must meet the following requirements: // It cannot start with http:// or https://. // It must start with a letter. // It can contain letters, digits, underscores (_), and hyphens (-). // It must be 2 to 126 characters in length. AttrGdnDescription() alicloudroscdkcore.IResolvable // Attribute GdnId: The ID of the GDN. AttrGdnId() 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() *GlobalDatabaseNetworkProps SetProps(val *GlobalDatabaseNetworkProps) 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::POLARDB::GlobalDatabaseNetwork`, which is used to query the details of a Global Database Network (GDN) within the current Alibaba Cloud account.
func NewGlobalDatabaseNetwork ¶
func NewGlobalDatabaseNetwork(scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool) GlobalDatabaseNetwork
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GlobalDatabaseNetworkProps ¶
type GlobalDatabaseNetworkProps struct { // Property gdnId: The ID of the GDN. GdnId interface{} `field:"required" json:"gdnId" yaml:"gdnId"` // 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 `GlobalDatabaseNetwork`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-globaldatabasenetwork
type GlobalDatabaseNetworks ¶
type GlobalDatabaseNetworks interface { alicloudroscdkcore.Resource // Attribute GdnIds: The list of gdn IDs. AttrGdnIds() alicloudroscdkcore.IResolvable // Attribute GlobalDatabaseNetworks: The list of global database networks. AttrGlobalDatabaseNetworks() 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() *GlobalDatabaseNetworksProps SetProps(val *GlobalDatabaseNetworksProps) 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::POLARDB::GlobalDatabaseNetworks`, which is used to query all global database networks (GDNs) within the current Alibaba Cloud account.
func NewGlobalDatabaseNetworks ¶
func NewGlobalDatabaseNetworks(scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworksProps, enableResourcePropertyConstraint *bool) GlobalDatabaseNetworks
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GlobalDatabaseNetworksProps ¶
type GlobalDatabaseNetworksProps struct { // Property dbClusterId: The ID of the cluster. DbClusterId interface{} `field:"optional" json:"dbClusterId" yaml:"dbClusterId"` // Property gdnId: The ID of the GDN. GdnId interface{} `field:"optional" json:"gdnId" yaml:"gdnId"` // 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 `GlobalDatabaseNetworks`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-globaldatabasenetworks
type ParameterGroup ¶
type ParameterGroup interface { alicloudroscdkcore.Resource // Attribute CreateTime: The time when the parameter template was created. // // The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. AttrCreateTime() alicloudroscdkcore.IResolvable // Attribute DbType: The type of the database engine. AttrDbType() alicloudroscdkcore.IResolvable // Attribute DbVersion: The version of the database engine. AttrDbVersion() alicloudroscdkcore.IResolvable // Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied. // // Valid values: // 0: A restart is not required. // 1: A restart is required. AttrForceRestart() alicloudroscdkcore.IResolvable // Attribute ParameterCounts: The number of parameters in the parameter template. AttrParameterCounts() alicloudroscdkcore.IResolvable // Attribute ParameterGroupDesc: The description of the parameter template. AttrParameterGroupDesc() alicloudroscdkcore.IResolvable // Attribute ParameterGroupId: The ID of the parameter template. AttrParameterGroupId() alicloudroscdkcore.IResolvable // Attribute ParameterGroupName: The name of the parameter template. AttrParameterGroupName() alicloudroscdkcore.IResolvable // Attribute ParameterGroupType: The type of the parameter template. // // Valid values: // 0: the default parameter template. // 1: a custom parameter template. // 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template. AttrParameterGroupType() alicloudroscdkcore.IResolvable // Attribute Parameters: Details about the parameter templates. AttrParameters() 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() *ParameterGroupProps SetProps(val *ParameterGroupProps) 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::POLARDB::ParameterGroup`, which is used to query the information about a parameter template in a region.
func NewParameterGroup ¶
func NewParameterGroup(scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupProps, enableResourcePropertyConstraint *bool) ParameterGroup
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ParameterGroupProps ¶
type ParameterGroupProps struct { // Property parameterGroupId: The ID of the parameter template. ParameterGroupId interface{} `field:"required" json:"parameterGroupId" yaml:"parameterGroupId"` // 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 `ParameterGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-parametergroup
type ParameterGroups ¶
type ParameterGroups interface { alicloudroscdkcore.Resource // Attribute ParameterGroupIds: The list of parameter group IDs. AttrParameterGroupIds() alicloudroscdkcore.IResolvable // Attribute ParameterGroups: The list of parameter groups. AttrParameterGroups() 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() *ParameterGroupsProps SetProps(val *ParameterGroupsProps) 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::POLARDB::ParameterGroups`, which is used to query parameter templates in a region.
func NewParameterGroups ¶
func NewParameterGroups(scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupsProps, enableResourcePropertyConstraint *bool) ParameterGroups
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ParameterGroupsProps ¶
type ParameterGroupsProps struct { // Property dbType: The type of the database engine. DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` // Property dbVersion: The version of the database engine. DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` // 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 `ParameterGroups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-parametergroups
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{}) DbType() interface{} SetDbType(val interface{}) DbVersion() interface{} SetDbVersion(val interface{}) Description() interface{} SetDescription(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) Expired() interface{} SetExpired(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 // 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{}) 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 // 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::POLARDB::DBClusters`, which is used to query the information about PolarDB 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"` DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` Description interface{} `field:"optional" json:"description" yaml:"description"` Expired interface{} `field:"optional" json:"expired" yaml:"expired"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"` }
Properties for defining a `RosDBClusters`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-dbclusters
type RosDBNodeClasses ¶
type RosDBNodeClasses interface { alicloudroscdkcore.RosResource AttrDbNodeClasses() alicloudroscdkcore.IResolvable AttrDbNodeClassIds() 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 DbNodeClass() interface{} SetDbNodeClass(val interface{}) DbType() interface{} SetDbType(val interface{}) DbVersion() interface{} SetDbVersion(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 PayType() interface{} SetPayType(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 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{} 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) // 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::POLARDB::DBNodeClasses`, which is used to query available PolarDB cluster resources.
func NewRosDBNodeClasses ¶
func NewRosDBNodeClasses(scope alicloudroscdkcore.Construct, id *string, props *RosDBNodeClassesProps, enableResourcePropertyConstraint *bool) RosDBNodeClasses
type RosDBNodeClassesProps ¶
type RosDBNodeClassesProps struct { PayType interface{} `field:"required" json:"payType" yaml:"payType"` DbNodeClass interface{} `field:"optional" json:"dbNodeClass" yaml:"dbNodeClass"` DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` ZoneId interface{} `field:"optional" json:"zoneId" yaml:"zoneId"` }
Properties for defining a `RosDBNodeClasses`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-dbnodeclasses
type RosGlobalDatabaseNetwork ¶
type RosGlobalDatabaseNetwork interface { alicloudroscdkcore.RosResource AttrConnections() alicloudroscdkcore.IResolvable AttrCreateTime() alicloudroscdkcore.IResolvable AttrDbClusters() alicloudroscdkcore.IResolvable AttrDbType() alicloudroscdkcore.IResolvable AttrDbVersion() alicloudroscdkcore.IResolvable AttrGdnDescription() alicloudroscdkcore.IResolvable AttrGdnId() 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 EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GdnId() interface{} SetGdnId(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 // 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::POLARDB::GlobalDatabaseNetwork`, which is used to query the details of a Global Database Network (GDN) within the current Alibaba Cloud account.
func NewRosGlobalDatabaseNetwork ¶
func NewRosGlobalDatabaseNetwork(scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool) RosGlobalDatabaseNetwork
type RosGlobalDatabaseNetworkProps ¶
type RosGlobalDatabaseNetworkProps struct { GdnId interface{} `field:"required" json:"gdnId" yaml:"gdnId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosGlobalDatabaseNetwork`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-globaldatabasenetwork
type RosGlobalDatabaseNetworks ¶
type RosGlobalDatabaseNetworks interface { alicloudroscdkcore.RosResource AttrGdnIds() alicloudroscdkcore.IResolvable AttrGlobalDatabaseNetworks() 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) GdnId() interface{} SetGdnId(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 // 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::POLARDB::GlobalDatabaseNetworks`, which is used to query all global database networks (GDNs) within the current Alibaba Cloud account.
func NewRosGlobalDatabaseNetworks ¶
func NewRosGlobalDatabaseNetworks(scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworksProps, enableResourcePropertyConstraint *bool) RosGlobalDatabaseNetworks
type RosGlobalDatabaseNetworksProps ¶
type RosGlobalDatabaseNetworksProps struct { DbClusterId interface{} `field:"optional" json:"dbClusterId" yaml:"dbClusterId"` GdnId interface{} `field:"optional" json:"gdnId" yaml:"gdnId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosGlobalDatabaseNetworks`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-globaldatabasenetworks
type RosParameterGroup ¶
type RosParameterGroup interface { alicloudroscdkcore.RosResource AttrCreateTime() alicloudroscdkcore.IResolvable AttrDbType() alicloudroscdkcore.IResolvable AttrDbVersion() alicloudroscdkcore.IResolvable AttrForceRestart() alicloudroscdkcore.IResolvable AttrParameterCounts() alicloudroscdkcore.IResolvable AttrParameterGroupDesc() alicloudroscdkcore.IResolvable AttrParameterGroupId() alicloudroscdkcore.IResolvable AttrParameterGroupName() alicloudroscdkcore.IResolvable AttrParameterGroupType() alicloudroscdkcore.IResolvable AttrParameters() 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 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 ParameterGroupId() interface{} SetParameterGroupId(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 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::POLARDB::ParameterGroup`, which is used to query the information about a parameter template in a region.
func NewRosParameterGroup ¶
func NewRosParameterGroup(scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupProps, enableResourcePropertyConstraint *bool) RosParameterGroup
type RosParameterGroupProps ¶
type RosParameterGroupProps struct { ParameterGroupId interface{} `field:"required" json:"parameterGroupId" yaml:"parameterGroupId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosParameterGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-parametergroup
type RosParameterGroups ¶
type RosParameterGroups interface { alicloudroscdkcore.RosResource AttrParameterGroupIds() alicloudroscdkcore.IResolvable AttrParameterGroups() 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 DbType() interface{} SetDbType(val interface{}) DbVersion() interface{} SetDbVersion(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::POLARDB::ParameterGroups`, which is used to query parameter templates in a region.
func NewRosParameterGroups ¶
func NewRosParameterGroups(scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupsProps, enableResourcePropertyConstraint *bool) RosParameterGroups
type RosParameterGroupsProps ¶
type RosParameterGroupsProps struct { DbType interface{} `field:"optional" json:"dbType" yaml:"dbType"` DbVersion interface{} `field:"optional" json:"dbVersion" yaml:"dbVersion"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosParameterGroups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-polardb-parametergroups
Source Files ¶
- DBClusters.go
- DBClustersProps.go
- DBClusters__checks.go
- DBNodeClasses.go
- DBNodeClassesProps.go
- DBNodeClasses__checks.go
- GlobalDatabaseNetwork.go
- GlobalDatabaseNetworkProps.go
- GlobalDatabaseNetwork__checks.go
- GlobalDatabaseNetworks.go
- GlobalDatabaseNetworksProps.go
- GlobalDatabaseNetworks__checks.go
- ParameterGroup.go
- ParameterGroupProps.go
- ParameterGroup__checks.go
- ParameterGroups.go
- ParameterGroupsProps.go
- ParameterGroups__checks.go
- RosDBClusters.go
- RosDBClustersProps.go
- RosDBClusters__checks.go
- RosDBNodeClasses.go
- RosDBNodeClassesProps.go
- RosDBNodeClasses__checks.go
- RosGlobalDatabaseNetwork.go
- RosGlobalDatabaseNetworkProps.go
- RosGlobalDatabaseNetwork__checks.go
- RosGlobalDatabaseNetworks.go
- RosGlobalDatabaseNetworksProps.go
- RosGlobalDatabaseNetworks__checks.go
- RosParameterGroup.go
- RosParameterGroupProps.go
- RosParameterGroup__checks.go
- RosParameterGroups.go
- RosParameterGroupsProps.go
- RosParameterGroups__checks.go
- main.go