Type Alias CreateGatewayNetworkRequest

CreateGatewayNetworkRequest: {
    address?: string;
    dhcp?: CreateDHCPRequest;
    dhcpId?: string;
    enableDhcp?: boolean;
    enableMasquerade: boolean;
    gatewayId: string;
    ipamConfig?: CreateGatewayNetworkRequestIpamConfig;
    privateNetworkId: string;
    zone?: Zone;
}

Type declaration

  • Optionaladdress?: string

    Static IP address in CIDR format to to use without DHCP.

    One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set.

  • Optionaldhcp?: CreateDHCPRequest

    New DHCP configuration object to use for this GatewayNetwork.

    One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set.

  • OptionaldhcpId?: string

    ID of an existing DHCP configuration object to use for this GatewayNetwork.

    One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set.

  • OptionalenableDhcp?: boolean

    Defaults to true if either dhcp_id or dhcp are present. If set to true, either dhcp_id or dhcp must be present. Note: this setting is ignored when passing ipam_config.

  • enableMasquerade: boolean

    Note: this setting is ignored when passing ipam_config.

  • gatewayId: string

    Public Gateway to connect.

  • OptionalipamConfig?: CreateGatewayNetworkRequestIpamConfig

    Note: all or none of the GatewayNetworks for a single gateway can use the IPAM. DHCP and IPAM configurations cannot be mixed. Some products may require that the Public Gateway uses the IPAM, to ensure correct functionality.

    One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set.

  • privateNetworkId: string

    Private Network to connect.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings