CodeSource
- Implements: ICodeSource
This class encapsulates and extends the ROS resource type ALIYUN::PAI::CodeSource.
Initializers
import { CodeSource } from '@alicloud/ros-cdk-pai'
new CodeSource(scope: Construct, id: string, props: CodeSourceProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | CodeSourceProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: CodeSourceProps
enableResourcePropertyConstraintOptional
- Type: boolean
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { CodeSource } from '@alicloud/ros-cdk-pai'
CodeSource.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrAccessibility | string | @alicloud/ros-cdk-core.IResolvable | Attribute Accessibility: Visibility of the code configuration. |
attrCodeBranch | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeBranch: Code repository branch. |
attrCodeCommit | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeCommit: The code CommitId. |
attrCodeRepo | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeRepo: Code repository address. |
attrCodeRepoAccessToken | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeRepoAccessToken: The Token used to access the code repository. |
attrCodeRepoUserName | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeRepoUserName: The user name of the code repository. |
attrCodeSourcesId | string | @alicloud/ros-cdk-core.IResolvable | Attribute CodeSourcesId: The ID of the created code configuration. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the code. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: A detailed description of the code configuration. |
attrDisplayName | string | @alicloud/ros-cdk-core.IResolvable | Attribute DisplayName: Code source configuration name. |
attrGmtModifyTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute GmtModifyTime: Code configuration modification time. |
attrMountPath | string | @alicloud/ros-cdk-core.IResolvable | Attribute MountPath: The local Mount Directory of the code. |
attrUserId | string | @alicloud/ros-cdk-core.IResolvable | Attribute UserId: The ID of the creator of the code configuration source. |
attrWorkspaceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute WorkspaceId: The ID of the workspace. |
props | CodeSourceProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrAccessibilityRequired
public readonly attrAccessibility: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Accessibility: Visibility of the code configuration.
attrCodeBranchRequired
public readonly attrCodeBranch: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeBranch: Code repository branch.
attrCodeCommitRequired
public readonly attrCodeCommit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeCommit: The code CommitId.
attrCodeRepoRequired
public readonly attrCodeRepo: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeRepo: Code repository address.
attrCodeRepoAccessTokenRequired
public readonly attrCodeRepoAccessToken: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeRepoAccessToken: The Token used to access the code repository.
attrCodeRepoUserNameRequired
public readonly attrCodeRepoUserName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeRepoUserName: The user name of the code repository.
attrCodeSourcesIdRequired
public readonly attrCodeSourcesId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CodeSourcesId: The ID of the created code configuration.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the code.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: A detailed description of the code configuration.
attrDisplayNameRequired
public readonly attrDisplayName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DisplayName: Code source configuration name.
attrGmtModifyTimeRequired
public readonly attrGmtModifyTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute GmtModifyTime: Code configuration modification time.
The time format is iso8601.
attrMountPathRequired
public readonly attrMountPath: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MountPath: The local Mount Directory of the code.
attrUserIdRequired
public readonly attrUserId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UserId: The ID of the creator of the code configuration source.
attrWorkspaceIdRequired
public readonly attrWorkspaceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute WorkspaceId: The ID of the workspace.
propsRequired
public readonly props: CodeSourceProps;
- Type: CodeSourceProps