RosProject
This class is a base encapsulation around the ROS resource type ALIYUN::DataWorks::Project
, which is used to create a DataWorks workspace.
Initializers
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdataworks"
alicloudroscdkdataworks.NewRosProject(scope Construct, id *string, props RosProjectProps, enableResourcePropertyConstraint *bool) RosProject
Name | Type | Description |
---|---|---|
scope |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct |
- scope in which this resource is defined. |
id |
*string |
- scoped id of the resource. |
props |
RosProjectProps |
- resource properties. |
enableResourcePropertyConstraint |
*bool |
No description. |
scope
Required
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct
scope in which this resource is defined.
id
Required
- Type: *string
scoped id of the resource.
props
Required
- Type: RosProjectProps
resource properties.
enableResourcePropertyConstraint
Required
- Type: *bool
Methods
Name | Description |
---|---|
ToString |
Returns a string representation of this construct. |
Synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
OverrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
AddCondition |
No description. |
AddCount |
No description. |
AddDeletionOverride |
Syntactic sugar for addOverride(path, undefined) . |
AddDependsOn |
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
AddDesc |
No description. |
AddMetaData |
No description. |
AddOverride |
Adds an override to the synthesized ROS resource. |
AddPropertyDeletionOverride |
Adds an override that deletes the value of a property from the resource definition. |
AddPropertyOverride |
Adds an override to a resource property. |
AddRosDependency |
No description. |
ApplyRemovalPolicy |
Sets the deletion policy of the resource based on the removal policy specified. |
GetAtt |
Returns a token for an runtime attribute of this resource. |
ToString
func ToString() *string
Returns a string representation of this construct.
Synthesize
func Synthesize(session ISynthesisSession)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession
The synthesis session.
OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.
- Type: *string
The new logical ID to use for this stack element.
AddCondition
func AddCondition(con RosCondition)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition
AddCount
func AddCount(count interface{})
- Type: interface{}
AddDeletionOverride
func AddDeletionOverride(path *string)
Syntactic sugar for addOverride(path, undefined)
.
- Type: *string
The path of the value to delete.
AddDependsOn
func AddDependsOn(target RosResource)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource
AddDesc
func AddDesc(desc *string)
- Type: *string
AddMetaData
func AddMetaData(key *string, value interface{})
- Type: *string
- Type: interface{}
AddOverride
func AddOverride(path *string, value interface{})
Adds an override to the synthesized ROS resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
For example,
addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
- Type: *string
The path of the property, you can use dot notation to override values in complex types.
Any intermdediate keys will be created as needed.
- Type: interface{}
The value.
Could be primitive or complex.
AddPropertyDeletionOverride
func AddPropertyDeletionOverride(propertyPath *string)
Adds an override that deletes the value of a property from the resource definition.
- Type: *string
The path to the property.
AddPropertyOverride
func AddPropertyOverride(propertyPath *string, value interface{})
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
- Type: *string
The path of the property.
- Type: interface{}
The value.
AddRosDependency
func AddRosDependency(target *string)
- Type: *string
ApplyRemovalPolicy
func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)
Sets the deletion policy of the resource based on the removal policy specified.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions
GetAtt
func GetAtt(attributeName *string) Reference
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
- Type: *string
The name of the attribute.
Static Functions
Name | Description |
---|---|
IsConstruct |
Return whether the given object is a Construct. |
IsRosElement |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
IsRosResource |
Check whether the given construct is a RosResource. |
IsConstruct
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdataworks"
alicloudroscdkdataworks.RosProject_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
- Type: interface{}
IsRosElement
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdataworks"
alicloudroscdkdataworks.RosProject_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.
- Type: interface{}
IsRosResource
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdataworks"
alicloudroscdkdataworks.RosProject_IsRosResource(construct IConstruct) *bool
Check whether the given construct is a RosResource.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct
Properties
Name | Type | Description |
---|---|---|
Node |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode |
The construct tree node associated with this construct. |
CreationStack |
[]string |
No description. |
LogicalId |
*string |
The logical ID for this stack element. |
Stack |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack |
The stack in which this element is defined. |
Ref |
*string |
Return a string that will be resolved to a RosTemplate { Ref } for this element. |
RosOptions |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions |
Options for this resource, such as condition, update policy etc. |
RosResourceType |
*string |
ROS resource type. |
AttrEnvTypes |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrIsDefault |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrProjectId |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrProjectIdentifier |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrProtectedMode |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrResidentArea |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrSchedulerMaxRetryTimes |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrSchedulerRetryInterval |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
AttrTablePrivacyMode |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
No description. |
EnableResourcePropertyConstraint |
*bool |
No description. |
ProjectIdentifier |
interface{} |
No description. |
DisableDevelopment |
interface{} |
No description. |
IsAllowDownload |
interface{} |
No description. |
ProjectDescription |
interface{} |
No description. |
ProjectMode |
interface{} |
No description. |
ProjectName |
interface{} |
No description. |
ResourceGroupId |
interface{} |
No description. |
Tags |
*[]TagsProperty |
No description. |
Node
Required
func Node() ConstructNode
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode
The construct tree node associated with this construct.
CreationStack
Required
func CreationStack() *[]*string
- Type: []string
LogicalId
Required
func LogicalId() *string
- Type: *string
The logical ID for this stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
Stack
Required
func Stack() Stack
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
Ref
Required
func Ref() *string
- Type: *string
Return a string that will be resolved to a RosTemplate { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
RosOptions
Required
func RosOptions() IRosResourceOptions
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
RosResourceType
Required
func RosResourceType() *string
- Type: *string
ROS resource type.
AttrEnvTypes
Required
func AttrEnvTypes() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrIsDefault
Required
func AttrIsDefault() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrProjectId
Required
func AttrProjectId() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrProjectIdentifier
Required
func AttrProjectIdentifier() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrProtectedMode
Required
func AttrProtectedMode() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrResidentArea
Required
func AttrResidentArea() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrSchedulerMaxRetryTimes
Required
func AttrSchedulerMaxRetryTimes() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrSchedulerRetryInterval
Required
func AttrSchedulerRetryInterval() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
AttrTablePrivacyMode
Required
func AttrTablePrivacyMode() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
EnableResourcePropertyConstraint
Required
func EnableResourcePropertyConstraint() *bool
- Type: *bool
ProjectIdentifier
Required
func ProjectIdentifier() interface{}
- Type: interface{}
DisableDevelopment
Optional
func DisableDevelopment() interface{}
- Type: interface{}
IsAllowDownload
Optional
func IsAllowDownload() interface{}
- Type: interface{}
ProjectDescription
Optional
func ProjectDescription() interface{}
- Type: interface{}
ProjectMode
Optional
func ProjectMode() interface{}
- Type: interface{}
ProjectName
Optional
func ProjectName() interface{}
- Type: interface{}
ResourceGroupId
Optional
func ResourceGroupId() interface{}
- Type: interface{}
Tags
Optional
func Tags() *[]TagsProperty
- Type: *[]TagsProperty
Constants
Name | Type | Description |
---|---|---|
RosResourceTypeName |
*string |
The resource type name for this resource class. |
RosResourceTypeName
Required
func RosResourceTypeName() *string
- Type: *string
The resource type name for this resource class.