Skip to content

ImageComponent

This class encapsulates and extends the ROS resource type ALIYUN::ECS::ImageComponent, which is used to create an image component.

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.ImageComponent(
  scope: Construct,
  id: str,
  content: typing.Union[str, IResolvable],
  component_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  system_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
content typing.Union[str, ros_cdk_core.IResolvable] Property content: The content of the image component.
component_type typing.Union[str, ros_cdk_core.IResolvable] Property componentType: The type of the image component.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The component name.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
system_type typing.Union[str, ros_cdk_core.IResolvable] Property systemType: The operating system type supported by the image component.
tags typing.List[TagsProperty] Property tags:.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

contentRequired

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

Property content: The content of the image component.

The content consists of up to 127 commands.

component_typeOptional

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

Property componentType: The type of the image component.

Only image build components are supported. Set the value to Build.Default value: Build.

descriptionOptional

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

Property description: The description.

The description must be 2 to 256 characters in length and cannot start with http:// or https://.

nameOptional

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

Property name: The component name.

The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with http:// or https://.The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). Note If you do not configure Name, the return value of ImageComponentId is used.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.

system_typeOptional

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

Property systemType: The operating system type supported by the image component.

Only Linux is supported. Set the value to Linux.Default value: Linux.

tagsOptional

Property tags:.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

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

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_ecs
ros_cdk_ecs.ImageComponent.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_image_component_id ros_cdk_core.IResolvable Attribute ImageComponentId: The ID of the image component.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_image_component_idRequired 

attr_image_component_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageComponentId: The ID of the image component.