Skip to content

SmartAccessGateway

This class encapsulates and extends the ROS resource type ALIYUN::SAG::SmartAccessGateway, which is used to create a Smart Access Gateway (SAG) instance.

Initializers 

import ros_cdk_sag
ros_cdk_sag.SmartAccessGateway(
  scope: Construct,
  id: str,
  buyer_message: typing.Union[str, IResolvable],
  charge_type: typing.Union[str, IResolvable],
  hard_ware_spec: typing.Union[str, IResolvable],
  ha_type: typing.Union[str, IResolvable],
  max_band_width: typing.Union[typing.Union[int, float], IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  receiver_address: typing.Union[str, IResolvable],
  receiver_city: typing.Union[str, IResolvable],
  receiver_country: typing.Union[str, IResolvable],
  receiver_district: typing.Union[str, IResolvable],
  receiver_email: typing.Union[str, IResolvable],
  receiver_mobile: typing.Union[str, IResolvable],
  receiver_name: typing.Union[str, IResolvable],
  receiver_state: typing.Union[str, IResolvable],
  receiver_town: typing.Union[str, IResolvable],
  receiver_zip: typing.Union[str, IResolvable],
  activate: typing.Union[bool, IResolvable] = None,
  already_have_sag: typing.Union[bool, IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  cidr_block: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  receiver_phone: typing.Union[str, IResolvable] = None,
  routing_strategy: typing.Union[str, IResolvable] = None,
  security_lock_threshold: 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.
buyer_message typing.Union[str, ros_cdk_core.IResolvable] Property buyerMessage: The remarks left by the buyer.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the SAG instance.
hard_ware_spec typing.Union[str, ros_cdk_core.IResolvable] Property hardWareSpec: The type of the SAG instance.
ha_type typing.Union[str, ros_cdk_core.IResolvable] Property haType: The deployment mode.
max_band_width typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxBandWidth: The bandwidth of the SAG instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period of the SAG instance.
receiver_address typing.Union[str, ros_cdk_core.IResolvable] Property receiverAddress: The detailed address of the recipient.
receiver_city typing.Union[str, ros_cdk_core.IResolvable] Property receiverCity: The city of the recipient address.
receiver_country typing.Union[str, ros_cdk_core.IResolvable] Property receiverCountry: The country of the recipient address.
receiver_district typing.Union[str, ros_cdk_core.IResolvable] Property receiverDistrict: The district of the recipient address.
receiver_email typing.Union[str, ros_cdk_core.IResolvable] Property receiverEmail: The email address of the recipient.
receiver_mobile typing.Union[str, ros_cdk_core.IResolvable] Property receiverMobile: The mobile phone number of the recipient.
receiver_name typing.Union[str, ros_cdk_core.IResolvable] Property receiverName: The name of the recipient.
receiver_state typing.Union[str, ros_cdk_core.IResolvable] Property receiverState: The province of the recipient address.
receiver_town typing.Union[str, ros_cdk_core.IResolvable] Property receiverTown: The town of the recipient address.
receiver_zip typing.Union[str, ros_cdk_core.IResolvable] Property receiverZip: The postcode of the recipient address.
activate typing.Union[bool, ros_cdk_core.IResolvable] Property activate: Activate SAG or not.
already_have_sag typing.Union[bool, ros_cdk_core.IResolvable] Property alreadyHaveSag: Specifies whether you already have an SAG device.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Specifies whether to enable auto-payment for the instance.
cidr_block typing.Union[str, ros_cdk_core.IResolvable] Property cidrBlock: The CIDR blocks of terminals in the private network.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the SAG instance.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the SAG instance.
receiver_phone typing.Union[str, ros_cdk_core.IResolvable] Property receiverPhone: The landline phone number of the recipient.
routing_strategy typing.Union[str, ros_cdk_core.IResolvable] Property routingStrategy: The policy to advertise routes from the private network to Alibaba Cloud.
security_lock_threshold typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property securityLockThreshold: The time that a disconnected SAG device remain locked.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

buyer_messageRequired

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

Property buyerMessage: The remarks left by the buyer.

charge_typeRequired

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

Property chargeType: The billing method of the SAG instance.

Set the value to PREPAY, which specifies the subscription billing method.

hard_ware_specRequired

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

Property hardWareSpec: The type of the SAG instance.

Valid values: sag-100wm sag-1000 sag-vcpe

ha_typeRequired

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

Property haType: The deployment mode.

Valid values: no_backup: You buy only one SAG device to connect private networks to Alibaba Cloud. cold_backup: You buy two SAG devices in active-standby mode. One SAG device serves as an active device and the other serves as a standby device. Only the active device is connected to Alibaba Cloud. If the active device is not working as expected, you must manually perform a switchover. warm_backup: You buy two SAG devices in active-active mode. Both SAG devices are connected to Alibaba Cloud. If an active device is not working as expected, a failover is automatically performed. Note If you want to create an SAG vCPE instance, set the value to warm_backup.

max_band_widthRequired

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

Property maxBandWidth: The bandwidth of the SAG instance.

If you want to create an SAG CPE instance and the model is sag-100wm, valid values of this parameter are 2 to 50. Unit: Mbit/s. If you want to create an SAG CPE instance and the model is sag-1000, valid values of this parameter are 10 to 500. Unit: Mbit/s. If you want to create an SAG vCPE instance, valid values of this parameter are 10 to 1000. Unit: Mbit/s.

periodRequired

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

Property period: The subscription period of the SAG instance.

Unit: months. Valid values: 1 to 9, 12, 24, and 36.

receiver_addressRequired

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

Property receiverAddress: The detailed address of the recipient.

receiver_cityRequired

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

Property receiverCity: The city of the recipient address.

receiver_countryRequired

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

Property receiverCountry: The country of the recipient address.

receiver_districtRequired

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

Property receiverDistrict: The district of the recipient address.

receiver_emailRequired

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

Property receiverEmail: The email address of the recipient.

receiver_mobileRequired

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

Property receiverMobile: The mobile phone number of the recipient.

receiver_nameRequired

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

Property receiverName: The name of the recipient.

receiver_stateRequired

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

Property receiverState: The province of the recipient address.

receiver_townRequired

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

Property receiverTown: The town of the recipient address.

receiver_zipRequired

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

Property receiverZip: The postcode of the recipient address.

activateOptional

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

Property activate: Activate SAG or not.

Default is False

already_have_sagOptional

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

Property alreadyHaveSag: Specifies whether you already have an SAG device.

Valid values: true: yes false (default): no

auto_payOptional

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

Property autoPay: Specifies whether to enable auto-payment for the instance.

Valid values: true: yes false: no If you set the parameter to false, go to Billing Management to complete the payment after you call this operation. After you complete the payment, the instance can be created.

cidr_blockOptional

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

Property cidrBlock: The CIDR blocks of terminals in the private network.

Make sure that the CIDR blocks do not overlap with each other. If the LAN port of the SAG device dynamically assigns IP addresses, IP addresses within the first CIDR block are assigned to terminals that have the Dynamic Host Configuration Protocol (DHCP) enabled.

descriptionOptional

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

Property description: The description of the SAG instance.

The description must be 2 to 256 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

nameOptional

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

Property name: The name of the SAG instance.

The name must be 2 to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

receiver_phoneOptional

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

Property receiverPhone: The landline phone number of the recipient.

routing_strategyOptional

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

Property routingStrategy: The policy to advertise routes from the private network to Alibaba Cloud.

static: static routing. dynamic: dynamic routing.

security_lock_thresholdOptional

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

Property securityLockThreshold: The time that a disconnected SAG device remain locked.

The time must be no shorter than zero second. Unit: second.

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_sag
ros_cdk_sag.SmartAccessGateway.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_order_id ros_cdk_core.IResolvable Attribute OrderId: The ID of the order.
attr_smart_ag_id ros_cdk_core.IResolvable Attribute SmartAGId: The ID of the SAG 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_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: The ID of the order.

attr_smart_ag_idRequired 

attr_smart_ag_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SmartAGId: The ID of the SAG instance.