com.amazonaws.services.ec2.model

Class ProvisionByoipCidrRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ProvisionByoipCidrRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<ProvisionByoipCidrRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProvisionByoipCidrRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ProvisionByoipCidrRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ProvisionByoipCidrRequest()

Method Summary

Modifier and Type	Method and Description
ProvisionByoipCidrRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCidr() The public IPv4 or IPv6 address range, in CIDR notation.
CidrAuthorizationContext	getCidrAuthorizationContext() A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
String	getDescription() A description for the address range and the address pool.
Request<ProvisionByoipCidrRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getMultiRegion() Reserved.
String	getNetworkBorderGroup() If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR.
List<TagSpecification>	getPoolTagSpecifications() The tags to apply to the address pool.
Boolean	getPubliclyAdvertisable() (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
int	hashCode()
Boolean	isMultiRegion() Reserved.
Boolean	isPubliclyAdvertisable() (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
void	setCidr(String cidr) The public IPv4 or IPv6 address range, in CIDR notation.
void	setCidrAuthorizationContext(CidrAuthorizationContext cidrAuthorizationContext) A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
void	setDescription(String description) A description for the address range and the address pool.
void	setMultiRegion(Boolean multiRegion) Reserved.
void	setNetworkBorderGroup(String networkBorderGroup) If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR.
void	setPoolTagSpecifications(Collection<TagSpecification> poolTagSpecifications) The tags to apply to the address pool.
void	setPubliclyAdvertisable(Boolean publiclyAdvertisable) (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
String	toString() Returns a string representation of this object.
ProvisionByoipCidrRequest	withCidr(String cidr) The public IPv4 or IPv6 address range, in CIDR notation.
ProvisionByoipCidrRequest	withCidrAuthorizationContext(CidrAuthorizationContext cidrAuthorizationContext) A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
ProvisionByoipCidrRequest	withDescription(String description) A description for the address range and the address pool.
ProvisionByoipCidrRequest	withMultiRegion(Boolean multiRegion) Reserved.
ProvisionByoipCidrRequest	withNetworkBorderGroup(String networkBorderGroup) If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR.
ProvisionByoipCidrRequest	withPoolTagSpecifications(Collection<TagSpecification> poolTagSpecifications) The tags to apply to the address pool.
ProvisionByoipCidrRequest	withPoolTagSpecifications(TagSpecification... poolTagSpecifications) The tags to apply to the address pool.
ProvisionByoipCidrRequest	withPubliclyAdvertisable(Boolean publiclyAdvertisable) (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProvisionByoipCidrRequest

public ProvisionByoipCidrRequest()

Method Detail

setCidr

public void setCidr(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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

Parameters:

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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

getCidr

public String getCidr()

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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. 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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

withCidr

public ProvisionByoipCidrRequest withCidr(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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

Parameters:

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 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCidrAuthorizationContext

public void setCidrAuthorizationContext(CidrAuthorizationContext cidrAuthorizationContext)

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

Parameters:

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

getCidrAuthorizationContext

public CidrAuthorizationContext getCidrAuthorizationContext()

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.

withCidrAuthorizationContext

public ProvisionByoipCidrRequest withCidrAuthorizationContext(CidrAuthorizationContext cidrAuthorizationContext)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPubliclyAdvertisable

public void setPubliclyAdvertisable(Boolean publiclyAdvertisable)

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

Default: true

Parameters:

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

Default: true

getPubliclyAdvertisable

public Boolean getPubliclyAdvertisable()

(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

withPubliclyAdvertisable

public ProvisionByoipCidrRequest withPubliclyAdvertisable(Boolean publiclyAdvertisable)

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

Default: true

Parameters:

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

Default: true

Returns:

Returns a reference to this object so that method calls can be chained together.

isPubliclyAdvertisable

public Boolean isPubliclyAdvertisable()

(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

setDescription

public void setDescription(String description)

A description for the address range and the address pool.

Parameters:

description - A description for the address range and the address pool.

getDescription

public String getDescription()

A description for the address range and the address pool.

Returns:

A description for the address range and the address pool.

withDescription

public ProvisionByoipCidrRequest withDescription(String description)

A description for the address range and the address pool.

Parameters:

description - A description for the address range and the address pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPoolTagSpecifications

public List<TagSpecification> getPoolTagSpecifications()

The tags to apply to the address pool.

Returns:

The tags to apply to the address pool.

setPoolTagSpecifications

public void setPoolTagSpecifications(Collection<TagSpecification> poolTagSpecifications)

The tags to apply to the address pool.

Parameters:

poolTagSpecifications - The tags to apply to the address pool.

withPoolTagSpecifications

public ProvisionByoipCidrRequest withPoolTagSpecifications(TagSpecification... poolTagSpecifications)

The tags to apply to the address pool.

NOTE: This method appends the values to the existing list (if any). Use setPoolTagSpecifications(java.util.Collection) or withPoolTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

poolTagSpecifications - The tags to apply to the address pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPoolTagSpecifications

public ProvisionByoipCidrRequest withPoolTagSpecifications(Collection<TagSpecification> poolTagSpecifications)

The tags to apply to the address pool.

Parameters:

poolTagSpecifications - The tags to apply to the address pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMultiRegion

public void setMultiRegion(Boolean multiRegion)

Reserved.

Parameters:

multiRegion - Reserved.

getMultiRegion

public Boolean getMultiRegion()

Reserved.

Returns:

Reserved.

withMultiRegion

public ProvisionByoipCidrRequest withMultiRegion(Boolean multiRegion)

Reserved.

Parameters:

multiRegion - Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

isMultiRegion

public Boolean isMultiRegion()

Reserved.

Returns:

Reserved.

setNetworkBorderGroup

public void setNetworkBorderGroup(String networkBorderGroup)

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

Parameters:

networkBorderGroup - If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

getNetworkBorderGroup

public String getNetworkBorderGroup()

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

Returns:

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

withNetworkBorderGroup

public ProvisionByoipCidrRequest withNetworkBorderGroup(String networkBorderGroup)

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

Parameters:

networkBorderGroup - If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<ProvisionByoipCidrRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ProvisionByoipCidrRequest>

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ProvisionByoipCidrRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()