Class DirectConnectGatewayAssociation
- java.lang.Object
-
- software.amazon.awssdk.services.directconnect.model.DirectConnectGatewayAssociation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DirectConnectGatewayAssociation.Builder,DirectConnectGatewayAssociation>
@Generated("software.amazon.awssdk:codegen") public final class DirectConnectGatewayAssociation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DirectConnectGatewayAssociation.Builder,DirectConnectGatewayAssociation>
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDirectConnectGatewayAssociation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<RouteFilterPrefix>allowedPrefixesToDirectConnectGateway()The Amazon VPC prefixes to advertise to the Direct Connect gateway.AssociatedGatewayassociatedGateway()Information about the associated gateway.StringassociationId()The ID of the Direct Connect gateway association.DirectConnectGatewayAssociationStateassociationState()The state of the association.StringassociationStateAsString()The state of the association.static DirectConnectGatewayAssociation.Builderbuilder()StringdirectConnectGatewayId()The ID of the Direct Connect gateway.StringdirectConnectGatewayOwnerAccount()The ID of the Amazon Web Services account that owns the associated gateway.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedPrefixesToDirectConnectGateway()For responses, this returns true if the service returned a value for the AllowedPrefixesToDirectConnectGateway property.inthashCode()List<SdkField<?>>sdkFields()static Class<? extends DirectConnectGatewayAssociation.Builder>serializableBuilderClass()StringstateChangeError()The error message if the state of an object failed to advance.DirectConnectGatewayAssociation.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvirtualGatewayId()The ID of the virtual private gateway.StringvirtualGatewayOwnerAccount()The ID of the Amazon Web Services account that owns the virtual private gateway.StringvirtualGatewayRegion()The Amazon Web Services Region where the virtual private gateway is located.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
directConnectGatewayId
public final String directConnectGatewayId()
The ID of the Direct Connect gateway.
- Returns:
- The ID of the Direct Connect gateway.
-
directConnectGatewayOwnerAccount
public final String directConnectGatewayOwnerAccount()
The ID of the Amazon Web Services account that owns the associated gateway.
- Returns:
- The ID of the Amazon Web Services account that owns the associated gateway.
-
associationState
public final DirectConnectGatewayAssociationState associationState()
The state of the association. The following are the possible values:
-
associating: The initial state after calling CreateDirectConnectGatewayAssociation. -
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic. -
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation. -
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped. -
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
If the service returns an enum value that is not available in the current SDK version,
associationStatewill returnDirectConnectGatewayAssociationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationStateAsString().- Returns:
- The state of the association. The following are the possible values:
-
associating: The initial state after calling CreateDirectConnectGatewayAssociation. -
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic. -
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation. -
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped. -
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
-
- See Also:
DirectConnectGatewayAssociationState
-
-
associationStateAsString
public final String associationStateAsString()
The state of the association. The following are the possible values:
-
associating: The initial state after calling CreateDirectConnectGatewayAssociation. -
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic. -
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation. -
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped. -
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
If the service returns an enum value that is not available in the current SDK version,
associationStatewill returnDirectConnectGatewayAssociationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationStateAsString().- Returns:
- The state of the association. The following are the possible values:
-
associating: The initial state after calling CreateDirectConnectGatewayAssociation. -
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic. -
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation. -
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped. -
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
-
- See Also:
DirectConnectGatewayAssociationState
-
-
stateChangeError
public final String stateChangeError()
The error message if the state of an object failed to advance.
- Returns:
- The error message if the state of an object failed to advance.
-
associatedGateway
public final AssociatedGateway associatedGateway()
Information about the associated gateway.
- Returns:
- Information about the associated gateway.
-
associationId
public final String associationId()
The ID of the Direct Connect gateway association.
- Returns:
- The ID of the Direct Connect gateway association.
-
hasAllowedPrefixesToDirectConnectGateway
public final boolean hasAllowedPrefixesToDirectConnectGateway()
For responses, this returns true if the service returned a value for the AllowedPrefixesToDirectConnectGateway property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
allowedPrefixesToDirectConnectGateway
public final List<RouteFilterPrefix> allowedPrefixesToDirectConnectGateway()
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
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
hasAllowedPrefixesToDirectConnectGateway()method.- Returns:
- The Amazon VPC prefixes to advertise to the Direct Connect gateway.
-
virtualGatewayId
public final String virtualGatewayId()
The ID of the virtual private gateway. Applies only to private virtual interfaces.
- Returns:
- The ID of the virtual private gateway. Applies only to private virtual interfaces.
-
virtualGatewayRegion
public final String virtualGatewayRegion()
The Amazon Web Services Region where the virtual private gateway is located.
- Returns:
- The Amazon Web Services Region where the virtual private gateway is located.
-
virtualGatewayOwnerAccount
public final String virtualGatewayOwnerAccount()
The ID of the Amazon Web Services account that owns the virtual private gateway.
- Returns:
- The ID of the Amazon Web Services account that owns the virtual private gateway.
-
toBuilder
public DirectConnectGatewayAssociation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DirectConnectGatewayAssociation.Builder,DirectConnectGatewayAssociation>
-
builder
public static DirectConnectGatewayAssociation.Builder builder()
-
serializableBuilderClass
public static Class<? extends DirectConnectGatewayAssociation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-