Table
This class encapsulates and extends the ROS resource type ALIYUN::MaxCompute::Table, which is used to create a table.
Initializers
import ros_cdk_maxcompute
ros_cdk_maxcompute.Table(
scope: Construct,
id: str,
name: typing.Union[str, IResolvable],
project: typing.Union[str, IResolvable],
comment: typing.Union[str, IResolvable] = None,
if_not_exists: typing.Union[bool, IResolvable] = None,
lifecycle: typing.Union[typing.Union[int, float], IResolvable] = None,
schema: typing.Union[IResolvable, SchemaProperty] = None,
string_schema: 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. |
name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property name: Table name. |
project |
typing.Union[str, ros_cdk_core.IResolvable] |
Property project: Project name, if not provided, will be the default project. |
comment |
typing.Union[str, ros_cdk_core.IResolvable] |
Property comment: Table comment. |
if_not_exists |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property ifNotExists: If you create a table by using the name of an existing table and the parameter set to false, an error is returned. |
lifecycle |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property lifecycle: Table's lifecycle. |
schema |
typing.Union[ros_cdk_core.IResolvable, SchemaProperty] |
Property schema: Table schema. |
string_schema |
typing.Union[str, ros_cdk_core.IResolvable] |
Property stringSchema: Create a table with field names and field type strings. |
enable_resource_property_constraint |
bool |
No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: Table name.
projectRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property project: Project name, if not provided, will be the default project.
commentOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property comment: Table comment.
if_not_existsOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property ifNotExists: If you create a table by using the name of an existing table and the parameter set to false, an error is returned.
If you specify the if not exists parameter, a success message is returned when you create a table by using the name of an existing table. The success message is returned even if the schema of the existing table is different from that of the table you want to create. If you create a table by using the name of an existing table, the table is not created and the metadata of the existing table is not changed.
lifecycleOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property lifecycle: Table's lifecycle.
schemaOptional
- Type: typing.Union[ros_cdk_core.IResolvable, SchemaProperty]
Property schema: Table schema.
string_schemaOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property stringSchema: Create a table with field names and field type strings.
Example: 'num bigint, num2 double', 'pt string'
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. |
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
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_maxcompute
ros_cdk_maxcompute.Table.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. |
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_name |
ros_cdk_core.IResolvable |
Attribute Name: Table name. |
attr_project |
ros_cdk_core.IResolvable |
Attribute Project: Project name. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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_nameRequired
attr_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Name: Table name.
attr_projectRequired
attr_project: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Project: Project name.