VirtualInterface

public struct VirtualInterface : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The address family for the BGP peer.

    Declaration

    Swift

    public let addressFamily: AddressFamily?

  • The IP address assigned to the Amazon interface.

    Declaration

    Swift

    public let amazonAddress: String?

  • The autonomous system number (ASN) for the Amazon side of the connection.

    Declaration

    Swift

    public let amazonSideAsn: Int64?
  • asn

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. The valid values are 1-2147483647.

    Declaration

    Swift

    public let asn: Int?

  • The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

    Declaration

    Swift

    public let authKey: String?

  • The Direct Connect endpoint on which the virtual interface terminates.

    Declaration

    Swift

    public let awsDeviceV2: String?

  • The BGP peers configured on this virtual interface.

    Declaration

    Swift

    public let bgpPeers: [BGPPeer]?

  • The ID of the connection.

    Declaration

    Swift

    public let connectionId: String?

  • The IP address assigned to the customer interface.

    Declaration

    Swift

    public let customerAddress: String?

  • The customer router configuration.

    Declaration

    Swift

    public let customerRouterConfig: String?

  • The ID of the Direct Connect gateway.

    Declaration

    Swift

    public let directConnectGatewayId: String?

  • Indicates whether jumbo frames (9001 MTU) are supported.

    Declaration

    Swift

    public let jumboFrameCapable: Bool?

  • The location of the connection.

    Declaration

    Swift

    public let location: String?
  • mtu

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

    Declaration

    Swift

    public let mtu: Int?

  • The ID of the AWS account that owns the virtual interface.

    Declaration

    Swift

    public let ownerAccount: String?

  • The AWS Region where the virtual interface is located.

    Declaration

    Swift

    public let region: String?

  • The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

    Declaration

    Swift

    public let routeFilterPrefixes: [RouteFilterPrefix]?

  • The tags associated with the virtual interface.

    Declaration

    Swift

    public let tags: [Tag]?

  • The ID of the virtual private gateway. Applies only to private virtual interfaces.

    Declaration

    Swift

    public let virtualGatewayId: String?

  • The ID of the virtual interface.

    Declaration

    Swift

    public let virtualInterfaceId: String?

  • 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 (-).

    Declaration

    Swift

    public let virtualInterfaceName: String?

  • The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available.

    Declaration

    Swift

    public let virtualInterfaceState: VirtualInterfaceState?

  • The type of virtual interface. The possible values are private and public.

    Declaration

    Swift

    public let virtualInterfaceType: String?

  • The ID of the VLAN.

    Declaration

    Swift

    public let vlan: Int?

  • Undocumented

    Declaration

    Swift

    public init(addressFamily: AddressFamily? = nil, amazonAddress: String? = nil, amazonSideAsn: Int64? = nil, asn: Int? = nil, authKey: String? = nil, awsDeviceV2: String? = nil, bgpPeers: [BGPPeer]? = nil, connectionId: String? = nil, customerAddress: String? = nil, customerRouterConfig: String? = nil, directConnectGatewayId: String? = nil, jumboFrameCapable: Bool? = nil, location: String? = nil, mtu: Int? = nil, ownerAccount: String? = nil, region: String? = nil, routeFilterPrefixes: [RouteFilterPrefix]? = nil, tags: [Tag]? = nil, virtualGatewayId: String? = nil, virtualInterfaceId: String? = nil, virtualInterfaceName: String? = nil, virtualInterfaceState: VirtualInterfaceState? = nil, virtualInterfaceType: String? = nil, vlan: Int? = nil)