software.amazon.awscdk.services.appmesh

Enum IpPreference

java.lang.Object

java.lang.Enum<IpPreference>

software.amazon.awscdk.services.appmesh.IpPreference

All Implemented Interfaces:

Serializable, Comparable<IpPreference>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.565Z")
 @Stability(value=Stable)
public enum IpPreference
extends Enum<IpPreference>

Enum of supported IP preferences.

Used to dictate the IP version for mesh wide and virtual node service discovery. Also used to specify the IP version that a sidecar Envoy uses when sending traffic to a local application.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Mesh mesh = Mesh.Builder.create(this, "AppMesh")
         .meshName("myAwsMesh")
         .serviceDiscovery(MeshServiceDiscovery.builder()
                 .ipPreference(IpPreference.IPV4_ONLY)
                 .build())
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
IPV4_ONLY Use IPv4 when sending traffic to a local application.
IPV4_PREFERRED Use IPv4 when sending traffic to a local application.
IPV6_ONLY Use IPv6 when sending traffic to a local application.
IPV6_PREFERRED Use IPv6 when sending traffic to a local application.

Method Summary

Modifier and Type	Method and Description
static IpPreference	valueOf(String name) Returns the enum constant of this type with the specified name.
static IpPreference[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IPV4_ONLY

@Stability(value=Stable)
public static final IpPreference IPV4_ONLY

Use IPv4 when sending traffic to a local application.

Only use IPv4 for service discovery.

IPV4_PREFERRED

@Stability(value=Stable)
public static final IpPreference IPV4_PREFERRED

Use IPv4 when sending traffic to a local application.

First attempt to use IPv4 and fall back to IPv6 for service discovery.

IPV6_ONLY

@Stability(value=Stable)
public static final IpPreference IPV6_ONLY

Use IPv6 when sending traffic to a local application.

Only use IPv6 for service discovery.

IPV6_PREFERRED

@Stability(value=Stable)
public static final IpPreference IPV6_PREFERRED

Use IPv6 when sending traffic to a local application.

First attempt to use IPv6 and fall back to IPv4 for service discovery.

Method Detail

values

public static IpPreference[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IpPreference c : IpPreference.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IpPreference valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null