RepoSyncRule
- Implements: IRepoSyncRule
This class encapsulates and extends the ROS resource type ALIYUN::CR::RepoSyncRule.
Initializers
import ros_cdk_cr
ros_cdk_cr.RepoSyncRule(
scope: Construct,
id: str,
instance_id: typing.Union[str, IResolvable],
namespace_name: typing.Union[str, IResolvable],
sync_rule_name: typing.Union[str, IResolvable],
sync_scope: typing.Union[str, IResolvable],
sync_trigger: typing.Union[str, IResolvable],
target_instance_id: typing.Union[str, IResolvable],
target_namespace_name: typing.Union[str, IResolvable],
target_region_id: typing.Union[str, IResolvable],
repo_name: typing.Union[str, IResolvable] = None,
repo_name_filter: typing.Union[str, IResolvable] = None,
tag_filter: typing.Union[str, IResolvable] = None,
target_repo_name: typing.Union[str, IResolvable] = None,
target_user_id: 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. |
instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceId: The ID of the CR instance. |
namespace_name | typing.Union[str, ros_cdk_core.IResolvable] | Property namespaceName: The name of the CR namespace. |
sync_rule_name | typing.Union[str, ros_cdk_core.IResolvable] | Property syncRuleName: The name of the image sync rule. |
sync_scope | typing.Union[str, ros_cdk_core.IResolvable] | Property syncScope: The synchronization scope. |
sync_trigger | typing.Union[str, ros_cdk_core.IResolvable] | Property syncTrigger: The mode of triggering the synchronization rule. |
target_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property targetInstanceId: The ID of the destination instance. |
target_namespace_name | typing.Union[str, ros_cdk_core.IResolvable] | Property targetNamespaceName: The name of the destination namespace. |
target_region_id | typing.Union[str, ros_cdk_core.IResolvable] | Property targetRegionId: The ID of the destination region. |
repo_name | typing.Union[str, ros_cdk_core.IResolvable] | Property repoName: The name of the repository. |
repo_name_filter | typing.Union[str, ros_cdk_core.IResolvable] | Property repoNameFilter: The regular expression that is used to filter repositories. |
tag_filter | typing.Union[str, ros_cdk_core.IResolvable] | Property tagFilter: The tag filter. |
target_repo_name | typing.Union[str, ros_cdk_core.IResolvable] | Property targetRepoName: The name of the destination image repository. |
target_user_id | typing.Union[str, ros_cdk_core.IResolvable] | Property targetUserId: The user ID (UID) of the account to which the destination instance belongs. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceId: The ID of the CR instance.
namespace_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property namespaceName: The name of the CR namespace.
sync_rule_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property syncRuleName: The name of the image sync rule.
sync_scopeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property syncScope: The synchronization scope.
Valid values: REPO, NAMESPACE
sync_triggerRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property syncTrigger: The mode of triggering the synchronization rule.
Valid values: INITIATIVE, PASSIVE
target_instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property targetInstanceId: The ID of the destination instance.
target_namespace_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property targetNamespaceName: The name of the destination namespace.
target_region_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property targetRegionId: The ID of the destination region.
repo_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property repoName: The name of the repository.
This parameter is required when SyncScope is REPO.
repo_name_filterOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property repoNameFilter: The regular expression that is used to filter repositories.
tag_filterOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property tagFilter: The tag filter.
Default value: .*
target_repo_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property targetRepoName: The name of the destination image repository.
This parameter is optional.
target_user_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property targetUserId: The user ID (UID) of the account to which the destination instance belongs.
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_cr
ros_cdk_cr.RepoSyncRule.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_sync_rule_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SyncRuleId: The ID of the synchronization rule. |
props | RepoSyncRuleProps | 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_sync_rule_idRequired
attr_sync_rule_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SyncRuleId: The ID of the synchronization rule.
propsRequired
props: RepoSyncRuleProps
- Type: RepoSyncRuleProps