Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::Instance, which is used to create a Cloud Firewall instance.

Initializers 

import ros_cdk_cloudfw
ros_cdk_cloudfw.Instance(
  scope: Construct,
  id: str,
  pay_type: typing.Union[str, IResolvable],
  account_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  acl_extension: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  ignore_existing: typing.Union[bool, IResolvable] = None,
  ip_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  log_analysis: typing.Union[bool, IResolvable] = None,
  log_storage: typing.Union[typing.Union[int, float], IResolvable] = None,
  multi_account_management: typing.Union[bool, IResolvable] = None,
  nat_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  nat_firewall_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  spec: typing.Union[str, IResolvable] = None,
  vpc_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  vpc_firewall_num: 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.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method of the firewall instance.
account_num typing.Union[typing.Union[int, float], 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.
acl_extension typing.Union[typing.Union[int, float], 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.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Whether to auto pay the bill.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Whether to auto renew the prepay instance.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: Public network processing capability.
ignore_existing typing.Union[bool, 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.
ip_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ipNum: The number of public IPs that can be protected.
log_analysis typing.Union[bool, ros_cdk_core.IResolvable] Property logAnalysis: The cloud firewall includes 7 days of free log storage and auditing by default.
log_storage typing.Union[typing.Union[int, float], 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.
multi_account_management typing.Union[bool, 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.
nat_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property natBandwidth: The bandwidth of private network traffic processed by the NAT firewall.
nat_firewall_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property natFirewallNum: The number of NAT gateway instances of the NAT firewall you need to enable.
period typing.Union[typing.Union[int, float], 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.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the subscription duration.
spec typing.Union[str, ros_cdk_core.IResolvable] Property spec: The version of Cloud Firewall.
vpc_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property vpcBandwidth: VPC network processing capability.
vpc_firewall_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property vpcFirewallNum: The number of protected VPCs.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

pay_typeRequired

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

Property payType: The billing method of the firewall instance.

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

account_numOptional

  • Type: typing.Union[typing.Union[int, float], 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.

acl_extensionOptional

  • Type: typing.Union[typing.Union[int, float], 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.

auto_payOptional

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

Property autoPay: Whether to auto pay the bill.

auto_renewOptional

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

Property autoRenew: Whether to auto renew the prepay instance.

bandwidthOptional

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

Property bandwidth: Public network processing capability.

Valid values: 10 to 15000. Unit: Mbps.

ignore_existingOptional

  • Type: typing.Union[bool, 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.

ip_numOptional

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

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

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

log_analysisOptional

  • Type: typing.Union[bool, 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.

log_storageOptional

  • Type: typing.Union[typing.Union[int, float], 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.

multi_account_managementOptional

  • Type: typing.Union[bool, 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.

nat_bandwidthOptional

  • Type: typing.Union[typing.Union[int, float], 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.

nat_firewall_numOptional

  • Type: typing.Union[typing.Union[int, float], 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

  • Type: typing.Union[typing.Union[int, float], 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.

period_unitOptional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

specOptional

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

Property spec: The version of Cloud Firewall.

vpc_bandwidthOptional

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

Property vpcBandwidth: VPC network processing capability.

Valid values: 1000 to 15000. Unit: Mbps.

vpc_firewall_numOptional

  • Type: typing.Union[typing.Union[int, float], 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.

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_cloudfw
ros_cdk_cloudfw.Instance.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: Instance Id.

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: Instance Id.