Instance
- Implements: IInstance
This class encapsulates and extends the ROS resource type ALIYUN::CR::Instance, which is used to create a Container Registry Enterprise Edition instance.
Initializers
import ros_cdk_cr
ros_cdk_cr.Instance(
scope: Construct,
id: str,
instance_name: typing.Union[str, IResolvable],
instance_type: typing.Union[str, IResolvable],
image_scanner: typing.Union[str, IResolvable] = None,
instance_storage_name: typing.Union[str, IResolvable] = None,
period: typing.Union[typing.Union[int, float], IResolvable] = None,
renewal_status: typing.Union[str, IResolvable] = None,
renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
resource_group_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_name | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceName: Instance name.The value contains 3 to 30 lowercase letters, digits, and delimiters "-"(it can not be first or last). |
instance_type | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceType: The Value configuration of the Group 1 attribute of Container Mirror Service Enterprise Edition. |
image_scanner | typing.Union[str, ros_cdk_core.IResolvable] | Property imageScanner: Security scan engine. |
instance_storage_name | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceStorageName: Custom OSS Bucket name. |
period | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property period: Prepaid cycle. |
renewal_status | typing.Union[str, ros_cdk_core.IResolvable] | Property renewalStatus: Automatic renewal status, value: - AutoRenewal: automatic renewal. |
renew_period | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property renewPeriod: Automatic renewal cycle, in months. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
instance_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceName: Instance name.The value contains 3 to 30 lowercase letters, digits, and delimiters "-"(it can not be first or last).
instance_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceType: The Value configuration of the Group 1 attribute of Container Mirror Service Enterprise Edition.
Valid values: Basic: Basic instance Standard: Standard instance Advanced: Advanced Edition Instance.
image_scannerOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property imageScanner: Security scan engine.
instance_storage_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceStorageName: Custom OSS Bucket name.
periodOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property period: Prepaid cycle.
The unit is Monthly, please enter an integer multiple of 12 for annual paid products.
renewal_statusOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property renewalStatus: Automatic renewal status, value: - AutoRenewal: automatic renewal.
- ManualRenewal: manual renewal. Default ManualRenewal.
renew_periodOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property renewPeriod: Automatic renewal cycle, in months.
When RenewalStatus is set to AutoRenewal, it must be set.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group.
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.Instance.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_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The creation time of the resource. |
attr_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceId: The first ID of the resource. |
attr_instance_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceName: InstanceName. |
attr_instance_specification | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceSpecification: The instance specification. |
attr_modified_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ModifiedTime: Last modification time. |
attr_resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceGroupId: The ID of the resource group. |
props | InstanceProps | 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_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The creation time of the resource.
attr_instance_idRequired
attr_instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceId: The first ID of the resource.
attr_instance_nameRequired
attr_instance_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceName: InstanceName.
attr_instance_specificationRequired
attr_instance_specification: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceSpecification: The instance specification.
attr_modified_timeRequired
attr_modified_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ModifiedTime: Last modification time.
attr_resource_group_idRequired
attr_resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceGroupId: The ID of the resource group.
propsRequired
props: InstanceProps
- Type: InstanceProps