RosK8sApplication
This class is a base encapsulation around the ROS resource type ALIYUN::EDAS::K8sApplication
, which is used to create an application in a Kubernetes cluster.
Initializers
import ros_cdk_edas
ros_cdk_edas.RosK8sApplication(
scope: Construct,
id: str,
app_name: typing.Union[str, IResolvable],
cluster_id: typing.Union[str, IResolvable],
application_description: typing.Union[str, IResolvable] = None,
command: typing.Union[str, IResolvable] = None,
command_args: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CommandArgsProperty]]] = None,
deploy_across_nodes: typing.Union[bool, IResolvable] = None,
deploy_across_zones: typing.Union[bool, IResolvable] = None,
edas_container_version: typing.Union[str, IResolvable] = None,
enable_ahas: typing.Union[bool, IResolvable] = None,
envs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvsProperty]]] = None,
image_url: typing.Union[str, IResolvable] = None,
internet_slb_id: typing.Union[str, IResolvable] = None,
internet_slb_port: typing.Union[typing.Union[int, float], IResolvable] = None,
internet_slb_protocol: typing.Union[str, IResolvable] = None,
internet_target_port: typing.Union[typing.Union[int, float], IResolvable] = None,
intranet_slb_id: typing.Union[str, IResolvable] = None,
intranet_slb_port: typing.Union[typing.Union[int, float], IResolvable] = None,
intranet_slb_protocol: typing.Union[str, IResolvable] = None,
intranet_target_port: typing.Union[typing.Union[int, float], IResolvable] = None,
is_multilingual_app: typing.Union[bool, IResolvable] = None,
java_start_up_config: typing.Union[IResolvable, JavaStartUpConfigProperty] = None,
jdk: typing.Union[str, IResolvable] = None,
limit_cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
limit_mem: typing.Union[typing.Union[int, float], IResolvable] = None,
liveness: typing.Union[IResolvable, LivenessProperty] = None,
local_volume: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LocalVolumeProperty]]] = None,
logical_region_id: typing.Union[str, IResolvable] = None,
mount_descs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MountDescsProperty]]] = None,
namespace: typing.Union[str, IResolvable] = None,
nas_id: typing.Union[str, IResolvable] = None,
package_type: typing.Union[str, IResolvable] = None,
package_url: typing.Union[str, IResolvable] = None,
package_version: typing.Union[str, IResolvable] = None,
post_start: typing.Union[IResolvable, PostStartProperty] = None,
pre_stop: typing.Union[IResolvable, PreStopProperty] = None,
readiness: typing.Union[IResolvable, ReadinessProperty] = None,
replicas: typing.Union[typing.Union[int, float], IResolvable] = None,
repo_id: typing.Union[str, IResolvable] = None,
requests_cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
requests_mem: typing.Union[typing.Union[int, float], IResolvable] = None,
runtime_class_name: typing.Union[str, IResolvable] = None,
sls_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SlsConfigsProperty]]] = None,
storage_type: typing.Union[str, IResolvable] = None,
timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
uri_encoding: typing.Union[str, IResolvable] = None,
use_body_encoding: typing.Union[bool, IResolvable] = None,
web_container: typing.Union[str, IResolvable] = None,
web_container_config: typing.Union[IResolvable, WebContainerConfigProperty] = 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. |
app_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
cluster_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
application_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
command |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
command_args |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]] |
No description. |
deploy_across_nodes |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
deploy_across_zones |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
edas_container_version |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
enable_ahas |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
envs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]] |
No description. |
image_url |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_slb_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_slb_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
internet_slb_protocol |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_target_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
intranet_slb_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
intranet_slb_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
intranet_slb_protocol |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
intranet_target_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
is_multilingual_app |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
java_start_up_config |
typing.Union[ros_cdk_core.IResolvable, JavaStartUpConfigProperty] |
No description. |
jdk |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
limit_cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
limit_mem |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
liveness |
typing.Union[ros_cdk_core.IResolvable, LivenessProperty] |
No description. |
local_volume |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]] |
No description. |
logical_region_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
mount_descs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]] |
No description. |
namespace |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
nas_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_url |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_version |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
post_start |
typing.Union[ros_cdk_core.IResolvable, PostStartProperty] |
No description. |
pre_stop |
typing.Union[ros_cdk_core.IResolvable, PreStopProperty] |
No description. |
readiness |
typing.Union[ros_cdk_core.IResolvable, ReadinessProperty] |
No description. |
replicas |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
repo_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
requests_cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
requests_mem |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
runtime_class_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
sls_configs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]] |
No description. |
storage_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
timeout |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
uri_encoding |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
use_body_encoding |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
web_container |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
web_container_config |
typing.Union[ros_cdk_core.IResolvable, WebContainerConfigProperty] |
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.
app_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
cluster_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
application_description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
command
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
command_args
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]]
deploy_across_nodes
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
deploy_across_zones
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
edas_container_version
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
enable_ahas
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
envs
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]]
image_url
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_slb_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_slb_port
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
internet_slb_protocol
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_target_port
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
intranet_slb_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
intranet_slb_port
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
intranet_slb_protocol
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
intranet_target_port
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
is_multilingual_app
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
java_start_up_config
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, JavaStartUpConfigProperty]
jdk
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
limit_cpu
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
limit_mem
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
liveness
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, LivenessProperty]
local_volume
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]]
logical_region_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
mount_descs
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]]
namespace
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
nas_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_url
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_version
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
post_start
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, PostStartProperty]
pre_stop
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, PreStopProperty]
readiness
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, ReadinessProperty]
replicas
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
repo_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
requests_cpu
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
requests_mem
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
runtime_class_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
sls_configs
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]]
storage_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
timeout
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
uri_encoding
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
use_body_encoding
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
web_container
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
web_container_config
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, WebContainerConfigProperty]
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_edas
ros_cdk_edas.RosK8sApplication.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
is_ros_element
import ros_cdk_edas
ros_cdk_edas.RosK8sApplication.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_edas
ros_cdk_edas.RosK8sApplication.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_app_id |
ros_cdk_core.IResolvable |
No description. |
attr_app_name |
ros_cdk_core.IResolvable |
No description. |
attr_change_order_id |
ros_cdk_core.IResolvable |
No description. |
attr_cluster_id |
ros_cdk_core.IResolvable |
No description. |
attr_cs_cluster_id |
ros_cdk_core.IResolvable |
No description. |
app_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
cluster_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
enable_resource_property_constraint |
bool |
No description. |
application_description |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
command |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
command_args |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]] |
No description. |
deploy_across_nodes |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
deploy_across_zones |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
edas_container_version |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
enable_ahas |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
envs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]] |
No description. |
image_url |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_slb_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_slb_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
internet_slb_protocol |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
internet_target_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
intranet_slb_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
intranet_slb_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
intranet_slb_protocol |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
intranet_target_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
is_multilingual_app |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
java_start_up_config |
typing.Union[ros_cdk_core.IResolvable, JavaStartUpConfigProperty] |
No description. |
jdk |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
limit_cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
limit_mem |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
liveness |
typing.Union[ros_cdk_core.IResolvable, LivenessProperty] |
No description. |
local_volume |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]] |
No description. |
logical_region_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
mount_descs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]] |
No description. |
namespace |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
nas_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_url |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
package_version |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
post_start |
typing.Union[ros_cdk_core.IResolvable, PostStartProperty] |
No description. |
pre_stop |
typing.Union[ros_cdk_core.IResolvable, PreStopProperty] |
No description. |
readiness |
typing.Union[ros_cdk_core.IResolvable, ReadinessProperty] |
No description. |
replicas |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
repo_id |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
requests_cpu |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
requests_mem |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
runtime_class_name |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
sls_configs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]] |
No description. |
storage_type |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
timeout |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
No description. |
uri_encoding |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
use_body_encoding |
typing.Union[bool, ros_cdk_core.IResolvable] |
No description. |
web_container |
typing.Union[str, ros_cdk_core.IResolvable] |
No description. |
web_container_config |
typing.Union[ros_cdk_core.IResolvable, WebContainerConfigProperty] |
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_app_id
Required
attr_app_id: IResolvable
- Type: ros_cdk_core.IResolvable
attr_app_name
Required
attr_app_name: IResolvable
- Type: ros_cdk_core.IResolvable
attr_change_order_id
Required
attr_change_order_id: IResolvable
- Type: ros_cdk_core.IResolvable
attr_cluster_id
Required
attr_cluster_id: IResolvable
- Type: ros_cdk_core.IResolvable
attr_cs_cluster_id
Required
attr_cs_cluster_id: IResolvable
- Type: ros_cdk_core.IResolvable
app_name
Required
app_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
cluster_id
Required
cluster_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
enable_resource_property_constraint
Required
enable_resource_property_constraint: bool
- Type: bool
application_description
Optional
application_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
command
Optional
command: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
command_args
Optional
command_args: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CommandArgsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]]
deploy_across_nodes
Optional
deploy_across_nodes: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
deploy_across_zones
Optional
deploy_across_zones: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
edas_container_version
Optional
edas_container_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
enable_ahas
Optional
enable_ahas: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
envs
Optional
envs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]]
image_url
Optional
image_url: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_slb_id
Optional
internet_slb_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_slb_port
Optional
internet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
internet_slb_protocol
Optional
internet_slb_protocol: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
internet_target_port
Optional
internet_target_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
intranet_slb_id
Optional
intranet_slb_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
intranet_slb_port
Optional
intranet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
intranet_slb_protocol
Optional
intranet_slb_protocol: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
intranet_target_port
Optional
intranet_target_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
is_multilingual_app
Optional
is_multilingual_app: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
java_start_up_config
Optional
java_start_up_config: typing.Union[IResolvable, JavaStartUpConfigProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, JavaStartUpConfigProperty]
jdk
Optional
jdk: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
limit_cpu
Optional
limit_cpu: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
limit_mem
Optional
limit_mem: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
liveness
Optional
liveness: typing.Union[IResolvable, LivenessProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, LivenessProperty]
local_volume
Optional
local_volume: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LocalVolumeProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]]
logical_region_id
Optional
logical_region_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
mount_descs
Optional
mount_descs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MountDescsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]]
namespace
Optional
namespace: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
nas_id
Optional
nas_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_type
Optional
package_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_url
Optional
package_url: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
package_version
Optional
package_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
post_start
Optional
post_start: typing.Union[IResolvable, PostStartProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, PostStartProperty]
pre_stop
Optional
pre_stop: typing.Union[IResolvable, PreStopProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, PreStopProperty]
readiness
Optional
readiness: typing.Union[IResolvable, ReadinessProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, ReadinessProperty]
replicas
Optional
replicas: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
repo_id
Optional
repo_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
requests_cpu
Optional
requests_cpu: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
requests_mem
Optional
requests_mem: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
runtime_class_name
Optional
runtime_class_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
sls_configs
Optional
sls_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SlsConfigsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]]
storage_type
Optional
storage_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
timeout
Optional
timeout: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
uri_encoding
Optional
uri_encoding: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
use_body_encoding
Optional
use_body_encoding: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
web_container
Optional
web_container: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
web_container_config
Optional
web_container_config: typing.Union[IResolvable, WebContainerConfigProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, WebContainerConfigProperty]
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.