Package software.amazon.awssdk.services.ec2.model

Class CreateLocalGatewayVirtualInterfaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateLocalGatewayVirtualInterfaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLocalGatewayVirtualInterfaceRequest.Builder,CreateLocalGatewayVirtualInterfaceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateLocalGatewayVirtualInterfaceRequest
extends Ec2Request
implements ToCopyableBuilder<CreateLocalGatewayVirtualInterfaceRequest.Builder,CreateLocalGatewayVirtualInterfaceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLocalGatewayVirtualInterfaceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateLocalGatewayVirtualInterfaceRequest.Builder	builder()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
String	localAddress()	The IP address assigned to the local gateway virtual interface on the Outpost side.
String	localGatewayVirtualInterfaceGroupId()	The ID of the local gateway virtual interface group.
String	outpostLagId()	References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
String	peerAddress()	The peer IP address for the local gateway virtual interface.
Integer	peerBgpAsn()	The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
Long	peerBgpAsnExtended()	The extended 32-bit ASN of the BGP peer for use with larger ASN values.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLocalGatewayVirtualInterfaceRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	The tags to apply to a resource when the local gateway virtual interface is being created.
CreateLocalGatewayVirtualInterfaceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	vlan()	The virtual local area network (VLAN) used for the local gateway virtual interface.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

localGatewayVirtualInterfaceGroupId

public final String localGatewayVirtualInterfaceGroupId()

The ID of the local gateway virtual interface group.

Returns:

The ID of the local gateway virtual interface group.

outpostLagId

public final String outpostLagId()

References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.

Returns:

References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.

vlan

public final Integer vlan()

The virtual local area network (VLAN) used for the local gateway virtual interface.

Returns:

The virtual local area network (VLAN) used for the local gateway virtual interface.

localAddress

public final String localAddress()

The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.

Returns:

The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.

peerAddress

public final String peerAddress()

The peer IP address for the local gateway virtual interface. Only IPv4 is supported.

Returns:

The peer IP address for the local gateway virtual interface. Only IPv4 is supported.

peerBgpAsn

public final Integer peerBgpAsn()

The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.

Returns:

The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications 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.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to apply to a resource when the local gateway virtual interface is being created.

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 hasTagSpecifications() method.

Returns:

The tags to apply to a resource when the local gateway virtual interface is being created.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

peerBgpAsnExtended

public final Long peerBgpAsnExtended()

The extended 32-bit ASN of the BGP peer for use with larger ASN values.

Returns:

The extended 32-bit ASN of the BGP peer for use with larger ASN values.

toBuilder

public CreateLocalGatewayVirtualInterfaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLocalGatewayVirtualInterfaceRequest.Builder,CreateLocalGatewayVirtualInterfaceRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateLocalGatewayVirtualInterfaceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo