MachineGroup
- Implements: IMachineGroup
This class encapsulates and extends the ROS resource type ALIYUN::SLS::MachineGroup, which is used to create a machine group.
Log Service manages all the ECS instances whose logs need to be collected using the Logtail client in the form of machine groups.
Initializers
import ros_cdk_sls
ros_cdk_sls.MachineGroup(
scope: Construct,
id: str,
group_attribute: typing.Union[str, IResolvable] = None,
group_name: typing.Union[str, IResolvable] = None,
group_type: typing.Union[str, IResolvable] = None,
machine_identify_type: typing.Union[str, IResolvable] = None,
machine_list: typing.Union[typing.List[typing.Any], IResolvable] = None,
project_name: 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. |
group_attribute | typing.Union[str, ros_cdk_core.IResolvable] | Property groupAttribute: Group attribute, default is null. |
group_name | typing.Union[str, ros_cdk_core.IResolvable] | Property groupName: Display name of the group name, the Project only. |
group_type | typing.Union[str, ros_cdk_core.IResolvable] | Property groupType: MachineGroup type, the value is empty or Armory. |
machine_identify_type | typing.Union[str, ros_cdk_core.IResolvable] | Property machineIdentifyType: Machine indentify type, the value is 'ip' or 'userdefined'. |
machine_list | typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] | Property machineList: The machine tag, the value is ip or userdefined-id. |
project_name | typing.Union[str, ros_cdk_core.IResolvable] | Property projectName: MachineGroup created in project. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
group_attributeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property groupAttribute: Group attribute, default is null.
The object value is groupTopic and externalName
group_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property groupName: Display name of the group name, the Project only.
[2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'
group_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property groupType: MachineGroup type, the value is empty or Armory.
machine_identify_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property machineIdentifyType: Machine indentify type, the value is 'ip' or 'userdefined'.
machine_listOptional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property machineList: The machine tag, the value is ip or userdefined-id.
project_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectName: MachineGroup created in project.
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_sls
ros_cdk_sls.MachineGroup.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_group_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute GroupName: GroupName of SLS. |
attr_project_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProjectName: ProjectName of SLS. |
props | MachineGroupProps | 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_group_nameRequired
attr_group_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute GroupName: GroupName of SLS.
attr_project_nameRequired
attr_project_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProjectName: ProjectName of SLS.
propsRequired
props: MachineGroupProps
- Type: MachineGroupProps