ProductVersion
- Implements: IProductVersion
This class encapsulates and extends the ROS resource type ALIYUN::ServiceCatalog::ProductVersion.
Initializers
import ros_cdk_servicecatalog
ros_cdk_servicecatalog.ProductVersion(
scope: Construct,
id: str,
product_id: typing.Union[str, IResolvable],
product_version_name: typing.Union[str, IResolvable],
template_type: typing.Union[str, IResolvable],
template_url: typing.Union[str, IResolvable],
active: typing.Union[bool, IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
guidance: 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. |
product_id | typing.Union[str, ros_cdk_core.IResolvable] | Property productId: The ID of the product to which the product version belongs. |
product_version_name | typing.Union[str, ros_cdk_core.IResolvable] | Property productVersionName: The name of the product version. |
template_type | typing.Union[str, ros_cdk_core.IResolvable] | Property templateType: The type of the product template. |
template_url | typing.Union[str, ros_cdk_core.IResolvable] | Property templateUrl: The URL of the template. |
active | typing.Union[bool, ros_cdk_core.IResolvable] | Property active: Specifies whether the product version is active. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the product version. |
guidance | typing.Union[str, ros_cdk_core.IResolvable] | Property guidance: The recommendation information. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
product_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property productId: The ID of the product to which the product version belongs.
product_version_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property productVersionName: The name of the product version.
template_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property templateType: The type of the product template.
Valid values:
- RosTerraformTemplate: the Terraform template that is supported by Resource Orchestration Service (ROS).
- RosStandardTemplate: the standard ROS template.
template_urlRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property templateUrl: The URL of the template.
activeOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property active: Specifies whether the product version is active.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the product version.
The value must be 1 to 128 characters in length.
guidanceOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property guidance: The recommendation information.
Valid values:
- Default: No recommendation information is provided. This is the default value.
- Recommended: the recommendation version.
- Latest: the latest version.
- Deprecated: the version that is about to be discontinued.
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_servicecatalog
ros_cdk_servicecatalog.ProductVersion.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_active | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Active: Specifies whether the product version is active. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The creation time of the product version. |
attr_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Description: The description of the product version. |
attr_guidance | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Guidance: The recommendation information. |
attr_product_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProductId: The ID of the product to which the product version belongs. |
attr_product_version_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProductVersionId: The ID of the product version. |
attr_product_version_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProductVersionName: The name of the product version. |
attr_template_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TemplateType: The type of the product template. |
attr_template_url | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TemplateUrl: The URL of the template. |
props | ProductVersionProps | 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_activeRequired
attr_active: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Active: Specifies whether the product version is active.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The creation time of the product version.
attr_descriptionRequired
attr_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Description: The description of the product version.
attr_guidanceRequired
attr_guidance: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Guidance: The recommendation information.
attr_product_idRequired
attr_product_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProductId: The ID of the product to which the product version belongs.
attr_product_version_idRequired
attr_product_version_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProductVersionId: The ID of the product version.
attr_product_version_nameRequired
attr_product_version_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProductVersionName: The name of the product version.
attr_template_typeRequired
attr_template_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TemplateType: The type of the product template.
attr_template_urlRequired
attr_template_url: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TemplateUrl: The URL of the template.
propsRequired
props: ProductVersionProps
- Type: ProductVersionProps