RosScalingConfiguration
This class is a base encapsulation around the ROS resource type ALIYUN::ESS::ScalingConfiguration
, which is used to create a scaling configuration for a scaling group.
Initializers
import ros_cdk_ess
ros_cdk_ess.RosScalingConfiguration(
scope: Construct,
id: str,
scaling_group_id: typing.Union[str, IResolvable],
affinity: typing.Union[str, IResolvable] = None,
cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
credit_specification: typing.Union[str, IResolvable] = None,
dedicated_host_id: typing.Union[str, IResolvable] = None,
deployment_set_id: typing.Union[str, IResolvable] = None,
disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]] = None,
host_name: typing.Union[str, IResolvable] = None,
hpc_cluster_id: typing.Union[str, IResolvable] = None,
image_family: typing.Union[str, IResolvable] = None,
image_id: typing.Union[str, IResolvable] = None,
image_name: typing.Union[str, IResolvable] = None,
image_options_login_as_non_root: typing.Union[bool, IResolvable] = None,
instance_description: typing.Union[str, IResolvable] = None,
instance_id: typing.Union[str, IResolvable] = None,
instance_name: typing.Union[str, IResolvable] = None,
instance_pattern_infos: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstancePatternInfosProperty]]] = None,
instance_type: typing.Union[str, IResolvable] = None,
instance_type_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceTypeOverridesProperty]]] = None,
instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
internet_charge_type: typing.Union[str, IResolvable] = None,
internet_max_bandwidth_in: typing.Union[typing.Union[int, float], IResolvable] = None,
internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
io_optimized: typing.Union[str, IResolvable] = None,
ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
key_pair_name: typing.Union[str, IResolvable] = None,
load_balancer_weight: typing.Union[typing.Union[int, float], IResolvable] = None,
memory: typing.Union[typing.Union[int, float], IResolvable] = None,
password: typing.Union[str, IResolvable] = None,
password_inherit: typing.Union[bool, IResolvable] = None,
private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty] = None,
ram_role_name: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
scaling_configuration_name: typing.Union[str, IResolvable] = None,
security_enhancement_strategy: typing.Union[str, IResolvable] = None,
security_group_id: typing.Union[str, IResolvable] = None,
security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
spot_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
spot_interruption_behavior: typing.Union[str, IResolvable] = None,
spot_price_limit: typing.Union[typing.Union[int, float], IResolvable] = None,
spot_price_limit_for_instance_type: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
spot_strategy: typing.Union[str, IResolvable] = None,
system_disk_auto_snapshot_policy_id: typing.Union[str, IResolvable] = None,
system_disk_bursting_enabled: typing.Union[bool, IResolvable] = None,
system_disk_categories: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
system_disk_category: typing.Union[str, IResolvable] = None,
system_disk_description: typing.Union[str, IResolvable] = None,
system_disk_disk_name: typing.Union[str, IResolvable] = None,
system_disk_encrypt_algorithm: typing.Union[str, IResolvable] = None,
system_disk_encrypted: typing.Union[bool, IResolvable] = None,
system_disk_kms_key_id: typing.Union[str, IResolvable] = None,
system_disk_performance_level: typing.Union[str, IResolvable] = None,
system_disk_provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
tag_list: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TagListProperty]]] = None,
tenancy: typing.Union[str, IResolvable] = None,
user_data: typing.Union[str, IResolvable] = None,
zone_id: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
- scope in which this resource is defined. |
id |
str |
- scoped id of the resource. |
scaling_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
affinity |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
credit_specification |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
dedicated_host_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
deployment_set_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
disk_mappings |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] |
No description. |
host_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
hpc_cluster_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_family |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_options_login_as_non_root |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
instance_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_pattern_infos |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstancePatternInfosProperty]]] |
No description. |
instance_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_type_overrides |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstanceTypeOverridesProperty]]] |
No description. |
instance_types |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
internet_charge_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_max_bandwidth_in |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
internet_max_bandwidth_out |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
io_optimized |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
ipv6_address_count |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
key_pair_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
load_balancer_weight |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
memory |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
password |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
password_inherit |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
private_pool_options |
typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty] |
No description. |
ram_role_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
scaling_configuration_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_enhancement_strategy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_group_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
spot_duration |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
spot_interruption_behavior |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
spot_price_limit |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
spot_price_limit_for_instance_type |
typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] |
No description. |
spot_strategy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_auto_snapshot_policy_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_bursting_enabled |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
system_disk_categories |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
system_disk_category |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_disk_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_encrypt_algorithm |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_encrypted |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
system_disk_kms_key_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_performance_level |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_provisioned_iops |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
system_disk_size |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
tag_list |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]] |
No description. |
tenancy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
user_data |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
zone_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
scope in which this resource is defined.
id
Required
- Type: str
scoped id of the resource.
scaling_group_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
affinity
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
cpu
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
credit_specification
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
dedicated_host_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
deployment_set_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
disk_mappings
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]]
host_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
hpc_cluster_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_family
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_options_login_as_non_root
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
instance_description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_pattern_infos
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstancePatternInfosProperty]]]
instance_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_type_overrides
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstanceTypeOverridesProperty]]]
instance_types
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
internet_charge_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_max_bandwidth_in
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
internet_max_bandwidth_out
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
io_optimized
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
ipv6_address_count
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
key_pair_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
load_balancer_weight
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
memory
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
password
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
password_inherit
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
private_pool_options
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty]
ram_role_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
resource_group_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
scaling_configuration_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_enhancement_strategy
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_group_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_group_ids
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
spot_duration
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
spot_interruption_behavior
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
spot_price_limit
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
spot_price_limit_for_instance_type
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
spot_strategy
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_auto_snapshot_policy_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_bursting_enabled
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
system_disk_categories
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
system_disk_category
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_disk_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_encrypt_algorithm
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_encrypted
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
system_disk_kms_key_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_performance_level
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_provisioned_iops
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
system_disk_size
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
tag_list
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]]
tenancy
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
user_data
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
zone_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
enable_resource_property_constraint
Required
- 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. |
override_logical_id |
Overrides the auto-generated logical ID with a specific ID. |
add_condition |
No description. |
add_count |
No description. |
add_deletion_override |
Syntactic sugar for addOverride(path, undefined) . |
add_depends_on |
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add_desc |
No description. |
add_meta_data |
No description. |
add_override |
Adds an override to the synthesized ROS resource. |
add_property_deletion_override |
Adds an override that deletes the value of a property from the resource definition. |
add_property_override |
Adds an override to a resource property. |
add_ros_dependency |
No description. |
apply_removal_policy |
Sets the deletion policy of the resource based on the removal policy specified. |
get_att |
Returns a token for an runtime attribute of this resource. |
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.
override_logical_id
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
add_condition
def add_condition(
con: 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_deletion_override
def add_deletion_override(
path: str
) -> None
Syntactic sugar for addOverride(path, undefined)
.
- Type: str
The path of the value to delete.
add_depends_on
def add_depends_on(
target: RosResource
) -> None
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Type: ros_cdk_core.RosResource
add_desc
def add_desc(
desc: str
) -> None
- Type: str
add_meta_data
def add_meta_data(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
add_override
def add_override(
path: str,
value: typing.Any
) -> None
Adds an override to the synthesized ROS resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
For example,
addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
- Type: str
The path of the property, you can use dot notation to override values in complex types.
Any intermdediate keys will be created as needed.
- Type: typing.Any
The value.
Could be primitive or complex.
add_property_deletion_override
def add_property_deletion_override(
property_path: str
) -> None
Adds an override that deletes the value of a property from the resource definition.
- Type: str
The path to the property.
add_property_override
def add_property_override(
property_path: str,
value: typing.Any
) -> None
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
- Type: str
The path of the property.
- Type: typing.Any
The value.
add_ros_dependency
def add_ros_dependency(
target: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy = None,
apply_to_update_replace_policy: bool = None,
default_policy: RemovalPolicy = None
) -> None
Sets the deletion policy of the resource based on the removal policy specified.
- Type: ros_cdk_core.RemovalPolicy
apply_to_update_replace_policy
Optional
- Type: bool
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
attribute_name: str
) -> Reference
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
- Type: str
The name of the attribute.
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_ros_element |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
is_ros_resource |
Check whether the given construct is a RosResource. |
is_construct
import ros_cdk_ess
ros_cdk_ess.RosScalingConfiguration.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
is_ros_element
import ros_cdk_ess
ros_cdk_ess.RosScalingConfiguration.is_ros_element(
x: typing.Any
)
Returns true
if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of instanceof
to allow stack elements from different
versions of this library to be included in the same stack.
- Type: typing.Any
is_ros_resource
import ros_cdk_ess
ros_cdk_ess.RosScalingConfiguration.is_ros_resource(
construct: IConstruct
)
Check whether the given construct is a RosResource.
- Type: ros_cdk_core.IConstruct
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
creation_stack |
typing.List[str] |
No description. |
logical_id |
str |
The logical ID for this stack element. |
stack |
ros_cdk_core.Stack |
The stack in which this element is defined. |
ref |
str |
Return a string that will be resolved to a RosTemplate { Ref } for this element. |
ros_options |
ros_cdk_core.IRosResourceOptions |
Options for this resource, such as condition, update policy etc. |
ros_resource_type |
str |
ROS resource type. |
attr_scaling_configuration_id |
ros_cdk_core.IResolvable |
No description. |
attr_scaling_group_id |
ros_cdk_core.IResolvable |
No description. |
enable_resource_property_constraint |
bool |
No description. |
scaling_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
affinity |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
credit_specification |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
dedicated_host_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
deployment_set_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
disk_mappings |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] |
No description. |
host_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
hpc_cluster_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_family |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
image_options_login_as_non_root |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
instance_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_pattern_infos |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstancePatternInfosProperty]]] |
No description. |
instance_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
instance_type_overrides |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstanceTypeOverridesProperty]]] |
No description. |
instance_types |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
internet_charge_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_max_bandwidth_in |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
internet_max_bandwidth_out |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
io_optimized |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
ipv6_address_count |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
key_pair_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
load_balancer_weight |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
memory |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
password |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
password_inherit |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
private_pool_options |
typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty] |
No description. |
ram_role_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
scaling_configuration_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_enhancement_strategy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
security_group_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
spot_duration |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
spot_interruption_behavior |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
spot_price_limit |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
spot_price_limit_for_instance_type |
typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] |
No description. |
spot_strategy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_auto_snapshot_policy_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_bursting_enabled |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
system_disk_categories |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
No description. |
system_disk_category |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_disk_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_encrypt_algorithm |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_encrypted |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
system_disk_kms_key_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_performance_level |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
system_disk_provisioned_iops |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
system_disk_size |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
tag_list |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]] |
No description. |
tenancy |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
user_data |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
zone_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
creation_stack
Required
creation_stack: typing.List[str]
- Type: typing.List[str]
logical_id
Required
logical_id: str
- Type: str
The logical ID for this stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
stack
Required
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
ref
Required
ref: str
- Type: str
Return a string that will be resolved to a RosTemplate { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
ros_options
Required
ros_options: IRosResourceOptions
- Type: ros_cdk_core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
ros_resource_type
Required
ros_resource_type: str
- Type: str
ROS resource type.
attr_scaling_configuration_id
Required
attr_scaling_configuration_id: IResolvable
- Type: ros_cdk_core.IResolvable
attr_scaling_group_id
Required
attr_scaling_group_id: IResolvable
- Type: ros_cdk_core.IResolvable
enable_resource_property_constraint
Required
enable_resource_property_constraint: bool
- Type: bool
scaling_group_id
Required
scaling_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
affinity
Optional
affinity: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
cpu
Optional
cpu: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
credit_specification
Optional
credit_specification: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
dedicated_host_id
Optional
dedicated_host_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
deployment_set_id
Optional
deployment_set_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
disk_mappings
Optional
disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]]
host_name
Optional
host_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
hpc_cluster_id
Optional
hpc_cluster_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_family
Optional
image_family: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_id
Optional
image_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_name
Optional
image_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
image_options_login_as_non_root
Optional
image_options_login_as_non_root: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
instance_description
Optional
instance_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_id
Optional
instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_name
Optional
instance_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_pattern_infos
Optional
instance_pattern_infos: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstancePatternInfosProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstancePatternInfosProperty]]]
instance_type
Optional
instance_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
instance_type_overrides
Optional
instance_type_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceTypeOverridesProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstanceTypeOverridesProperty]]]
instance_types
Optional
instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
internet_charge_type
Optional
internet_charge_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_max_bandwidth_in
Optional
internet_max_bandwidth_in: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
internet_max_bandwidth_out
Optional
internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
io_optimized
Optional
io_optimized: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
ipv6_address_count
Optional
ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
key_pair_name
Optional
key_pair_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
load_balancer_weight
Optional
load_balancer_weight: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
memory
Optional
memory: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
password
Optional
password: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
password_inherit
Optional
password_inherit: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
private_pool_options
Optional
private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty]
ram_role_name
Optional
ram_role_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
resource_group_id
Optional
resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
scaling_configuration_name
Optional
scaling_configuration_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_enhancement_strategy
Optional
security_enhancement_strategy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_group_id
Optional
security_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
security_group_ids
Optional
security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
spot_duration
Optional
spot_duration: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
spot_interruption_behavior
Optional
spot_interruption_behavior: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
spot_price_limit
Optional
spot_price_limit: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
spot_price_limit_for_instance_type
Optional
spot_price_limit_for_instance_type: typing.Union[IResolvable, typing.Mapping[typing.Any]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
spot_strategy
Optional
spot_strategy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_auto_snapshot_policy_id
Optional
system_disk_auto_snapshot_policy_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_bursting_enabled
Optional
system_disk_bursting_enabled: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
system_disk_categories
Optional
system_disk_categories: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
system_disk_category
Optional
system_disk_category: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_description
Optional
system_disk_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_disk_name
Optional
system_disk_disk_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_encrypt_algorithm
Optional
system_disk_encrypt_algorithm: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_encrypted
Optional
system_disk_encrypted: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
system_disk_kms_key_id
Optional
system_disk_kms_key_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_performance_level
Optional
system_disk_performance_level: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
system_disk_provisioned_iops
Optional
system_disk_provisioned_iops: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
system_disk_size
Optional
system_disk_size: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
tag_list
Optional
tag_list: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TagListProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]]
tenancy
Optional
tenancy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
user_data
Optional
user_data: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
zone_id
Optional
zone_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Constants
Name | Type | Description |
---|---|---|
ROS_RESOURCE_TYPE_NAME |
str |
The resource type name for this resource class. |
ROS_RESOURCE_TYPE_NAME
Required
ROS_RESOURCE_TYPE_NAME: str
- Type: str
The resource type name for this resource class.