Skip to main content

NatGatewaySchema

The NatGatewaySchema class is the schema for the NatGateway resource, which represents the AWS VPC NAT Gateway resource. This resource can create a nat gateway in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/NatGateway

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format nat-gateway-<subnet-id>

Hierarchy

  • BaseResourceSchema
    • NatGatewaySchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; ConnectivityType: public } = ...

Input properties.

  • properties.awsAccountId - The AWS account id.
  • properties.awsRegionId - The AWS region id.
  • properties.ConnectivityType - The connectivity type. Possible values are public.

Type declaration

  • awsAccountId: string
  • awsRegionId: string
  • ConnectivityType: public

inheritedresourceId

resourceId: string

response

response: { AllocationId?: string; NatGatewayArn?: string; NatGatewayId?: string } = ...

Saved response.

  • response.AllocationId - The allocation id representing relationship between nat gateway and subnet.
  • response.NatGatewayArn - The nat gateway arn.
  • response.NatGatewayId - The nat gateway id.

Type declaration

  • optionalAllocationId?: string
  • optionalNatGatewayArn?: string
  • optionalNatGatewayId?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options