NatGateway

• Implements: @alicloud/ros-cdk-vpc.datasource.INatGateway

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

Initializers

import { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.NatGateway(scope: Construct, id: string, props: NatGatewayProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: NatGatewayProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

session^Required

• Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.NatGateway.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/ros-cdk-core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAutoPay^Required

public readonly attrAutoPay: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoPay: Indicates whether automatic payment is enabled.

Valid values: false: no true: yes

attrBusinessStatus^Required

public readonly attrBusinessStatus: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BusinessStatus: The status of the NAT gateway.

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

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/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.

attrDeletionProtection^Required

public readonly attrDeletionProtection: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: true: yes false: no

attrDescription^Required

public readonly attrDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the NAT gateway.

attrEipBindMode^Required

public readonly attrEipBindMode: string | IResolvable;

• Type: string | @alicloud/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.

attrExpiredTime^Required

public readonly attrExpiredTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: The time when the NAT gateway expires.

attrForwardTableIds^Required

public readonly attrForwardTableIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrIcmpReplyEnabled^Required

public readonly attrIcmpReplyEnabled: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: true: yes false: no

attrInternetChargeType^Required

public readonly attrInternetChargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InternetChargeType: The metering method of the NAT gateway.

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

attrIpLists^Required

public readonly attrIpLists: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrNatGatewayId^Required

public readonly attrNatGatewayId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute NatGatewayId: The ID of the NAT gateway.

attrNatGatewayName^Required

public readonly attrNatGatewayName: string | IResolvable;

• Type: string | @alicloud/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.

attrNatGatewayPrivateInfo^Required

public readonly attrNatGatewayPrivateInfo: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrNatType^Required

public readonly attrNatType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute NatType: The type of the NAT gateway.

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

attrNetworkType^Required

public readonly attrNetworkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute NetworkType: The type of NAT gateway.

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

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The billing method of the NAT gateway.

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

attrSecurityProtectionEnabled^Required

public readonly attrSecurityProtectionEnabled: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SecurityProtectionEnabled: Indicates whether the firewall feature is enabled.

Valid values: false: no true: yes

attrSnatTableIds^Required

public readonly attrSnatTableIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrSpec^Required

public readonly attrSpec: string | IResolvable;

• Type: string | @alicloud/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.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

props^Required

public readonly props: NatGatewayProps;

• Type: NatGatewayProps