Skip to content

Activation

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Activation, which is used to create an activation code.

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.Activation(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable] = None,
  instance_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  ip_address_range: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  time_to_live_in_hours: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the activation code.
instance_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property instanceCount: The maximum number of times that you can use the activation code to register managed instances.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The default instance name prefix.
ip_address_range typing.Union[str, ros_cdk_core.IResolvable] Property ipAddressRange: The IP addresses of hosts that are allowed to use the activation code.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
time_to_live_in_hours typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeToLiveInHours: The validity period of the activation code.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

descriptionOptional

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

Property description: The description of the activation code.

It must be 1 to 100 characters in length.

instance_countOptional

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

Property instanceCount: The maximum number of times that you can use the activation code to register managed instances.

Valid values: 1 to 1000.Default value: 10.

instance_nameOptional

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

Property instanceName: The default instance name prefix.

The instance name prefix must be 2 to 50 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:). If you use the activation code that is created by calling this operation (CreateActivation) to register managed instances, the instances are assigned sequential names that are prefixed by the value of this parameter. You can also specify a new instance name to replace the assigned sequential name when you register a managed instance.If you specify InstanceName when you register a managed instance, an instance name in theformat of - is generated. The number of digits in the value isdetermined by that in the InstanceCount value. Example: 001. If you do not specify InstanceName, the hostname (Hostname) is used as the instance name.

ip_address_rangeOptional

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

Property ipAddressRange: The IP addresses of hosts that are allowed to use the activation code.

The value can be IPv4 addresses, IPv6 addresses, or CIDR blocks.

tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

time_to_live_in_hoursOptional

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

Property timeToLiveInHours: The validity period of the activation code.

The activation code can no longer be used to register instances after the period ends. Unit: hours. Valid values: 1 to 876576, which represents a range of time from 1 hour to 100 years.Default value: 4.

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.Activation.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_activation_code ros_cdk_core.IResolvable Attribute ActivationCode: Activation code.
attr_activation_id ros_cdk_core.IResolvable Attribute ActivationId: Activation code ID.
attr_deregistered_count ros_cdk_core.IResolvable Attribute DeregisteredCount: The number of instances that have been logged out.
attr_registered_count ros_cdk_core.IResolvable Attribute RegisteredCount: The number of registered instances.

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_activation_codeRequired 

attr_activation_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ActivationCode: Activation code.

attr_activation_idRequired 

attr_activation_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ActivationId: Activation code ID.

attr_deregistered_countRequired 

attr_deregistered_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DeregisteredCount: The number of instances that have been logged out.

attr_registered_countRequired 

attr_registered_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RegisteredCount: The number of registered instances.