Template
- Implements: @alicloud/ros-cdk-oos.datasource.ITemplate
This class encapsulates and extends the ROS resource type DATASOURCE::OOS::Template.
Initializers
import { datasource } from '@alicloud/ros-cdk-oos'
new datasource.Template(scope: Construct, id: string, props: TemplateProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | TemplateProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: TemplateProps
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 { datasource } from '@alicloud/ros-cdk-oos'
datasource.Template.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. |
attrContent | string | @alicloud/ros-cdk-core.IResolvable | Attribute Content: The content of the template. |
attrCreatedBy | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreatedBy: The creator of the template. |
attrCreatedDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreatedDate: Specifies to query the template that is created at or before the specified time.The value must be in the YYYY-MM-DDThh:mm::ssZ format. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description of the template. |
attrHash | string | @alicloud/ros-cdk-core.IResolvable | Attribute Hash: The SHA-256 value of the template content. |
attrHasTrigger | string | @alicloud/ros-cdk-core.IResolvable | Attribute HasTrigger: Specifies whether to query the template that is configured with a trigger. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrShareType | string | @alicloud/ros-cdk-core.IResolvable | Attribute ShareType: The share type of the template. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tag keys and values. |
attrTemplateFormat | string | @alicloud/ros-cdk-core.IResolvable | Attribute TemplateFormat: The format of the template. |
attrTemplateId | string | @alicloud/ros-cdk-core.IResolvable | Attribute TemplateId: The ID of the template. |
attrTemplateType | string | @alicloud/ros-cdk-core.IResolvable | Attribute TemplateType: The type of the template. |
attrUpdatedBy | string | @alicloud/ros-cdk-core.IResolvable | Attribute UpdatedBy: The user who last updated the template. |
attrUpdatedDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute UpdatedDate: The time when the template was last updated. |
props | TemplateProps | 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
attrContentRequired
public readonly attrContent: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Content: The content of the template.
attrCreatedByRequired
public readonly attrCreatedBy: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreatedBy: The creator of the template.
attrCreatedDateRequired
public readonly attrCreatedDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreatedDate: Specifies to query the template that is created at or before the specified time.The value must be in the YYYY-MM-DDThh:mm::ssZ format.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description of the template.
attrHashRequired
public readonly attrHash: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Hash: The SHA-256 value of the template content.
attrHasTriggerRequired
public readonly attrHasTrigger: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute HasTrigger: Specifies whether to query the template that is configured with a trigger.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrShareTypeRequired
public readonly attrShareType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ShareType: The share type of the template.
Valid values: Public Private
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tag keys and values.
The number of key-value pairs ranges from 1 to 20. Example: {"k1":"k2","k2":"v2"}
attrTemplateFormatRequired
public readonly attrTemplateFormat: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TemplateFormat: The format of the template.
Valid values: JSON YAML
attrTemplateIdRequired
public readonly attrTemplateId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TemplateId: The ID of the template.
attrTemplateTypeRequired
public readonly attrTemplateType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TemplateType: The type of the template.
Valid values: Automation: the template for automated tasks. State: the template for configuration inventories. Package: the template for software packages.
attrUpdatedByRequired
public readonly attrUpdatedBy: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UpdatedBy: The user who last updated the template.
attrUpdatedDateRequired
public readonly attrUpdatedDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UpdatedDate: The time when the template was last updated.
propsRequired
public readonly props: TemplateProps;
- Type: TemplateProps