ByoipCidr (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.ByoipCidr

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ByoipCidr
extends Object
implements Serializable, Cloneable
```
Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ByoipCidr()

Constructors
Constructor and Description
`ByoipCidr()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByoipCidr`	`clone()`
`boolean`	`equals(Object obj)`
`List<AsnAssociation>`	`getAsnAssociations()` The BYOIP CIDR associations with ASNs.
`String`	`getCidr()` The address range, in CIDR notation.
`String`	`getDescription()` The description of the address range.
`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.
`String`	`getState()` The state of the address range.
`String`	`getStatusMessage()` Upon success, contains the ID of the address pool.
`int`	`hashCode()`
`void`	`setAsnAssociations(Collection<AsnAssociation> asnAssociations)` The BYOIP CIDR associations with ASNs.
`void`	`setCidr(String cidr)` The address range, in CIDR notation.
`void`	`setDescription(String description)` The description of the address range.
`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`	`setState(String state)` The state of the address range.
`void`	`setStatusMessage(String statusMessage)` Upon success, contains the ID of the address pool.
`String`	`toString()` Returns a string representation of this object.
`ByoipCidr`	`withAsnAssociations(AsnAssociation... asnAssociations)` The BYOIP CIDR associations with ASNs.
`ByoipCidr`	`withAsnAssociations(Collection<AsnAssociation> asnAssociations)` The BYOIP CIDR associations with ASNs.
`ByoipCidr`	`withCidr(String cidr)` The address range, in CIDR notation.
`ByoipCidr`	`withDescription(String description)` The description of the address range.
`ByoipCidr`	`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.
`ByoipCidr`	`withState(ByoipCidrState state)` The state of the address range.
`ByoipCidr`	`withState(String state)` The state of the address range.
`ByoipCidr`	`withStatusMessage(String statusMessage)` Upon success, contains the ID of the address pool.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ByoipCidr
```
public ByoipCidr()
```
- Method Detail
  - setCidr
```
public void setCidr(String cidr)
```
    The address range, in CIDR notation.
    
    Parameters:
    
    cidr - The address range, in CIDR notation.
  - getCidr
```
public String getCidr()
```
    The address range, in CIDR notation.
    
    Returns:
    
    The address range, in CIDR notation.
  - withCidr
```
public ByoipCidr withCidr(String cidr)
```
    The address range, in CIDR notation.
    
    Parameters:
    
    cidr - The address range, in CIDR notation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the address range.
    
    Parameters:
    
    description - The description of the address range.
  - getDescription
```
public String getDescription()
```
    The description of the address range.
    
    Returns:
    
    The description of the address range.
  - withDescription
```
public ByoipCidr withDescription(String description)
```
    The description of the address range.
    
    Parameters:
    
    description - The description of the address range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAsnAssociations
```
public List<AsnAssociation> getAsnAssociations()
```
    The BYOIP CIDR associations with ASNs.
    
    Returns:
    
    The BYOIP CIDR associations with ASNs.
  - setAsnAssociations
```
public void setAsnAssociations(Collection<AsnAssociation> asnAssociations)
```
    The BYOIP CIDR associations with ASNs.
    
    Parameters:
    
    asnAssociations - The BYOIP CIDR associations with ASNs.
  - withAsnAssociations
```
public ByoipCidr withAsnAssociations(AsnAssociation... asnAssociations)
```
    The BYOIP CIDR associations with ASNs.
    
    NOTE: This method appends the values to the existing list (if any). Use setAsnAssociations(java.util.Collection) or withAsnAssociations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    asnAssociations - The BYOIP CIDR associations with ASNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAsnAssociations
```
public ByoipCidr withAsnAssociations(Collection<AsnAssociation> asnAssociations)
```
    The BYOIP CIDR associations with ASNs.
    
    Parameters:
    
    asnAssociations - The BYOIP CIDR associations with ASNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
    
    Parameters:
    
    statusMessage - Upon success, contains the ID of the address pool. Otherwise, contains an error message.
  - getStatusMessage
```
public String getStatusMessage()
```
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
    
    Returns:
    
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
  - withStatusMessage
```
public ByoipCidr withStatusMessage(String statusMessage)
```
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
    
    Parameters:
    
    statusMessage - Upon success, contains the ID of the address pool. Otherwise, contains an error message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    - pending-provision: You’ve submitted a request to provision an address range and it's pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Parameters:
    state - The state of the address range.
    
    advertised: The address range is being advertised to the internet by Amazon Web Services.
    
    deprovisioned: The address range is deprovisioned.
    
    failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    
    failed-provision: The request to provision the address range was unsuccessful.
    
    pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    
    pending-provision: You’ve submitted a request to provision an address range and it's pending.
    
    provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    
    provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    See Also:
    
    ByoipCidrState
  - getState
```
public String getState()
```
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    - pending-provision: You’ve submitted a request to provision an address range and it's pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Returns:
    The state of the address range.
    
    advertised: The address range is being advertised to the internet by Amazon Web Services.
    
    deprovisioned: The address range is deprovisioned.
    
    failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    
    failed-provision: The request to provision the address range was unsuccessful.
    
    pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    
    pending-provision: You’ve submitted a request to provision an address range and it's pending.
    
    provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    
    provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    See Also:
    
    ByoipCidrState
  - withState
```
public ByoipCidr withState(String state)
```
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    - pending-provision: You’ve submitted a request to provision an address range and it's pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Parameters:
    state - The state of the address range.
    
    advertised: The address range is being advertised to the internet by Amazon Web Services.
    
    deprovisioned: The address range is deprovisioned.
    
    failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    
    failed-provision: The request to provision the address range was unsuccessful.
    
    pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    
    pending-provision: You’ve submitted a request to provision an address range and it's pending.
    
    provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    
    provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ByoipCidrState
  - withState
```
public ByoipCidr withState(ByoipCidrState state)
```
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    - pending-provision: You’ve submitted a request to provision an address range and it's pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Parameters:
    state - The state of the address range.
    
    advertised: The address range is being advertised to the internet by Amazon Web Services.
    
    deprovisioned: The address range is deprovisioned.
    
    failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    
    failed-provision: The request to provision the address range was unsuccessful.
    
    pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    
    pending-provision: You’ve submitted a request to provision an address range and it's pending.
    
    provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    
    provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ByoipCidrState
  - 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 ByoipCidr 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.
  - 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 ByoipCidr clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class ByoipCidr

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByoipCidr

Method Detail

setCidr

getCidr

withCidr

setDescription

getDescription

withDescription

getAsnAssociations

setAsnAssociations

withAsnAssociations

withAsnAssociations

setStatusMessage

getStatusMessage

withStatusMessage

setState

getState

withState

withState

setNetworkBorderGroup

getNetworkBorderGroup

withNetworkBorderGroup

toString

equals

hashCode

clone