Accelerator (AWS Java SDK :: Services :: Global Accelerator 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.globalaccelerator.model.Accelerator

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Accelerator.Builder,Accelerator>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Accelerator
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Accelerator.Builder,Accelerator>
```
An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Accelerator.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Accelerator.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acceleratorArn()` The Amazon Resource Name (ARN) of the accelerator.
`static Accelerator.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.
`String`	`dualStackDnsName()` The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
`Boolean`	`enabled()` Indicates whether the accelerator is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<AcceleratorEvent>`	`events()` A history of changes that you make to an accelerator in Global Accelerator.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEvents()` For responses, this returns true if the service returned a value for the Events property.
`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 Accelerator.Builder>`	`serializableBuilderClass()`
`AcceleratorStatus`	`status()` Describes the deployment status of the accelerator.
`String`	`statusAsString()` Describes the deployment status of the accelerator.
`Accelerator.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 accelerator.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the 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 standard accelerator, the value can be IPV4 or DUAL_STACK.
    
    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 standard accelerator, the value can be IPV4 or DUAL_STACK.
    
    See Also:
    
    IpAddressType
  - ipAddressTypeAsString
```
public final String ipAddressTypeAsString()
```
    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
    
    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 standard accelerator, the value can be IPV4 or DUAL_STACK.
    
    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 for an accelerator 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 for an accelerator 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 AcceleratorStatus 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 AcceleratorStatus.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:
    
    AcceleratorStatus
  - 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 AcceleratorStatus.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:
    
    AcceleratorStatus
  - 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.
  - dualStackDnsName
```
public final String dualStackDnsName()
```
    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    
    The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.
    
    Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
    
    For more information, 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 a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
    
    The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.
    
    Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
    
    For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
  - hasEvents
```
public final boolean hasEvents()
```
    For responses, this returns true if the service returned a value for the Events 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.
  - events
```
public final List<AcceleratorEvent> events()
```
    A history of changes that you make to an accelerator in Global 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 hasEvents() method.
    
    Returns:
    
    A history of changes that you make to an accelerator in Global Accelerator.
  - toBuilder
```
public Accelerator.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Accelerator.Builder,Accelerator>
  - builder
```
public static Accelerator.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Accelerator.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

Class Accelerator

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

acceleratorArn

name

ipAddressType

ipAddressTypeAsString

enabled

hasIpSets

ipSets

dnsName

status

statusAsString

createdTime

lastModifiedTime

dualStackDnsName

hasEvents

events

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields