software.amazon.awssdk.services.ec2.model

Class ScheduledInstancesNetworkInterface

java.lang.Object

software.amazon.awssdk.services.ec2.model.ScheduledInstancesNetworkInterface

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduledInstancesNetworkInterface.Builder,ScheduledInstancesNetworkInterface>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScheduledInstancesNetworkInterface
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledInstancesNetworkInterface.Builder,ScheduledInstancesNetworkInterface>

Describes a network interface for a Scheduled Instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScheduledInstancesNetworkInterface.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	associatePublicIpAddress() Indicates whether to assign a public IPv4 address to instances launched in a VPC.
static ScheduledInstancesNetworkInterface.Builder	builder()
Boolean	deleteOnTermination() Indicates whether to delete the interface when the instance is terminated.
String	description() The description.
Integer	deviceIndex() The index of the device for the network interface attachment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groups() The IDs of the security groups.
boolean	hasGroups() For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
boolean	hasIpv6Addresses() For responses, this returns true if the service returned a value for the Ipv6Addresses property.
boolean	hasPrivateIpAddressConfigs() For responses, this returns true if the service returned a value for the PrivateIpAddressConfigs property.
Integer	ipv6AddressCount() The number of IPv6 addresses to assign to the network interface.
List<ScheduledInstancesIpv6Address>	ipv6Addresses() The specific IPv6 addresses from the subnet range.
String	networkInterfaceId() The ID of the network interface.
String	privateIpAddress() The IPv4 address of the network interface within the subnet.
List<ScheduledInstancesPrivateIpAddressConfig>	privateIpAddressConfigs() The private IPv4 addresses.
List<SdkField<?>>	sdkFields()
Integer	secondaryPrivateIpAddressCount() The number of secondary private IPv4 addresses.
static Class<? extends ScheduledInstancesNetworkInterface.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet.
ScheduledInstancesNetworkInterface.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

associatePublicIpAddress

public final Boolean associatePublicIpAddress()

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Returns:

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

deleteOnTermination

public final Boolean deleteOnTermination()

Indicates whether to delete the interface when the instance is terminated.

Returns:

Indicates whether to delete the interface when the instance is terminated.

description

public final String description()

The description.

Returns:

The description.

deviceIndex

public final Integer deviceIndex()

The index of the device for the network interface attachment.

Returns:

The index of the device for the network interface attachment.

hasGroups

public final boolean hasGroups()

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

groups

public final List<String> groups()

The IDs of the security groups.

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

Returns:

The IDs of the security groups.

ipv6AddressCount

public final Integer ipv6AddressCount()

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

Returns:

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

hasIpv6Addresses

public final boolean hasIpv6Addresses()

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

ipv6Addresses

public final List<ScheduledInstancesIpv6Address> ipv6Addresses()

The specific IPv6 addresses from the subnet range.

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

Returns:

The specific IPv6 addresses from the subnet range.

networkInterfaceId

public final String networkInterfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

privateIpAddress

public final String privateIpAddress()

The IPv4 address of the network interface within the subnet.

Returns:

The IPv4 address of the network interface within the subnet.

hasPrivateIpAddressConfigs

public final boolean hasPrivateIpAddressConfigs()

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

privateIpAddressConfigs

public final List<ScheduledInstancesPrivateIpAddressConfig> privateIpAddressConfigs()

The private IPv4 addresses.

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

Returns:

The private IPv4 addresses.

secondaryPrivateIpAddressCount

public final Integer secondaryPrivateIpAddressCount()

The number of secondary private IPv4 addresses.

Returns:

The number of secondary private IPv4 addresses.

subnetId

public final String subnetId()

The ID of the subnet.

Returns:

The ID of the subnet.

toBuilder

public ScheduledInstancesNetworkInterface.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledInstancesNetworkInterface.Builder,ScheduledInstancesNetworkInterface>

builder

public static ScheduledInstancesNetworkInterface.Builder builder()

serializableBuilderClass

public static Class<? extends ScheduledInstancesNetworkInterface.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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo