CustomCheckItem
- Implements: ICustomCheckItem
This class encapsulates and extends the ROS resource type ALIYUN::ThreatDetection::CustomCheckItem.
Initializers
import ros_cdk_threatdetection
ros_cdk_threatdetection.CustomCheckItem(
scope: Construct,
id: str,
check_rule: typing.Union[IResolvable, typing.Mapping[typing.Any]],
check_show_name: typing.Union[str, IResolvable],
instance_sub_type: typing.Union[str, IResolvable],
instance_type: typing.Union[str, IResolvable],
risk_level: typing.Union[str, IResolvable],
section_ids: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]],
status: typing.Union[str, IResolvable],
vendor: typing.Union[str, IResolvable],
assist_info: typing.Union[IResolvable, AssistInfoProperty] = None,
description: typing.Union[IResolvable, DescriptionProperty] = None,
remark: typing.Union[str, IResolvable] = None,
solution: typing.Union[IResolvable, SolutionProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
check_rule | typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] | Property checkRule: Check Item Check Rules. |
check_show_name | typing.Union[str, ros_cdk_core.IResolvable] | Property checkShowName: Check item display name. |
instance_sub_type | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceSubType: Asset subtype to which the check item belongs. |
instance_type | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceType: Asset type to which the check item belongs. |
risk_level | typing.Union[str, ros_cdk_core.IResolvable] | Property riskLevel: Risk level of inspection items. |
section_ids | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]] | Property sectionIds: CHECK SECTION OF INSPECTIONS. |
status | typing.Union[str, ros_cdk_core.IResolvable] | Property status: Check item status. |
vendor | typing.Union[str, ros_cdk_core.IResolvable] | Property vendor: Vendor to which the item belongs. |
assist_info | typing.Union[ros_cdk_core.IResolvable, AssistInfoProperty] | Property assistInfo: Check Item Description Help Information. |
description | typing.Union[ros_cdk_core.IResolvable, DescriptionProperty] | Property description: Check item description information. |
remark | typing.Union[str, ros_cdk_core.IResolvable] | Property remark: Remarks. |
solution | typing.Union[ros_cdk_core.IResolvable, SolutionProperty] | Property solution: Check Item Solution. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
check_ruleRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property checkRule: Check Item Check Rules.
check_show_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property checkShowName: Check item display name.
instance_sub_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceSubType: Asset subtype to which the check item belongs.
instance_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceType: Asset type to which the check item belongs.
risk_levelRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property riskLevel: Risk level of inspection items.
section_idsRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]]
Property sectionIds: CHECK SECTION OF INSPECTIONS.
statusRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property status: Check item status.
Values: EDIT: Editing in progress RELEASE: Published
vendorRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vendor: Vendor to which the item belongs.
assist_infoOptional
- Type: typing.Union[ros_cdk_core.IResolvable, AssistInfoProperty]
Property assistInfo: Check Item Description Help Information.
descriptionOptional
- Type: typing.Union[ros_cdk_core.IResolvable, DescriptionProperty]
Property description: Check item description information.
remarkOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property remark: Remarks.
solutionOptional
- Type: typing.Union[ros_cdk_core.IResolvable, SolutionProperty]
Property solution: Check Item Solution.
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_threatdetection
ros_cdk_threatdetection.CustomCheckItem.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_assist_info | typing.Union[str, ros_cdk_core.IResolvable] | Attribute AssistInfo: Check Item Description Help Information. |
attr_check_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CheckId: The first ID of the resource. |
attr_check_rule | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CheckRule: Check Item Check Rules. |
attr_check_show_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CheckShowName: Check item display name. |
attr_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Description: Check item description information. |
attr_instance_sub_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceSubType: Asset subtype to which the check item belongs. |
attr_instance_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceType: Asset type to which the check item belongs. |
attr_remark | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Remark: Remarks. |
attr_risk_level | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RiskLevel: Risk level of inspection items. |
attr_section_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SectionIds: CHECK SECTION OF INSPECTIONS. |
attr_solution | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Solution: Check Item Solution. |
attr_vendor | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Vendor: Vendor to which the item belongs. |
props | CustomCheckItemProps | 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_assist_infoRequired
attr_assist_info: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute AssistInfo: Check Item Description Help Information.
attr_check_idRequired
attr_check_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CheckId: The first ID of the resource.
attr_check_ruleRequired
attr_check_rule: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CheckRule: Check Item Check Rules.
attr_check_show_nameRequired
attr_check_show_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CheckShowName: Check item display name.
attr_descriptionRequired
attr_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Description: Check item description information.
attr_instance_sub_typeRequired
attr_instance_sub_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceSubType: Asset subtype to which the check item belongs.
attr_instance_typeRequired
attr_instance_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceType: Asset type to which the check item belongs.
attr_remarkRequired
attr_remark: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Remark: Remarks.
attr_risk_levelRequired
attr_risk_level: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RiskLevel: Risk level of inspection items.
attr_section_idsRequired
attr_section_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SectionIds: CHECK SECTION OF INSPECTIONS.
attr_solutionRequired
attr_solution: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Solution: Check Item Solution.
attr_vendorRequired
attr_vendor: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Vendor: Vendor to which the item belongs.
propsRequired
props: CustomCheckItemProps
- Type: CustomCheckItemProps