software.amazon.awssdk.services.globalaccelerator.model

Class CustomRoutingAccelerator

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.CustomRoutingAccelerator

All Implemented Interfaces:

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

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

Attributes of a custom routing accelerator.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomRoutingAccelerator.Builder

Method Summary

Modifier and Type	Method and Description
String	acceleratorArn() The Amazon Resource Name (ARN) of the custom routing accelerator.
static CustomRoutingAccelerator.Builder	builder()
Instant	createdTime() The date and time that the accelerator was created.
String	dnsName() The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
Boolean	enabled() Indicates whether the accelerator is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpSets() For responses, this returns true if the service returned a value for the IpSets property.
IpAddressType	ipAddressType() The IP address type that an accelerator supports.
String	ipAddressTypeAsString() The IP address type that an accelerator supports.
List<IpSet>	ipSets() The static IP addresses that Global Accelerator associates with the accelerator.
Instant	lastModifiedTime() The date and time that the accelerator was last modified.
String	name() The name of the accelerator.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomRoutingAccelerator.Builder>	serializableBuilderClass()
CustomRoutingAcceleratorStatus	status() Describes the deployment status of the accelerator.
String	statusAsString() Describes the deployment status of the accelerator.
CustomRoutingAccelerator.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

acceleratorArn

public final String acceleratorArn()

The Amazon Resource Name (ARN) of the custom routing accelerator.

Returns:

The Amazon Resource Name (ARN) of the custom routing accelerator.

name

public final String name()

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

Returns:

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

ipAddressType

public final IpAddressType ipAddressType()

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

Returns:

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

See Also:

IpAddressType

ipAddressTypeAsString

public final String ipAddressTypeAsString()

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

Returns:

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

See Also:

IpAddressType

enabled

public final Boolean enabled()

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

Returns:

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

hasIpSets

public final boolean hasIpSets()

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

ipSets

public final List<IpSet> ipSets()

The static IP addresses that Global Accelerator associates with the accelerator.

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

Returns:

The static IP addresses that Global Accelerator associates with the accelerator.

dnsName

public final String dnsName()

The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

Returns:

The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

status

public final CustomRoutingAcceleratorStatus status()

Describes the deployment status of the accelerator.

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

Returns:

Describes the deployment status of the accelerator.

See Also:

CustomRoutingAcceleratorStatus

statusAsString

public final String statusAsString()

Describes the deployment status of the accelerator.

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

Returns:

Describes the deployment status of the accelerator.

See Also:

CustomRoutingAcceleratorStatus

createdTime

public final Instant createdTime()

The date and time that the accelerator was created.

Returns:

The date and time that the accelerator was created.

lastModifiedTime

public final Instant lastModifiedTime()

The date and time that the accelerator was last modified.

Returns:

The date and time that the accelerator was last modified.

toBuilder

public CustomRoutingAccelerator.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomRoutingAccelerator.Builder,CustomRoutingAccelerator>

builder

public static CustomRoutingAccelerator.Builder builder()

serializableBuilderClass

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