software.amazon.awssdk.services.ec2.model

Class ProvisionByoipCidrRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.ProvisionByoipCidrRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProvisionByoipCidrRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ProvisionByoipCidrRequest.Builder	builder()
String	cidr() The public IPv4 or IPv6 address range, in CIDR notation.
CidrAuthorizationContext	cidrAuthorizationContext() A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
String	description() A description for the address range and the address pool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPoolTagSpecifications() For responses, this returns true if the service returned a value for the PoolTagSpecifications property.
Boolean	multiRegion() Reserved.
List<TagSpecification>	poolTagSpecifications() The tags to apply to the address pool.
Boolean	publiclyAdvertisable() (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
List<SdkField<?>>	sdkFields()
static Class<? extends ProvisionByoipCidrRequest.Builder>	serializableBuilderClass()
ProvisionByoipCidrRequest.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

cidr

public final String cidr()

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.

Returns:

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.

cidrAuthorizationContext

public final CidrAuthorizationContext cidrAuthorizationContext()

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

Returns:

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

publiclyAdvertisable

public final Boolean publiclyAdvertisable()

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

Returns:

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

description

public final String description()

A description for the address range and the address pool.

Returns:

A description for the address range and the address pool.

hasPoolTagSpecifications

public final boolean hasPoolTagSpecifications()

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

poolTagSpecifications

public final List<TagSpecification> poolTagSpecifications()

The tags to apply to the address pool.

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

Returns:

The tags to apply to the address pool.

multiRegion

public final Boolean multiRegion()

Reserved.

Returns:

Reserved.

toBuilder

public ProvisionByoipCidrRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ProvisionByoipCidrRequest.Builder builder()

serializableBuilderClass

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