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 com.aliyun.ros.cdk.sag.SmartAccessGateway;
SmartAccessGateway.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .buyerMessage(java.lang.String)
    .buyerMessage(IResolvable)
    .chargeType(java.lang.String)
    .chargeType(IResolvable)
    .hardWareSpec(java.lang.String)
    .hardWareSpec(IResolvable)
    .haType(java.lang.String)
    .haType(IResolvable)
    .maxBandWidth(java.lang.Number)
    .maxBandWidth(IResolvable)
    .period(java.lang.Number)
    .period(IResolvable)
    .receiverAddress(java.lang.String)
    .receiverAddress(IResolvable)
    .receiverCity(java.lang.String)
    .receiverCity(IResolvable)
    .receiverCountry(java.lang.String)
    .receiverCountry(IResolvable)
    .receiverDistrict(java.lang.String)
    .receiverDistrict(IResolvable)
    .receiverEmail(java.lang.String)
    .receiverEmail(IResolvable)
    .receiverMobile(java.lang.String)
    .receiverMobile(IResolvable)
    .receiverName(java.lang.String)
    .receiverName(IResolvable)
    .receiverState(java.lang.String)
    .receiverState(IResolvable)
    .receiverTown(java.lang.String)
    .receiverTown(IResolvable)
    .receiverZip(java.lang.String)
    .receiverZip(IResolvable)
//  .activate(java.lang.Boolean)
//  .activate(IResolvable)
//  .alreadyHaveSag(java.lang.Boolean)
//  .alreadyHaveSag(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .cidrBlock(java.lang.String)
//  .cidrBlock(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .receiverPhone(java.lang.String)
//  .receiverPhone(IResolvable)
//  .routingStrategy(java.lang.String)
//  .routingStrategy(IResolvable)
//  .securityLockThreshold(java.lang.Number)
//  .securityLockThreshold(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
buyerMessage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property buyerMessage: The remarks left by the buyer.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The billing method of the SAG instance.
hardWareSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hardWareSpec: The type of the SAG instance.
haType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property haType: The deployment mode.
maxBandWidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxBandWidth: The bandwidth of the SAG instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the SAG instance.
receiverAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverAddress: The detailed address of the recipient.
receiverCity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverCity: The city of the recipient address.
receiverCountry java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverCountry: The country of the recipient address.
receiverDistrict java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverDistrict: The district of the recipient address.
receiverEmail java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverEmail: The email address of the recipient.
receiverMobile java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverMobile: The mobile phone number of the recipient.
receiverName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverName: The name of the recipient.
receiverState java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverState: The province of the recipient address.
receiverTown java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverTown: The town of the recipient address.
receiverZip java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverZip: The postcode of the recipient address.
activate java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property activate: Activate SAG or not.
alreadyHaveSag java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property alreadyHaveSag: Specifies whether you already have an SAG device.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Specifies whether to enable auto-payment for the instance.
cidrBlock java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cidrBlock: The CIDR blocks of terminals in the private network.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the SAG instance.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the SAG instance.
receiverPhone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property receiverPhone: The landline phone number of the recipient.
routingStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routingStrategy: The policy to advertise routes from the private network to Alibaba Cloud.
securityLockThreshold java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property securityLockThreshold: The time that a disconnected SAG device remain locked.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

buyerMessageRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property buyerMessage: The remarks left by the buyer.

chargeTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property chargeType: The billing method of the SAG instance.

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

hardWareSpecRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property hardWareSpec: The type of the SAG instance.

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

haTypeRequired

  • Type: java.lang.String OR com.aliyun.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.

maxBandWidthRequired

  • Type: java.lang.Number OR com.aliyun.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: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: The subscription period of the SAG instance.

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

receiverAddressRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverAddress: The detailed address of the recipient.

receiverCityRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverCity: The city of the recipient address.

receiverCountryRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverCountry: The country of the recipient address.

receiverDistrictRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverDistrict: The district of the recipient address.

receiverEmailRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverEmail: The email address of the recipient.

receiverMobileRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverMobile: The mobile phone number of the recipient.

receiverNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverName: The name of the recipient.

receiverStateRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverState: The province of the recipient address.

receiverTownRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverTown: The town of the recipient address.

receiverZipRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverZip: The postcode of the recipient address.

activateOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property activate: Activate SAG or not.

Default is False

alreadyHaveSagOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

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

autoPayOptional

  • Type: java.lang.Boolean OR com.aliyun.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.

cidrBlockOptional

  • Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

receiverPhoneOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property receiverPhone: The landline phone number of the recipient.

routingStrategyOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

static: static routing. dynamic: dynamic routing.

securityLockThresholdOptional

  • Type: java.lang.Number OR com.aliyun.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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.sag.SmartAccessGateway;
SmartAccessGateway.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: The ID of the order.
attrSmartAgId com.aliyun.ros.cdk.core.IResolvable Attribute SmartAGId: The ID of the SAG instance.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The ID of the order.

attrSmartAgIdRequired 

public IResolvable getAttrSmartAgId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SmartAGId: The ID of the SAG instance.