CodeSource

• Implements: ICodeSource

This class encapsulates and extends the ROS resource type ALIYUN::PAI::CodeSource.

Initializers

import ros_cdk_pai
ros_cdk_pai.CodeSource(
  scope: Construct,
  id: str,
  accessibility: typing.Union[str, IResolvable],
  code_repo: typing.Union[str, IResolvable],
  display_name: typing.Union[str, IResolvable],
  mount_path: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  code_branch: typing.Union[str, IResolvable] = None,
  code_commit: typing.Union[str, IResolvable] = None,
  code_repo_access_token: typing.Union[str, IResolvable] = None,
  code_repo_user_name: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

accessibility^Required

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

Property accessibility: Visibility of the code configuration, possible values: - PRIVATE: In this workspace, it is only visible to you and the administrator.

• PUBLIC: In this workspace, it is visible to everyone.

code_repo^Required

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

Property codeRepo: Code repository address.

display_name^Required

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

Property displayName: Code source configuration name.

mount_path^Required

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

Property mountPath: The local Mount Directory of the code.

workspace_id^Required

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

Property workspaceId: The ID of the workspace.

code_branch^Optional

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

Property codeBranch: Code repository branch.

code_commit^Optional

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

Property codeCommit: The code CommitId.

code_repo_access_token^Optional

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

Property codeRepoAccessToken: The Token used to access the code repository.

code_repo_user_name^Optional

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

Property codeRepoUserName: The user name of the code repository.

description^Optional

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

Property description: A detailed description of the code configuration.

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_pai
ros_cdk_pai.CodeSource.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_accessibility^Required

attr_accessibility: typing.Union[str, IResolvable]

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

Attribute Accessibility: Visibility of the code configuration.

attr_code_branch^Required

attr_code_branch: typing.Union[str, IResolvable]

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

Attribute CodeBranch: Code repository branch.

attr_code_commit^Required

attr_code_commit: typing.Union[str, IResolvable]

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

Attribute CodeCommit: The code CommitId.

attr_code_repo^Required

attr_code_repo: typing.Union[str, IResolvable]

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

Attribute CodeRepo: Code repository address.

attr_code_repo_access_token^Required

attr_code_repo_access_token: typing.Union[str, IResolvable]

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

Attribute CodeRepoAccessToken: The Token used to access the code repository.

attr_code_repo_user_name^Required

attr_code_repo_user_name: typing.Union[str, IResolvable]

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

Attribute CodeRepoUserName: The user name of the code repository.

attr_code_sources_id^Required

attr_code_sources_id: typing.Union[str, IResolvable]

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

Attribute CodeSourcesId: The ID of the created code configuration.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation time of the code.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: A detailed description of the code configuration.

attr_display_name^Required

attr_display_name: typing.Union[str, IResolvable]

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

Attribute DisplayName: Code source configuration name.

attr_gmt_modify_time^Required

attr_gmt_modify_time: typing.Union[str, IResolvable]

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

Attribute GmtModifyTime: Code configuration modification time.

The time format is iso8601.

attr_mount_path^Required

attr_mount_path: typing.Union[str, IResolvable]

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

Attribute MountPath: The local Mount Directory of the code.

attr_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

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

Attribute UserId: The ID of the creator of the code configuration source.

attr_workspace_id^Required

attr_workspace_id: typing.Union[str, IResolvable]

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

Attribute WorkspaceId: The ID of the workspace.

props^Required

props: CodeSourceProps

• Type: CodeSourceProps