Documentation
¶
Overview ¶
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Index ¶
- func NewProject_Override(p Project, scope alicloudroscdkcore.Construct, id *string, props *ProjectProps, ...)
- func NewRosProject_Override(r RosProject, scope alicloudroscdkcore.Construct, id *string, ...)
- func Project_IsConstruct(x interface{}) *bool
- func RosProject_IsConstruct(x interface{}) *bool
- func RosProject_IsRosElement(x interface{}) *bool
- func RosProject_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosProject_ROS_RESOURCE_TYPE_NAME() *string
- type IProject
- type Project
- type ProjectProps
- type RosProject
- type RosProjectProps
- type RosProject_TagsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewProject_Override ¶
func NewProject_Override(p Project, scope alicloudroscdkcore.Construct, id *string, props *ProjectProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosProject_Override ¶
func NewRosProject_Override(r RosProject, scope alicloudroscdkcore.Construct, id *string, props *RosProjectProps, enableResourcePropertyConstraint *bool)
func Project_IsConstruct ¶
func Project_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosProject_IsConstruct ¶
func RosProject_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosProject_IsRosElement ¶
func 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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosProject_IsRosResource ¶
func RosProject_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosProject_ROS_RESOURCE_TYPE_NAME ¶
func RosProject_ROS_RESOURCE_TYPE_NAME() *string
Types ¶
type IProject ¶ added in v1.6.0
type IProject interface {
alicloudroscdkcore.IResource
// Attribute EnvTypes: The environment of the workspace.
//
// Valid values: PROD and DEV.
// The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment.
// The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.
AttrEnvTypes() interface{}
// Attribute IsDefault: Indicates whether the workspace is the default workspace.
//
// Valid values:
// 1: The workspace is the default workspace.
// 0: The workspace is not the default workspace.
AttrIsDefault() interface{}
// Attribute ProjectId: The ID of the workspace.
AttrProjectId() interface{}
// Attribute ProjectIdentifier: The name of the workspace.
//
// The name can contain letters, digits, and underscores (_) and must start with a letter or digit.
AttrProjectIdentifier() interface{}
// Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled.
//
// Valid values:
// 1: The workspace protection feature is enabled.
// 0: The workspace protection feature is disabled.
AttrProtectedMode() interface{}
// Attribute ResidentArea: The type of the workspace.
//
// Valid values: private and swap.
AttrResidentArea() interface{}
// Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.
AttrSchedulerMaxRetryTimes() interface{}
// Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs.
//
// Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.
AttrSchedulerRetryInterval() interface{}
// Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant.
//
// Valid values:
// 0: The MaxCompute tables are invisible to the users within a tenant.
// 1: The MaxCompute tables are visible to the users within a tenant.
AttrTablePrivacyMode() interface{}
Props() *ProjectProps
}
Represents a `Project`.
type Project ¶
type Project interface {
alicloudroscdkcore.Resource
IProject
// Attribute EnvTypes: The environment of the workspace.
//
// Valid values: PROD and DEV.
// The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment.
// The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.
AttrEnvTypes() interface{}
// Attribute IsDefault: Indicates whether the workspace is the default workspace.
//
// Valid values:
// 1: The workspace is the default workspace.
// 0: The workspace is not the default workspace.
AttrIsDefault() interface{}
// Attribute ProjectId: The ID of the workspace.
AttrProjectId() interface{}
// Attribute ProjectIdentifier: The name of the workspace.
//
// The name can contain letters, digits, and underscores (_) and must start with a letter or digit.
AttrProjectIdentifier() interface{}
// Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled.
//
// Valid values:
// 1: The workspace protection feature is enabled.
// 0: The workspace protection feature is disabled.
AttrProtectedMode() interface{}
// Attribute ResidentArea: The type of the workspace.
//
// Valid values: private and swap.
AttrResidentArea() interface{}
// Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.
AttrSchedulerMaxRetryTimes() interface{}
// Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs.
//
// Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.
AttrSchedulerRetryInterval() interface{}
// Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant.
//
// Valid values:
// 0: The MaxCompute tables are invisible to the users within a tenant.
// 1: The MaxCompute tables are visible to the users within a tenant.
AttrTablePrivacyMode() interface{}
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() alicloudroscdkcore.IResourceEnvironment
Id() *string
SetId(val *string)
// The construct tree node associated with this construct.
Node() alicloudroscdkcore.ConstructNode
// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by ROS
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
Props() *ProjectProps
Ref() *string
Resource() alicloudroscdkcore.RosResource
SetResource(val alicloudroscdkcore.RosResource)
Scope() alicloudroscdkcore.Construct
SetScope(val alicloudroscdkcore.Construct)
// The stack in which this resource is defined.
Stack() alicloudroscdkcore.Stack
AddCondition(condition alicloudroscdkcore.RosCondition)
AddCount(count interface{})
AddDependency(resource alicloudroscdkcore.Resource)
AddResourceDesc(desc *string)
ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDependency() *[]*string
FetchResourceDesc() *string
GeneratePhysicalName() *string
GetAtt(name *string) alicloudroscdkcore.IResolvable
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
SetMetadata(key *string, value interface{})
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
}
This class encapsulates and extends the ROS resource type `ALIYUN::DataWorks::Project`, which is used to create a DataWorks workspace.
func NewProject ¶
func NewProject(scope alicloudroscdkcore.Construct, id *string, props *ProjectProps, enableResourcePropertyConstraint *bool) Project
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ProjectProps ¶
type ProjectProps struct {
// Property projectIdentifier: The name of the workspace.
//
// The name can contain letters, digits, and underscores (_) and must start with a letter or digit.
ProjectIdentifier interface{} `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
// Property disableDevelopment: Specifies whether to disable the Development role.
//
// Valid values:
// false: enables the Development role.
// true: disables the Development role.
// Default value: false.
DisableDevelopment interface{} `field:"optional" json:"disableDevelopment" yaml:"disableDevelopment"`
// Property isAllowDownload: Specifies whether query result download from DataStudio is allowed.
//
// Valid values:
// true: allowed
// false: not allowed
// Default value: true.
IsAllowDownload interface{} `field:"optional" json:"isAllowDownload" yaml:"isAllowDownload"`
// Property projectDescription: The description of the workspace.
//
// If not provided, it is the same as ProjectIdentifier.
ProjectDescription interface{} `field:"optional" json:"projectDescription" yaml:"projectDescription"`
// Property projectMode: The mode of the workspace.
//
// For more information about the differences between the modes of workspaces, see Differences between workspaces in basic mode and workspaces in standard mode. Valid values:
// 2: basic mode
// 3: standard mode
// Default value: 2.
ProjectMode interface{} `field:"optional" json:"projectMode" yaml:"projectMode"`
// Property projectName: The display name of the workspace.
//
// If not provided, it is the same as ProjectIdentifier.
ProjectName interface{} `field:"optional" json:"projectName" yaml:"projectName"`
// Property resourceGroupId: The ID of the resource group.
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
// Property tags: Tags to attach to workspace.
//
// Max support 20 tags to add during create workspace. Each tag with two properties Key and Value, and Key is required.
Tags *[]*RosProject_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `Project`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dataworks-project
type RosProject ¶
type RosProject interface {
alicloudroscdkcore.RosResource
AttrEnvTypes() alicloudroscdkcore.IResolvable
AttrIsDefault() alicloudroscdkcore.IResolvable
AttrProjectId() alicloudroscdkcore.IResolvable
AttrProjectIdentifier() alicloudroscdkcore.IResolvable
AttrProtectedMode() alicloudroscdkcore.IResolvable
AttrResidentArea() alicloudroscdkcore.IResolvable
AttrSchedulerMaxRetryTimes() alicloudroscdkcore.IResolvable
AttrSchedulerRetryInterval() alicloudroscdkcore.IResolvable
AttrTablePrivacyMode() 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
DisableDevelopment() interface{}
SetDisableDevelopment(val interface{})
EnableResourcePropertyConstraint() *bool
SetEnableResourcePropertyConstraint(val *bool)
IsAllowDownload() interface{}
SetIsAllowDownload(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
ProjectDescription() interface{}
SetProjectDescription(val interface{})
ProjectIdentifier() interface{}
SetProjectIdentifier(val interface{})
ProjectMode() interface{}
SetProjectMode(val interface{})
ProjectName() interface{}
SetProjectName(val interface{})
// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
ResourceGroupId() interface{}
SetResourceGroupId(val interface{})
// Options for this resource, such as condition, update policy etc.
RosOptions() alicloudroscdkcore.IRosResourceOptions
RosProperties() *map[string]interface{}
// ROS resource type.
RosResourceType() *string
// The stack in which this element is defined.
//
// RosElements must be defined within a stack scope (directly or indirectly).
Stack() alicloudroscdkcore.Stack
Tags() *[]*RosProject_TagsProperty
SetTags(val *[]*RosProject_TagsProperty)
// 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)
FetchCondition() alicloudroscdkcore.RosCondition
FetchDesc() *string
FetchRosDependency() *[]*string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string) alicloudroscdkcore.Reference
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
Synthesize(session alicloudroscdkcore.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
Validate() *[]*string
ValidateProperties(_properties interface{})
}
This class is a base encapsulation around the ROS resource type `ALIYUN::DataWorks::Project`, which is used to create a DataWorks workspace.
func NewRosProject ¶
func NewRosProject(scope alicloudroscdkcore.Construct, id *string, props *RosProjectProps, enableResourcePropertyConstraint *bool) RosProject
type RosProjectProps ¶
type RosProjectProps struct {
ProjectIdentifier interface{} `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
DisableDevelopment interface{} `field:"optional" json:"disableDevelopment" yaml:"disableDevelopment"`
IsAllowDownload interface{} `field:"optional" json:"isAllowDownload" yaml:"isAllowDownload"`
ProjectDescription interface{} `field:"optional" json:"projectDescription" yaml:"projectDescription"`
ProjectMode interface{} `field:"optional" json:"projectMode" yaml:"projectMode"`
ProjectName interface{} `field:"optional" json:"projectName" yaml:"projectName"`
ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
Tags *[]*RosProject_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `RosProject`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dataworks-project
type RosProject_TagsProperty ¶
type RosProject_TagsProperty struct {
Key interface{} `field:"required" json:"key" yaml:"key"`
Value interface{} `field:"optional" json:"value" yaml:"value"`
}