Skip to content

NatGatewayProps

Properties for defining a NatGateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-natgateway

Initializer

import com.aliyun.ros.cdk.vpc.NatGatewayProps;
NatGatewayProps.builder()
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .accessMode(IResolvable)
//  .accessMode(AccessModeProperty)
//  .availabilityMode(java.lang.String)
//  .availabilityMode(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .eipBindMode(java.lang.String)
//  .eipBindMode(IResolvable)
//  .icmpReplyEnabled(java.lang.Boolean)
//  .icmpReplyEnabled(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .ipv4Prefix(java.lang.String)
//  .ipv4Prefix(IResolvable)
//  .natGatewayName(java.lang.String)
//  .natGatewayName(IResolvable)
//  .natIp(java.lang.String)
//  .natIp(IResolvable)
//  .natType(java.lang.String)
//  .natType(IResolvable)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .privateLinkEnabled(java.lang.Boolean)
//  .privateLinkEnabled(IResolvable)
//  .securityProtectionEnabled(java.lang.Boolean)
//  .securityProtectionEnabled(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id to create NAT gateway.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The VSwitch id to create NAT gateway.
accessMode com.aliyun.ros.cdk.core.IResolvable OR AccessModeProperty Property accessMode: Reverse access mode to the VPC NAT gateway.
availabilityMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property availabilityMode: The availability mode of the NAT gateway.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether force delete the relative snat and dnat entries in the net gateway and unbind eips.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Whether to enable deletion protection.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the NAT gateway, [2, 256] characters.
eipBindMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property eipBindMode: The mode in which the EIP is associated with the NAT gateway.
icmpReplyEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property icmpReplyEnabled: Specifies whether to enable the ICMP non-retrieval feature.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The billing method.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: The billing method for the NAT gateway.
ipv4Prefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipv4Prefix: The IPv4 prefix.
natGatewayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property natGatewayName: Display name of the NAT gateway, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
natIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property natIp: The NAT IP address.
natType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property natType: The type of the NAT gateway.
networkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkType: The type of the created NAT gateway.
privateLinkEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property privateLinkEnabled: Whether to support private network connection.
securityProtectionEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property securityProtectionEnabled: Specifies whether to enable the firewall feature.
tags java.util.List<TagsProperty> Property tags: Tags to attach to natgateway.

vpcIdRequired

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id to create NAT gateway.


vSwitchIdRequired

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The VSwitch id to create NAT gateway.


accessModeOptional

public java.lang.Object getAccessMode();

Property accessMode: Reverse access mode to the VPC NAT gateway.


availabilityModeOptional

public java.lang.Object getAvailabilityMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property availabilityMode: The availability mode of the NAT gateway.

Valid values: CrossAZ, SingleAZ


deletionForceOptional

public java.lang.Object getDeletionForce();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionForce: Whether force delete the relative snat and dnat entries in the net gateway and unbind eips.

Default value is false.


deletionProtectionOptional

public java.lang.Object getDeletionProtection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

Default to False.


descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Description of the NAT gateway, [2, 256] characters.

Do not fill or empty, the default is empty.


eipBindModeOptional

public java.lang.Object getEipBindMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property eipBindMode: The mode in which the EIP is associated with the NAT gateway.

Valid values:MULTI_BINDED (default): the multi-EIP-to-ENI mode. NAT: NAT mode. IPv4 gateways are supported. Note If the EIP is associated with the NAT gateway in NAT mode, the EIP occupies a private IP address of the vSwitch to which the NAT gateway belongs. Make sure that the vSwitch has sufficient private IP addresses. Otherwise, the EIP cannot be associated with the NAT gateway. In NAT mode, a maximum number of 50 EIPs can be associated with each NAT gateway.


icmpReplyEnabledOptional

public java.lang.Object getIcmpReplyEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property icmpReplyEnabled: Specifies whether to enable the ICMP non-retrieval feature.

Default: True


instanceChargeTypeOptional

public java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: The billing method.

The default value is PostPaid (which means pay-as-you-go).


internetChargeTypeOptional

public java.lang.Object getInternetChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property internetChargeType: The billing method for the NAT gateway.

Valid values: PayBySpec: billed on a pay-by-specification basis.


ipv4PrefixOptional

public java.lang.Object getIpv4Prefix();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ipv4Prefix: The IPv4 prefix.


natGatewayNameOptional

public java.lang.Object getNatGatewayName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property natGatewayName: Display name of the NAT gateway, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.


natIpOptional

public java.lang.Object getNatIp();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property natIp: The NAT IP address.


natTypeOptional

public java.lang.Object getNatType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property natType: The type of the NAT gateway.

Valid values:

  • Enhanced: enhanced NAT gateway.

networkTypeOptional

public java.lang.Object getNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: The type of the created NAT gateway.

Internet: public network NAT gateway. Intranet: VPC NAT gateway.


privateLinkEnabledOptional

public java.lang.Object getPrivateLinkEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property privateLinkEnabled: Whether to support private network connection.


securityProtectionEnabledOptional

public java.lang.Object getSecurityProtectionEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property securityProtectionEnabled: Specifies whether to enable the firewall feature.

Default: False


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to natgateway.

Max support 20 tags to add during create natgateway. Each tag with two properties Key and Value, and Key is required.