ScanRule

• Implements: IScanRule

This class encapsulates and extends the ROS resource type ALIYUN::CR::ScanRule.

Initializers

import ros_cdk_cr
ros_cdk_cr.ScanRule(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  repo_tag_filter_pattern: typing.Union[str, IResolvable],
  rule_name: typing.Union[str, IResolvable],
  scan_scope: typing.Union[str, IResolvable],
  scan_type: typing.Union[str, IResolvable],
  trigger_type: typing.Union[str, IResolvable],
  namespaces: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  repo_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_id^Required

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

Property instanceId: ACR Instance ID.

repo_tag_filter_pattern^Required

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

Property repoTagFilterPattern: The tag that triggers the scan matches the regular expression.

rule_name^Required

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

Property ruleName: The scan rule name.

scan_scope^Required

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

Property scanScope: The scan scope.

Valid values: NAMESPACE: namespace. REPO: repository. INSTANCE: CR instance.

scan_type^Required

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

Property scanType: The scan type.

Valid values:

• VUL: Products Cloud Security Scanner.
• SBOM: Product Content Analysis.

trigger_type^Required

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

Property triggerType: Trigger type.

Valid values:

• AUTO: automatically trigger.
• MANUAL: manually trigger.

namespaces^Optional

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

Property namespaces: The list of namespaces.

• When the scan scope is NAMESPACE, this parameter cannot be empty.
• If the scan scope is REPO, you must specify a unique Namespace for this parameter.

repo_names^Optional

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

Property repoNames: The list of repositories.* When the scan scope is NAMESPACE, this parameter must be empty. * When the scan scope is REPO, this parameter cannot be empty.

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_cr
ros_cdk_cr.ScanRule.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_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: Creation time of the scan rule.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: ACR Instance ID.

attr_namespaces^Required

attr_namespaces: typing.Union[str, IResolvable]

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

Attribute Namespaces: The list of namespaces.

attr_repo_names^Required

attr_repo_names: typing.Union[str, IResolvable]

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

Attribute RepoNames: The list of repositories.

attr_repo_tag_filter_pattern^Required

attr_repo_tag_filter_pattern: typing.Union[str, IResolvable]

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

Attribute RepoTagFilterPattern: The tag that triggers the scan matches the regular expression.

attr_rule_name^Required

attr_rule_name: typing.Union[str, IResolvable]

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

Attribute RuleName: The scan rule name.

attr_scan_rule_id^Required

attr_scan_rule_id: typing.Union[str, IResolvable]

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

Attribute ScanRuleId: The ID of the scan rule.

attr_scan_scope^Required

attr_scan_scope: typing.Union[str, IResolvable]

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

Attribute ScanScope: The scan scope.

attr_scan_type^Required

attr_scan_type: typing.Union[str, IResolvable]

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

Attribute ScanType: The scan type.

attr_trigger_type^Required

attr_trigger_type: typing.Union[str, IResolvable]

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

Attribute TriggerType: Trigger type.

attr_update_time^Required

attr_update_time: typing.Union[str, IResolvable]

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

Attribute UpdateTime: Change time of the scan rule.

props^Required

props: ScanRuleProps

• Type: ScanRuleProps