Skip to content

Activation

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Activation, which is used to query the information about an activation code.

Initializers

from ros_cdk_ecs import datasource
datasource.Activation(
  scope: Construct,
  id: str,
  activation_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
activation_id typing.Union[str, ros_cdk_core.IResolvable] Property activationId: Activation code ID.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

activation_idRequired

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

Property activationId: Activation code ID.


refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

from ros_cdk_ecs import datasource
datasource.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_id ros_cdk_core.IResolvable Attribute ActivationId: Activation code ID.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the activation code was created.
attr_deregistered_count ros_cdk_core.IResolvable Attribute DeregisteredCount: The number of instances that have been logged out.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the activation code.
attr_disabled ros_cdk_core.IResolvable Attribute Disabled: Indicates whether the activation code is disabled.
attr_instance_count ros_cdk_core.IResolvable Attribute InstanceCount: The maximum number of times that the activation code can be used to register managed instances.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The default prefix of the instance name.
attr_ip_address_range ros_cdk_core.IResolvable Attribute IpAddressRange: The IP address of the host that allows the activation code to be used.
attr_registered_count ros_cdk_core.IResolvable Attribute RegisteredCount: The number of instances that were registered.
attr_time_to_live_in_hours ros_cdk_core.IResolvable Attribute TimeToLiveInHours: The validity period of the activation code.

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_idRequired

attr_activation_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ActivationId: Activation code ID.


attr_create_timeRequired

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the activation code was created.


attr_deregistered_countRequired

attr_deregistered_count: IResolvable
  • Type: ros_cdk_core.IResolvable

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


attr_descriptionRequired

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the activation code.


attr_disabledRequired

attr_disabled: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Disabled: Indicates whether the activation code is disabled.


attr_instance_countRequired

attr_instance_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceCount: The maximum number of times that the activation code can be used to register managed instances.


attr_instance_nameRequired

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The default prefix of the instance name.


attr_ip_address_rangeRequired

attr_ip_address_range: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpAddressRange: The IP address of the host that allows the activation code to be used.


attr_registered_countRequired

attr_registered_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RegisteredCount: The number of instances that were registered.


attr_time_to_live_in_hoursRequired

attr_time_to_live_in_hours: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TimeToLiveInHours: The validity period of the activation code.

Unit: hours.