{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.DirectConnect.Types.NewPublicVirtualInterfaceAllocation -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) module Amazonka.DirectConnect.Types.NewPublicVirtualInterfaceAllocation where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.DirectConnect.Types.AddressFamily import Amazonka.DirectConnect.Types.RouteFilterPrefix import Amazonka.DirectConnect.Types.Tag import qualified Amazonka.Prelude as Prelude -- | Information about a public virtual interface to be provisioned on a -- connection. -- -- /See:/ 'newNewPublicVirtualInterfaceAllocation' smart constructor. data NewPublicVirtualInterfaceAllocation = NewPublicVirtualInterfaceAllocation' { -- | The address family for the BGP peer. addressFamily :: Prelude.Maybe AddressFamily, -- | The IP address assigned to the Amazon interface. amazonAddress :: Prelude.Maybe Prelude.Text, -- | The authentication key for BGP configuration. This string has a minimum -- length of 6 characters and and a maximun lenth of 80 characters. authKey :: Prelude.Maybe Prelude.Text, -- | The IP address assigned to the customer interface. customerAddress :: Prelude.Maybe Prelude.Text, -- | The routes to be advertised to the Amazon Web Services network in this -- Region. Applies to public virtual interfaces. routeFilterPrefixes :: Prelude.Maybe [RouteFilterPrefix], -- | The tags associated with the public virtual interface. tags :: Prelude.Maybe (Prelude.NonEmpty Tag), -- | The name of the virtual interface assigned by the customer network. The -- name has a maximum of 100 characters. The following are valid -- characters: a-z, 0-9 and a hyphen (-). virtualInterfaceName :: Prelude.Text, -- | The ID of the VLAN. vlan :: Prelude.Int, -- | The autonomous system (AS) number for Border Gateway Protocol (BGP) -- configuration. -- -- The valid values are 1-2147483647. asn :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'NewPublicVirtualInterfaceAllocation' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'addressFamily', 'newPublicVirtualInterfaceAllocation_addressFamily' - The address family for the BGP peer. -- -- 'amazonAddress', 'newPublicVirtualInterfaceAllocation_amazonAddress' - The IP address assigned to the Amazon interface. -- -- 'authKey', 'newPublicVirtualInterfaceAllocation_authKey' - The authentication key for BGP configuration. This string has a minimum -- length of 6 characters and and a maximun lenth of 80 characters. -- -- 'customerAddress', 'newPublicVirtualInterfaceAllocation_customerAddress' - The IP address assigned to the customer interface. -- -- 'routeFilterPrefixes', 'newPublicVirtualInterfaceAllocation_routeFilterPrefixes' - The routes to be advertised to the Amazon Web Services network in this -- Region. Applies to public virtual interfaces. -- -- 'tags', 'newPublicVirtualInterfaceAllocation_tags' - The tags associated with the public virtual interface. -- -- 'virtualInterfaceName', 'newPublicVirtualInterfaceAllocation_virtualInterfaceName' - The name of the virtual interface assigned by the customer network. The -- name has a maximum of 100 characters. The following are valid -- characters: a-z, 0-9 and a hyphen (-). -- -- 'vlan', 'newPublicVirtualInterfaceAllocation_vlan' - The ID of the VLAN. -- -- 'asn', 'newPublicVirtualInterfaceAllocation_asn' - The autonomous system (AS) number for Border Gateway Protocol (BGP) -- configuration. -- -- The valid values are 1-2147483647. newNewPublicVirtualInterfaceAllocation :: -- | 'virtualInterfaceName' Prelude.Text -> -- | 'vlan' Prelude.Int -> -- | 'asn' Prelude.Int -> NewPublicVirtualInterfaceAllocation newNewPublicVirtualInterfaceAllocation pVirtualInterfaceName_ pVlan_ pAsn_ = NewPublicVirtualInterfaceAllocation' { addressFamily = Prelude.Nothing, amazonAddress = Prelude.Nothing, authKey = Prelude.Nothing, customerAddress = Prelude.Nothing, routeFilterPrefixes = Prelude.Nothing, tags = Prelude.Nothing, virtualInterfaceName = pVirtualInterfaceName_, vlan = pVlan_, asn = pAsn_ } -- | The address family for the BGP peer. newPublicVirtualInterfaceAllocation_addressFamily :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe AddressFamily) newPublicVirtualInterfaceAllocation_addressFamily = Lens.lens (\NewPublicVirtualInterfaceAllocation' {addressFamily} -> addressFamily) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {addressFamily = a} :: NewPublicVirtualInterfaceAllocation) -- | The IP address assigned to the Amazon interface. newPublicVirtualInterfaceAllocation_amazonAddress :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe Prelude.Text) newPublicVirtualInterfaceAllocation_amazonAddress = Lens.lens (\NewPublicVirtualInterfaceAllocation' {amazonAddress} -> amazonAddress) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {amazonAddress = a} :: NewPublicVirtualInterfaceAllocation) -- | The authentication key for BGP configuration. This string has a minimum -- length of 6 characters and and a maximun lenth of 80 characters. newPublicVirtualInterfaceAllocation_authKey :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe Prelude.Text) newPublicVirtualInterfaceAllocation_authKey = Lens.lens (\NewPublicVirtualInterfaceAllocation' {authKey} -> authKey) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {authKey = a} :: NewPublicVirtualInterfaceAllocation) -- | The IP address assigned to the customer interface. newPublicVirtualInterfaceAllocation_customerAddress :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe Prelude.Text) newPublicVirtualInterfaceAllocation_customerAddress = Lens.lens (\NewPublicVirtualInterfaceAllocation' {customerAddress} -> customerAddress) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {customerAddress = a} :: NewPublicVirtualInterfaceAllocation) -- | The routes to be advertised to the Amazon Web Services network in this -- Region. Applies to public virtual interfaces. newPublicVirtualInterfaceAllocation_routeFilterPrefixes :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe [RouteFilterPrefix]) newPublicVirtualInterfaceAllocation_routeFilterPrefixes = Lens.lens (\NewPublicVirtualInterfaceAllocation' {routeFilterPrefixes} -> routeFilterPrefixes) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {routeFilterPrefixes = a} :: NewPublicVirtualInterfaceAllocation) Prelude.. Lens.mapping Lens.coerced -- | The tags associated with the public virtual interface. newPublicVirtualInterfaceAllocation_tags :: Lens.Lens' NewPublicVirtualInterfaceAllocation (Prelude.Maybe (Prelude.NonEmpty Tag)) newPublicVirtualInterfaceAllocation_tags = Lens.lens (\NewPublicVirtualInterfaceAllocation' {tags} -> tags) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {tags = a} :: NewPublicVirtualInterfaceAllocation) Prelude.. Lens.mapping Lens.coerced -- | The name of the virtual interface assigned by the customer network. The -- name has a maximum of 100 characters. The following are valid -- characters: a-z, 0-9 and a hyphen (-). newPublicVirtualInterfaceAllocation_virtualInterfaceName :: Lens.Lens' NewPublicVirtualInterfaceAllocation Prelude.Text newPublicVirtualInterfaceAllocation_virtualInterfaceName = Lens.lens (\NewPublicVirtualInterfaceAllocation' {virtualInterfaceName} -> virtualInterfaceName) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {virtualInterfaceName = a} :: NewPublicVirtualInterfaceAllocation) -- | The ID of the VLAN. newPublicVirtualInterfaceAllocation_vlan :: Lens.Lens' NewPublicVirtualInterfaceAllocation Prelude.Int newPublicVirtualInterfaceAllocation_vlan = Lens.lens (\NewPublicVirtualInterfaceAllocation' {vlan} -> vlan) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {vlan = a} :: NewPublicVirtualInterfaceAllocation) -- | The autonomous system (AS) number for Border Gateway Protocol (BGP) -- configuration. -- -- The valid values are 1-2147483647. newPublicVirtualInterfaceAllocation_asn :: Lens.Lens' NewPublicVirtualInterfaceAllocation Prelude.Int newPublicVirtualInterfaceAllocation_asn = Lens.lens (\NewPublicVirtualInterfaceAllocation' {asn} -> asn) (\s@NewPublicVirtualInterfaceAllocation' {} a -> s {asn = a} :: NewPublicVirtualInterfaceAllocation) instance Prelude.Hashable NewPublicVirtualInterfaceAllocation where hashWithSalt _salt NewPublicVirtualInterfaceAllocation' {..} = _salt `Prelude.hashWithSalt` addressFamily `Prelude.hashWithSalt` amazonAddress `Prelude.hashWithSalt` authKey `Prelude.hashWithSalt` customerAddress `Prelude.hashWithSalt` routeFilterPrefixes `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` virtualInterfaceName `Prelude.hashWithSalt` vlan `Prelude.hashWithSalt` asn instance Prelude.NFData NewPublicVirtualInterfaceAllocation where rnf NewPublicVirtualInterfaceAllocation' {..} = Prelude.rnf addressFamily `Prelude.seq` Prelude.rnf amazonAddress `Prelude.seq` Prelude.rnf authKey `Prelude.seq` Prelude.rnf customerAddress `Prelude.seq` Prelude.rnf routeFilterPrefixes `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf virtualInterfaceName `Prelude.seq` Prelude.rnf vlan `Prelude.seq` Prelude.rnf asn instance Data.ToJSON NewPublicVirtualInterfaceAllocation where toJSON NewPublicVirtualInterfaceAllocation' {..} = Data.object ( Prelude.catMaybes [ ("addressFamily" Data..=) Prelude.<$> addressFamily, ("amazonAddress" Data..=) Prelude.<$> amazonAddress, ("authKey" Data..=) Prelude.<$> authKey, ("customerAddress" Data..=) Prelude.<$> customerAddress, ("routeFilterPrefixes" Data..=) Prelude.<$> routeFilterPrefixes, ("tags" Data..=) Prelude.<$> tags, Prelude.Just ( "virtualInterfaceName" Data..= virtualInterfaceName ), Prelude.Just ("vlan" Data..= vlan), Prelude.Just ("asn" Data..= asn) ] )