Skip to content

Instance

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

Initializers 

import com.aliyun.ros.cdk.cloudfw.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .payType(java.lang.String)
    .payType(IResolvable)
//  .accountNum(java.lang.Number)
//  .accountNum(IResolvable)
//  .aclExtension(java.lang.Number)
//  .aclExtension(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .ignoreExisting(java.lang.Boolean)
//  .ignoreExisting(IResolvable)
//  .ipNum(java.lang.Number)
//  .ipNum(IResolvable)
//  .logAnalysis(java.lang.Boolean)
//  .logAnalysis(IResolvable)
//  .logStorage(java.lang.Number)
//  .logStorage(IResolvable)
//  .multiAccountManagement(java.lang.Boolean)
//  .multiAccountManagement(IResolvable)
//  .natBandwidth(java.lang.Number)
//  .natBandwidth(IResolvable)
//  .natFirewallNum(java.lang.Number)
//  .natFirewallNum(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .spec(java.lang.String)
//  .spec(IResolvable)
//  .vpcBandwidth(java.lang.Number)
//  .vpcBandwidth(IResolvable)
//  .vpcFirewallNum(java.lang.Number)
//  .vpcFirewallNum(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.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the firewall instance.
accountNum java.lang.Number OR com.aliyun.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 java.lang.Number OR com.aliyun.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 java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Whether to auto pay the bill.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether to auto renew the prepay instance.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: Public network processing capability.
ignoreExisting java.lang.Boolean OR com.aliyun.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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ipNum: The number of public IPs that can be protected.
logAnalysis java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property logAnalysis: The cloud firewall includes 7 days of free log storage and auditing by default.
logStorage java.lang.Number OR com.aliyun.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 java.lang.Boolean OR com.aliyun.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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property natBandwidth: The bandwidth of private network traffic processed by the NAT firewall.
natFirewallNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property natFirewallNum: The number of NAT gateway instances of the NAT firewall you need to enable.
period java.lang.Number OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The unit of the subscription duration.
spec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spec: The version of Cloud Firewall.
vpcBandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property vpcBandwidth: VPC network processing capability.
vpcFirewallNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property vpcFirewallNum: The number of protected VPCs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

payTypeRequired

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

Property payType: The billing method of the firewall instance.

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

accountNumOptional

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

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

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

Property autoPay: Whether to auto pay the bill.

autoRenewOptional

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

Property autoRenew: Whether to auto renew the prepay instance.

bandwidthOptional

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

Property bandwidth: Public network processing capability.

Valid values: 10 to 15000. Unit: Mbps.

ignoreExistingOptional

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

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

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

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

logAnalysisOptional

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

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

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

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

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

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

specOptional

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

Property spec: The version of Cloud Firewall.

vpcBandwidthOptional

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

Property vpcBandwidth: VPC network processing capability.

Valid values: 1000 to 15000. Unit: Mbps.

vpcFirewallNumOptional

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

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.cloudfw.Instance;
Instance.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.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Instance Id.

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

attrInstanceIdRequired 

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

Attribute InstanceId: Instance Id.