Class Lag

java.lang.Object
software.amazon.awssdk.services.directconnect.model.Lag
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Lag.Builder,Lag>
@Generated("software.amazon.awssdk:codegen") public final class Lag extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Lag.Builder,Lag>

Information about a link aggregation group (LAG).

See Also:

  • Method Details

    • connectionsBandwidth

      public final String connectionsBandwidth()

      The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

      Returns:
      The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

    • numberOfConnections

      public final Integer numberOfConnections()

      The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

      Returns:
      The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

    • lagId

      public final String lagId()

      The ID of the LAG.

      Returns:
      The ID of the LAG.

    • ownerAccount

      public final String ownerAccount()

      The ID of the Amazon Web Services account that owns the LAG.

      Returns:
      The ID of the Amazon Web Services account that owns the LAG.

    • lagName

      public final String lagName()

      The name of the LAG.

      Returns:
      The name of the LAG.

    • lagState

      public final LagState lagState()

      The state of the LAG. The following are the possible values:

      • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

      • pending: The LAG has been approved and is being initialized.

      • available: The network link is established and the LAG is ready for use.

      • down: The network link is down.

      • deleting: The LAG is being deleted.

      • deleted: The LAG is deleted.

      • unknown: The state of the LAG is not available.

      If the service returns an enum value that is not available in the current SDK version, lagState will return LagState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lagStateAsString().

      Returns:
      The state of the LAG. The following are the possible values:

      • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

      • pending: The LAG has been approved and is being initialized.

      • available: The network link is established and the LAG is ready for use.

      • down: The network link is down.

      • deleting: The LAG is being deleted.

      • deleted: The LAG is deleted.

      • unknown: The state of the LAG is not available.

      See Also:

    • lagStateAsString

      public final String lagStateAsString()

      The state of the LAG. The following are the possible values:

      • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

      • pending: The LAG has been approved and is being initialized.

      • available: The network link is established and the LAG is ready for use.

      • down: The network link is down.

      • deleting: The LAG is being deleted.

      • deleted: The LAG is deleted.

      • unknown: The state of the LAG is not available.

      If the service returns an enum value that is not available in the current SDK version, lagState will return LagState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lagStateAsString().

      Returns:
      The state of the LAG. The following are the possible values:

      • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

      • pending: The LAG has been approved and is being initialized.

      • available: The network link is established and the LAG is ready for use.

      • down: The network link is down.

      • deleting: The LAG is being deleted.

      • deleted: The LAG is deleted.

      • unknown: The state of the LAG is not available.

      See Also:

    • location

      public final String location()

      The location of the LAG.

      Returns:
      The location of the LAG.

    • region

      public final String region()

      The Amazon Web Services Region where the connection is located.

      Returns:
      The Amazon Web Services Region where the connection is located.

    • minimumLinks

      public final Integer minimumLinks()

      The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

      Returns:
      The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

    • awsDevice

      public final String awsDevice()

      The Direct Connect endpoint that hosts the LAG.

      Returns:
      The Direct Connect endpoint that hosts the LAG.

    • awsDeviceV2

      public final String awsDeviceV2()

      The Direct Connect endpoint that hosts the LAG.

      Returns:
      The Direct Connect endpoint that hosts the LAG.

    • awsLogicalDeviceId

      public final String awsLogicalDeviceId()

      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      Returns:
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

    • hasConnections

      public final boolean hasConnections()
      For responses, this returns true if the service returned a value for the Connections property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • connections

      public final List<Connection> connections()

      The connections bundled by the LAG.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnections() method.

      Returns:
      The connections bundled by the LAG.

    • allowsHostedConnections

      public final Boolean allowsHostedConnections()

      Indicates whether the LAG can host other connections.

      Returns:
      Indicates whether the LAG can host other connections.

    • jumboFrameCapable

      public final Boolean jumboFrameCapable()

      Indicates whether jumbo frames are supported.

      Returns:
      Indicates whether jumbo frames are supported.

    • hasLogicalRedundancy

      public final HasLogicalRedundancy hasLogicalRedundancy()

      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

      If the service returns an enum value that is not available in the current SDK version, hasLogicalRedundancy will return HasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hasLogicalRedundancyAsString().

      Returns:
      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
      See Also:

    • hasLogicalRedundancyAsString

      public final String hasLogicalRedundancyAsString()

      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

      If the service returns an enum value that is not available in the current SDK version, hasLogicalRedundancy will return HasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hasLogicalRedundancyAsString().

      Returns:
      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags associated with the LAG.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags associated with the LAG.

    • providerName

      public final String providerName()

      The name of the service provider associated with the LAG.

      Returns:
      The name of the service provider associated with the LAG.

    • macSecCapable

      public final Boolean macSecCapable()

      Indicates whether the LAG supports MAC Security (MACsec).

      Returns:
      Indicates whether the LAG supports MAC Security (MACsec).

    • encryptionMode

      public final String encryptionMode()

      The LAG MAC Security (MACsec) encryption mode.

      The valid values are no_encrypt, should_encrypt, and must_encrypt.

      Returns:
      The LAG MAC Security (MACsec) encryption mode.

      The valid values are no_encrypt, should_encrypt, and must_encrypt.

    • hasMacSecKeys

      public final boolean hasMacSecKeys()
      For responses, this returns true if the service returned a value for the MacSecKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • macSecKeys

      public final List<MacSecKey> macSecKeys()

      The MAC Security (MACsec) security keys associated with the LAG.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMacSecKeys() method.

      Returns:
      The MAC Security (MACsec) security keys associated with the LAG.

    • toBuilder

      public Lag.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Lag.Builder,Lag>
      Returns:
      a builder for type T

    • builder

      public static Lag.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Lag.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.