Skip to content

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.

scopeRequired

  • Type: ros_cdk_core.Construct

scope in which this resource is defined.


idRequired

  • Type: str

scoped id of the resource.


app_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

cluster_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

application_descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

commandOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

command_argsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]]

deploy_across_nodesOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

deploy_across_zonesOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

edas_container_versionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_ahasOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

envsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]]

image_urlOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_slb_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_slb_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

internet_slb_protocolOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_target_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

intranet_slb_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

intranet_slb_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

intranet_slb_protocolOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

intranet_target_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

is_multilingual_appOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

java_start_up_configOptional


jdkOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

limit_cpuOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

limit_memOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

livenessOptional


local_volumeOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]]

logical_region_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

mount_descsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]]

namespaceOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

nas_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_urlOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_versionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

post_startOptional


pre_stopOptional


readinessOptional


replicasOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

repo_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

requests_cpuOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

requests_memOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

runtime_class_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

sls_configsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]]

storage_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

timeoutOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

uri_encodingOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

use_body_encodingOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

web_containerOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

web_container_configOptional


enable_resource_property_constraintRequired

  • 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.

sessionRequired

  • 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.

new_logical_idRequired

  • Type: str

The new logical ID to use for this stack element.


add_condition

def add_condition(
  con: RosCondition
) -> None

conRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • 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).

pathRequired

  • 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.

targetRequired

  • Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

descRequired

  • Type: str

add_meta_data

def add_meta_data(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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"
       ...
     },
   ]
   ...
}

pathRequired

  • 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.


valueRequired

  • 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.

property_pathRequired

  • 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).

property_pathRequired

  • Type: str

The path of the property.


valueRequired

  • Type: typing.Any

The value.


add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

targetRequired

  • 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.

policyOptional

  • Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policyOptional

  • Type: bool

default_policyOptional

  • 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.

attribute_nameRequired

  • 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.

xRequired

  • 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.

xRequired

  • 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.

constructRequired

  • 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.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


creation_stackRequired

creation_stack: typing.List[str]
  • Type: typing.List[str]

logical_idRequired

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).


stackRequired

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).


refRequired

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_optionsRequired

ros_options: IRosResourceOptions
  • Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


ros_resource_typeRequired

ros_resource_type: str
  • Type: str

ROS resource type.


attr_app_idRequired

attr_app_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_app_nameRequired

attr_app_name: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_change_order_idRequired

attr_change_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_cluster_idRequired

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_cs_cluster_idRequired

attr_cs_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

app_nameRequired

app_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

cluster_idRequired

cluster_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_resource_property_constraintRequired

enable_resource_property_constraint: bool
  • Type: bool

application_descriptionOptional

application_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

commandOptional

command: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

command_argsOptional

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_nodesOptional

deploy_across_nodes: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

deploy_across_zonesOptional

deploy_across_zones: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

edas_container_versionOptional

edas_container_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_ahasOptional

enable_ahas: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

envsOptional

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_urlOptional

image_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_slb_idOptional

internet_slb_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_slb_portOptional

internet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

internet_slb_protocolOptional

internet_slb_protocol: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

internet_target_portOptional

internet_target_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

intranet_slb_idOptional

intranet_slb_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

intranet_slb_portOptional

intranet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

intranet_slb_protocolOptional

intranet_slb_protocol: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

intranet_target_portOptional

intranet_target_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

is_multilingual_appOptional

is_multilingual_app: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

java_start_up_configOptional

java_start_up_config: typing.Union[IResolvable, JavaStartUpConfigProperty]

jdkOptional

jdk: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

limit_cpuOptional

limit_cpu: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

limit_memOptional

limit_mem: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

livenessOptional

liveness: typing.Union[IResolvable, LivenessProperty]

local_volumeOptional

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_idOptional

logical_region_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

mount_descsOptional

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]]]

namespaceOptional

namespace: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

nas_idOptional

nas_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_typeOptional

package_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_urlOptional

package_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

package_versionOptional

package_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

post_startOptional

post_start: typing.Union[IResolvable, PostStartProperty]

pre_stopOptional

pre_stop: typing.Union[IResolvable, PreStopProperty]

readinessOptional

readiness: typing.Union[IResolvable, ReadinessProperty]

replicasOptional

replicas: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

repo_idOptional

repo_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

requests_cpuOptional

requests_cpu: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

requests_memOptional

requests_mem: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

runtime_class_nameOptional

runtime_class_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

sls_configsOptional

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_typeOptional

storage_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

timeoutOptional

timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

uri_encodingOptional

uri_encoding: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

use_body_encodingOptional

use_body_encoding: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

web_containerOptional

web_container: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

web_container_configOptional

web_container_config: typing.Union[IResolvable, WebContainerConfigProperty]

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME str The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

ROS_RESOURCE_TYPE_NAME: str
  • Type: str

The resource type name for this resource class.