Skip to content

NatGateway

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::NatGateway.

Initializers 

import com.aliyun.ros.cdk.vpc.datasource.NatGateway;
NatGateway.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .natGatewayId(java.lang.String)
    .natGatewayId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
natGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property natGatewayId: The ID of the NAT gateway.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

natGatewayIdRequired

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

Property natGatewayId: The ID of the NAT gateway.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.vpc.datasource.NatGateway;
NatGateway.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.
attrAutoPay com.aliyun.ros.cdk.core.IResolvable Attribute AutoPay: Indicates whether automatic payment is enabled.
attrBusinessStatus com.aliyun.ros.cdk.core.IResolvable Attribute BusinessStatus: The status of the NAT gateway.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the NAT gateway was created.
attrDeletionProtection com.aliyun.ros.cdk.core.IResolvable Attribute DeletionProtection: Indicates whether the deletion protection feature is enabled.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the NAT gateway.
attrEipBindMode com.aliyun.ros.cdk.core.IResolvable Attribute EipBindMode: The mode in which the NAT gateway is associated with an elastic IP address (EIP).
attrExpiredTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpiredTime: The time when the NAT gateway expires.
attrForwardTableIds com.aliyun.ros.cdk.core.IResolvable Attribute ForwardTableIds: The ID of the Destination Network Address Translation (DNAT) table.
attrIcmpReplyEnabled com.aliyun.ros.cdk.core.IResolvable Attribute IcmpReplyEnabled: Indicates whether the ICMP non-retrieval feature is enabled.
attrInternetChargeType com.aliyun.ros.cdk.core.IResolvable Attribute InternetChargeType: The metering method of the NAT gateway.
attrIpLists com.aliyun.ros.cdk.core.IResolvable Attribute IpLists: The list of elastic IP addresses (EIPs) that are associated with the Internet NAT gateway.
attrNatGatewayId com.aliyun.ros.cdk.core.IResolvable Attribute NatGatewayId: The ID of the NAT gateway.
attrNatGatewayName com.aliyun.ros.cdk.core.IResolvable Attribute NatGatewayName: The name of the NAT gateway.
attrNatGatewayPrivateInfo com.aliyun.ros.cdk.core.IResolvable Attribute NatGatewayPrivateInfo: The private network information about the enhanced Internet NAT gateway.
attrNatType com.aliyun.ros.cdk.core.IResolvable Attribute NatType: The type of the NAT gateway.
attrNetworkType com.aliyun.ros.cdk.core.IResolvable Attribute NetworkType: The type of NAT gateway.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The billing method of the NAT gateway.
attrSecurityProtectionEnabled com.aliyun.ros.cdk.core.IResolvable Attribute SecurityProtectionEnabled: Indicates whether the firewall feature is enabled.
attrSnatTableIds com.aliyun.ros.cdk.core.IResolvable Attribute SnatTableIds: The ID of the SNAT table of the NAT gateway.
attrSpec com.aliyun.ros.cdk.core.IResolvable Attribute Spec: The size of the NAT gateway.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The ID of the VPC where the NAT gateway is deployed.

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

attrAutoPayRequired 

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

Attribute AutoPay: Indicates whether automatic payment is enabled.

Valid values: false: no true: yes

attrBusinessStatusRequired 

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

Attribute BusinessStatus: The status of the NAT gateway.

Valid values: Normal: normal FinancialLocked: locked due to overdue payments

attrCreateTimeRequired 

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

Attribute CreateTime: The time when the NAT gateway was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attrDeletionProtectionRequired 

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

Attribute DeletionProtection: Indicates whether the deletion protection feature is enabled.

Valid values: true: yes false: no

attrDescriptionRequired 

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

Attribute Description: The description of the NAT gateway.

attrEipBindModeRequired 

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

Attribute EipBindMode: The mode in which the NAT gateway is associated with an elastic IP address (EIP).

Valid values: MULTI_BINDED: multi-EIP-to-ENI mode* NAT: NAT mode, which is compatible with IPv4 addresses.

attrExpiredTimeRequired 

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

Attribute ExpiredTime: The time when the NAT gateway expires.

attrForwardTableIdsRequired 

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

Attribute ForwardTableIds: The ID of the Destination Network Address Translation (DNAT) table.

attrIcmpReplyEnabledRequired 

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

Attribute IcmpReplyEnabled: Indicates whether the ICMP non-retrieval feature is enabled.

Valid values: true: yes false: no

attrInternetChargeTypeRequired 

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

Attribute InternetChargeType: The metering method of the NAT gateway.

Valid values: PayBySpec: pay-by-specification PayByLcu: pay-by-CU

attrIpListsRequired 

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

Attribute IpLists: The list of elastic IP addresses (EIPs) that are associated with the Internet NAT gateway.

attrNatGatewayIdRequired 

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

Attribute NatGatewayId: The ID of the NAT gateway.

attrNatGatewayNameRequired 

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

Attribute NatGatewayName: The name of the NAT gateway.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://. If this parameter is not set, the system automatically assigns a name to the NAT gateway.

attrNatGatewayPrivateInfoRequired 

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

Attribute NatGatewayPrivateInfo: The private network information about the enhanced Internet NAT gateway.

attrNatTypeRequired 

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

Attribute NatType: The type of the NAT gateway.

The value is set to Enhanced (enhanced NAT gateway).

attrNetworkTypeRequired 

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

Attribute NetworkType: The type of NAT gateway.

Valid values: internet: an Internet NAT gateway intranet: a VPC NAT gateway

attrPaymentTypeRequired 

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

Attribute PaymentType: The billing method of the NAT gateway.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

attrSecurityProtectionEnabledRequired 

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

Attribute SecurityProtectionEnabled: Indicates whether the firewall feature is enabled.

Valid values: false: no true: yes

attrSnatTableIdsRequired 

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

Attribute SnatTableIds: The ID of the SNAT table of the NAT gateway.

attrSpecRequired 

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

Attribute Spec: The size of the NAT gateway.

An empty value is returned for the parameter. If InternetChargeType is set to PayByLcu, an empty value is returned.

attrVpcIdRequired 

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

Attribute VpcId: The ID of the VPC where the NAT gateway is deployed.