Group

• Implements: IGroup

This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::Group.

Initializers

import ros_cdk_paiplugin
ros_cdk_paiplugin.Group(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  source: typing.Union[typing.Union[int, float], IResolvable],
  algorithm: typing.Union[str, IResolvable] = None,
  column: typing.Union[str, IResolvable] = None,
  filter: typing.Union[str, IResolvable] = None,
  inference_job_id: typing.Union[str, IResolvable] = None,
  phone_number: typing.Union[str, IResolvable] = None,
  project: typing.Union[str, IResolvable] = None,
  remark: typing.Union[str, IResolvable] = None,
  table: typing.Union[str, IResolvable] = None,
  text: typing.Union[str, IResolvable] = None,
  uri: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the user group.

source^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property source: Crowd source.

Valid values: 0: Enter phone numbers. 1: Single-column CSV File (Phone Numbers). 2: Multi-column CSV File. 3: MaxCompute Table. 4: Algorithm.

algorithm^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property algorithm: Association algorithm.

This must be specified when Source is 4(Algorithm).

column^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property column: Mobile phone number column name.

The Source is 2(Multi-column CSV File) or 3(MaxCompute Table) needs to be specified when it contains mobile phone numbers.

filter^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property filter: Filter condition.

This condition can be specified when Source is 3(MaxCompute Table).

inference_job_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property inferenceJobId: Prediction task ID.This condition can be specified when Source is 4(Algorithm).

phone_number^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property phoneNumber: Whether to include mobile phone numbers.

People with mobile phone numbers can be used for reach plans.

project^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property project: MaxCompute (ODPS) project name.

This parameter must be specified when Source is 3(MaxCompute Table).

remark^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property remark: The notes of the user group.

table^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property table: MaxCompute (ODPS) table name.

This parameter must be specified when Source is 3(MaxCompute Table).

text^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property text: The text of the phone number.

This must be specified when Source is 0(Enter phone numbers).

uri^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property uri: File address.

It needs to be specified when Source is 1(Single-column CSV File) or 2(Multi-column CSV File).

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_paiplugin
ros_cdk_paiplugin.Group.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_amount^Required

attr_amount: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Amount: The number of the user group.

attr_created_time^Required

attr_created_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute CreatedTime: The creation time of the user group.

attr_id^Required

attr_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Id: The ID of the user group.

attr_name^Required

attr_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Name: The name of the user group.

props^Required

props: GroupProps

• Type: GroupProps