Project2
- Implements: IProject2
This class encapsulates and extends the ROS resource type ALIYUN::IMM::Project2.
Initializers
import ros_cdk_imm
ros_cdk_imm.Project2(
scope: Construct,
id: str,
project_name: typing.Union[str, IResolvable],
dataset_max_bind_count: typing.Union[typing.Union[int, float], IResolvable] = None,
dataset_max_entity_count: typing.Union[typing.Union[int, float], IResolvable] = None,
dataset_max_file_count: typing.Union[typing.Union[int, float], IResolvable] = None,
dataset_max_relation_count: typing.Union[typing.Union[int, float], IResolvable] = None,
dataset_max_total_file_size: typing.Union[typing.Union[int, float], IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
project_max_dataset_count: typing.Union[typing.Union[int, float], IResolvable] = None,
service_role: typing.Union[str, IResolvable] = None,
template_id: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
project_name | typing.Union[str, ros_cdk_core.IResolvable] | Property projectName: The project name. |
dataset_max_bind_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property datasetMaxBindCount: The maximum number of bindings for each dataset. |
dataset_max_entity_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property datasetMaxEntityCount: The maximum number of metadata entities in each dataset. |
dataset_max_file_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property datasetMaxFileCount: The maximum number of files in each dataset. |
dataset_max_relation_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property datasetMaxRelationCount: The maximum number of metadata relations in each dataset. |
dataset_max_total_file_size | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property datasetMaxTotalFileSize: The maximum size of files in each dataset. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of project. |
project_max_dataset_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property projectMaxDatasetCount: The maximum number of datasets in the project. |
service_role | typing.Union[str, ros_cdk_core.IResolvable] | Property serviceRole: The name of the Resource Access Management (RAM) role. |
template_id | typing.Union[str, ros_cdk_core.IResolvable] | Property templateId: The ID of the workflow template. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
project_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectName: The project name.
The naming convention is as follows:
- The name must be 1 to 128 characters in length.
- It can contain only letters, digits, hyphens (-), and underscores (_).
- It must start with a letter or an underscore (_).
dataset_max_bind_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property datasetMaxBindCount: The maximum number of bindings for each dataset.
Valid values: 1 to 10. Default value: 10.
dataset_max_entity_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property datasetMaxEntityCount: The maximum number of metadata entities in each dataset.
The default value is 10,000,000,000.
This configuration is reserved and is not currently enforced.
dataset_max_file_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property datasetMaxFileCount: The maximum number of files in each dataset.
Valid values: 1 to 100000000. Default value: 100000000.
dataset_max_relation_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property datasetMaxRelationCount: The maximum number of metadata relations in each dataset.
The default value is 100,000,000,000.
This configuration is reserved and is not currently enforced.
dataset_max_total_file_sizeOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property datasetMaxTotalFileSize: The maximum size of files in each dataset.
If the maximum size is exceeded, no indexes can be added. Unit: bytes. Default value: 90000000000000000.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of project.
project_max_dataset_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property projectMaxDatasetCount: The maximum number of datasets in the project.
Valid values: 1 to 1000000000. Default value: 1000000000.
service_roleOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceRole: The name of the Resource Access Management (RAM) role.
You must attach the RAM role to IMM to allow IMM to access other cloud resources, such as Object Storage Service (OSS). Default value: AliyunIMMDefaultRole.
template_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property templateId: The ID of the workflow template.
You can leave this parameter empty.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
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: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_imm
ros_cdk_imm.Project2.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_project_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProjectName: The name of project. |
props | Project2Props | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: ros_cdk_core.IResourceEnvironment
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.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_project_nameRequired
attr_project_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProjectName: The name of project.
propsRequired
props: Project2Props
- Type: Project2Props