software.amazon.awssdk.services.globalaccelerator.model

Class CreateAcceleratorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.globalaccelerator.model.GlobalAcceleratorRequest

software.amazon.awssdk.services.globalaccelerator.model.CreateAcceleratorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAcceleratorRequest.Builder,CreateAcceleratorRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAcceleratorRequest
extends GlobalAcceleratorRequest
implements ToCopyableBuilder<CreateAcceleratorRequest.Builder,CreateAcceleratorRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAcceleratorRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateAcceleratorRequest.Builder	builder()
Boolean	enabled() Indicates whether an accelerator is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpAddresses() For responses, this returns true if the service returned a value for the IpAddresses property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	idempotencyToken() A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
List<String>	ipAddresses() Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
IpAddressType	ipAddressType() The IP address type that an accelerator supports.
String	ipAddressTypeAsString() The IP address type that an accelerator supports.
String	name() The name of the accelerator.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAcceleratorRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Create tags for an accelerator.
CreateAcceleratorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

name

public final String name()

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

Returns:

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

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

hasIpAddresses

public final boolean hasIpAddresses()

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

ipAddresses

public final List<String> ipAddresses()

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

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

Returns:

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

enabled

public final Boolean enabled()

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

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

Returns:

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

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

idempotencyToken

public final String idempotencyToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Create tags for an accelerator.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

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

Returns:

Create tags for an accelerator.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

toBuilder

public CreateAcceleratorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAcceleratorRequest.Builder,CreateAcceleratorRequest>

Specified by:

toBuilder in class GlobalAcceleratorRequest

builder

public static CreateAcceleratorRequest.Builder builder()

serializableBuilderClass

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