Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudfw-instance

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-cloudfw'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the firewall instance.
accountNum number | @alicloud/ros-cdk-core.IResolvable Property accountNum: The number of multi-account management and control is the number of member accounts that you need to uniformly control.
aclExtension number | @alicloud/ros-cdk-core.IResolvable Property aclExtension: When the default access control authorization specifications of your version are not enough, you can purchase global extension specifications of access control.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Whether to auto pay the bill.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Whether to auto renew the prepay instance.
bandwidth number | @alicloud/ros-cdk-core.IResolvable Property bandwidth: Public network processing capability.
ignoreExisting boolean | @alicloud/ros-cdk-core.IResolvable Property ignoreExisting: Whether to ignore existing cloud firewall instance False: ROS will perform a uniqueness check.If the cloud firewall instance exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the cloud firewall instance exists, the creation process will be ignored. If the cloud firewall instance is not created by ROS, it will be ignored during update and delete stage.
ipNum number | @alicloud/ros-cdk-core.IResolvable Property ipNum: The number of public IPs that can be protected.
logAnalysis boolean | @alicloud/ros-cdk-core.IResolvable Property logAnalysis: The cloud firewall includes 7 days of free log storage and auditing by default.
logStorage number | @alicloud/ros-cdk-core.IResolvable Property logStorage: Reference for purchasing storage capacity: 10M public network bandwidth, 6 months of log storage, recommended purchase of 1000GB log storage capacity.
multiAccountManagement boolean | @alicloud/ros-cdk-core.IResolvable Property multiAccountManagement: Multiple accounts on the enterprise cloud can be managed centrally on the cloud firewall, including asset inventory, ACL policies, attack protection, log reports, etc.
natBandwidth number | @alicloud/ros-cdk-core.IResolvable Property natBandwidth: The bandwidth of private network traffic processed by the NAT firewall.
natFirewallNum number | @alicloud/ros-cdk-core.IResolvable Property natFirewallNum: The number of NAT gateway instances of the NAT firewall you need to enable.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription period of the firewallIf PeriodUnit is month, the valid range is 1, 3, 6 If periodUnit is year, the valid range is 1, 2, 3.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription duration.
spec string | @alicloud/ros-cdk-core.IResolvable Property spec: The version of Cloud Firewall.
vpcBandwidth number | @alicloud/ros-cdk-core.IResolvable Property vpcBandwidth: VPC network processing capability.
vpcFirewallNum number | @alicloud/ros-cdk-core.IResolvable Property vpcFirewallNum: The number of protected VPCs.

payTypeRequired 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method of the firewall instance.

Valid values: PayAsYouGo: pay-as-you-go Subscription: subscription

accountNumOptional 

public readonly accountNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property accountNum: The number of multi-account management and control is the number of member accounts that you need to uniformly control.

aclExtensionOptional 

public readonly aclExtension: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property aclExtension: When the default access control authorization specifications of your version are not enough, you can purchase global extension specifications of access control.

This extension supports shared occupancy with Internet and VPC boundary ACL specifications.

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Whether to auto pay the bill.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: Whether to auto renew the prepay instance.

bandwidthOptional 

public readonly bandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property bandwidth: Public network processing capability.

Valid values: 10 to 15000. Unit: Mbps.

ignoreExistingOptional 

public readonly ignoreExisting: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property ignoreExisting: Whether to ignore existing cloud firewall instance False: ROS will perform a uniqueness check.If the cloud firewall instance exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the cloud firewall instance exists, the creation process will be ignored. If the cloud firewall instance is not created by ROS, it will be ignored during update and delete stage.

ipNumOptional 

public readonly ipNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipNum: The number of public IPs that can be protected.

Valid values: 20 to 4000.PremiumVersion: [20, 1000]

logAnalysisOptional 

public readonly logAnalysis: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property logAnalysis: The cloud firewall includes 7 days of free log storage and auditing by default.

If you need longer storage time or meet the requirements for equal protection, it is recommended to purchase the log analysis service.

logStorageOptional 

public readonly logStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property logStorage: Reference for purchasing storage capacity: 10M public network bandwidth, 6 months of log storage, recommended purchase of 1000GB log storage capacity.

multiAccountManagementOptional 

public readonly multiAccountManagement: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property multiAccountManagement: Multiple accounts on the enterprise cloud can be managed centrally on the cloud firewall, including asset inventory, ACL policies, attack protection, log reports, etc.

After the member account is managed by the current account, there will be no need to purchase it separately.

natBandwidthOptional 

public readonly natBandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property natBandwidth: The bandwidth of private network traffic processed by the NAT firewall.

The premium version does not include it by default, the enterprise version has 10Mbps by default, and the ultimate version has 20Mbps by default.

natFirewallNumOptional 

public readonly natFirewallNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property natFirewallNum: The number of NAT gateway instances of the NAT firewall you need to enable.

Each NAT gateway instance corresponds to one NAT firewall instance. The premium version does not include it by default, the enterprise version comes with 1 specification by default,and the ultimate version comes with 2 specifications by default.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription period of the firewallIf PeriodUnit is month, the valid range is 1, 3, 6 If periodUnit is year, the valid range is 1, 2, 3.

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

specOptional 

public readonly spec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property spec: The version of Cloud Firewall.

vpcBandwidthOptional 

public readonly vpcBandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property vpcBandwidth: VPC network processing capability.

Valid values: 1000 to 15000. Unit: Mbps.

vpcFirewallNumOptional 

public readonly vpcFirewallNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property vpcFirewallNum: The number of protected VPCs.

It will be ignored when spec = "premium_version". Valid values between 2 and 500.