Skip to content

OriginInstance

This class encapsulates and extends the ROS resource type ALIYUN::DDoS::OriginInstance, which is used to create an Anti-DDoS Origin instance.

Initializers 

import ros_cdk_ddos
ros_cdk_ddos.OriginInstance(
  scope: Construct,
  id: str,
  edition: typing.Union[str, IResolvable],
  protection_mode: typing.Union[str, IResolvable],
  charge_type: typing.Union[str, IResolvable] = None,
  clean_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_log: typing.Union[bool, IResolvable] = None,
  ip_addresses: typing.Union[typing.Union[int, float], IResolvable] = None,
  network_protocol: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: 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.
edition typing.Union[str, ros_cdk_core.IResolvable] Property edition: Edition of the instance.
protection_mode typing.Union[str, ros_cdk_core.IResolvable] Property protectionMode: The mode of the protection.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The charge type of the instance.
clean_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cleanBandwidth: The mitigation capability of Anti-DDoS is measured by the inbound or outbound clean bandwidth.
enable_log typing.Union[bool, ros_cdk_core.IResolvable] Property enableLog: Whether to enable protection logs.
ip_addresses typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ipAddresses: The number of ip addresses.
network_protocol typing.Union[str, ros_cdk_core.IResolvable] Property networkProtocol: The network protocol of the instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The period of the instance.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The period unit of the instance.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

editionRequired

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

Property edition: Edition of the instance.

Valid values:

  • enterprise: Enterprise Edition.
  • smb: Affordable and general edition for small and medium-sized enterprises.

protection_modeRequired

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

Property protectionMode: The mode of the protection.

Valid values: unlimited: The Unlimited protection mode is intended for internal use within enterprises.

charge_typeOptional

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

Property chargeType: The charge type of the instance.

Valid values: PostPaid: Pay-as-you-go. PrePaid: Subscription.

clean_bandwidthOptional

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

Property cleanBandwidth: The mitigation capability of Anti-DDoS is measured by the inbound or outbound clean bandwidth.

When Edition is enterprise, CleanBandwidth ranges from 100 to 1000 Mbit/s.When Edition is smb， CleanBandwidth ranges from 50 to 1000 Mbit/s.

enable_logOptional

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

Property enableLog: Whether to enable protection logs.

ip_addressesOptional

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

Property ipAddresses: The number of ip addresses.

When Edition is smb， IP Addresses ranges from 1 to 29. When Edition is enterprise, The minimum number of IP Addresses is 30.

network_protocolOptional

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

Property networkProtocol: The network protocol of the instance.

Valid values: v4: IPv4. v6: IPv6. v4_6: IPv4+IPv6.

periodOptional

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

Property period: The period of the instance.

period_unitOptional

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

Property periodUnit: The period unit of the instance.

Valid values: Month: Month. Year: Year.

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.

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_ddos
ros_cdk_ddos.OriginInstance.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_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the instance.

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_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.