CustomerGateway (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomerGateway
extends Object
implements Serializable, Cloneable

Describes a customer gateway.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomerGateway()

Constructors
Constructor and Description
`CustomerGateway()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomerGateway`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBgpAsn()` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`String`	`getBgpAsnExtended()` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`String`	`getCertificateArn()` The Amazon Resource Name (ARN) for the customer gateway certificate.
`String`	`getCustomerGatewayId()` The ID of the customer gateway.
`String`	`getDeviceName()` The name of customer gateway device.
`String`	`getIpAddress()` IPv4 address for the customer gateway device's outside interface.
`String`	`getState()` The current state of the customer gateway (`pending \| available \| deleting \| deleted`).
`List<Tag>`	`getTags()` Any tags assigned to the customer gateway.
`String`	`getType()` The type of VPN connection the customer gateway supports (`ipsec.1`).
`int`	`hashCode()`
`void`	`setBgpAsn(String bgpAsn)` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`void`	`setBgpAsnExtended(String bgpAsnExtended)` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`void`	`setCertificateArn(String certificateArn)` The Amazon Resource Name (ARN) for the customer gateway certificate.
`void`	`setCustomerGatewayId(String customerGatewayId)` The ID of the customer gateway.
`void`	`setDeviceName(String deviceName)` The name of customer gateway device.
`void`	`setIpAddress(String ipAddress)` IPv4 address for the customer gateway device's outside interface.
`void`	`setState(String state)` The current state of the customer gateway (`pending \| available \| deleting \| deleted`).
`void`	`setTags(Collection<Tag> tags)` Any tags assigned to the customer gateway.
`void`	`setType(String type)` The type of VPN connection the customer gateway supports (`ipsec.1`).
`String`	`toString()` Returns a string representation of this object.
`CustomerGateway`	`withBgpAsn(String bgpAsn)` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`CustomerGateway`	`withBgpAsnExtended(String bgpAsnExtended)` The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
`CustomerGateway`	`withCertificateArn(String certificateArn)` The Amazon Resource Name (ARN) for the customer gateway certificate.
`CustomerGateway`	`withCustomerGatewayId(String customerGatewayId)` The ID of the customer gateway.
`CustomerGateway`	`withDeviceName(String deviceName)` The name of customer gateway device.
`CustomerGateway`	`withIpAddress(String ipAddress)` IPv4 address for the customer gateway device's outside interface.
`CustomerGateway`	`withState(String state)` The current state of the customer gateway (`pending \| available \| deleting \| deleted`).
`CustomerGateway`	`withTags(Collection<Tag> tags)` Any tags assigned to the customer gateway.
`CustomerGateway`	`withTags(Tag... tags)` Any tags assigned to the customer gateway.
`CustomerGateway`	`withType(String type)` The type of VPN connection the customer gateway supports (`ipsec.1`).

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

- Constructor Detail
  - CustomerGateway
```
public CustomerGateway()
```
- Method Detail
  - setBgpAsn
```
public void setBgpAsn(String bgpAsn)
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
    
    Parameters:
    
    bgpAsn - The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
  - getBgpAsn
```
public String getBgpAsn()
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
    
    Returns:
    
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
  - withBgpAsn
```
public CustomerGateway withBgpAsn(String bgpAsn)
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
    
    Parameters:
    
    bgpAsn - The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 1 to 2,147,483,647
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerGatewayId
```
public void setCustomerGatewayId(String customerGatewayId)
```
    The ID of the customer gateway.
    
    Parameters:
    
    customerGatewayId - The ID of the customer gateway.
  - getCustomerGatewayId
```
public String getCustomerGatewayId()
```
    The ID of the customer gateway.
    
    Returns:
    
    The ID of the customer gateway.
  - withCustomerGatewayId
```
public CustomerGateway withCustomerGatewayId(String customerGatewayId)
```
    The ID of the customer gateway.
    
    Parameters:
    
    customerGatewayId - The ID of the customer gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
    
    Parameters:
    
    ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
  - getIpAddress
```
public String getIpAddress()
```
    IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
    
    Returns:
    
    IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
  - withIpAddress
```
public CustomerGateway withIpAddress(String ipAddress)
```
    IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
    
    Parameters:
    
    ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateArn
```
public void setCertificateArn(String certificateArn)
```
    The Amazon Resource Name (ARN) for the customer gateway certificate.
    
    Parameters:
    
    certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.
  - getCertificateArn
```
public String getCertificateArn()
```
    The Amazon Resource Name (ARN) for the customer gateway certificate.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the customer gateway certificate.
  - withCertificateArn
```
public CustomerGateway withCertificateArn(String certificateArn)
```
    The Amazon Resource Name (ARN) for the customer gateway certificate.
    
    Parameters:
    
    certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the customer gateway (pending | available | deleting | deleted).
    
    Parameters:
    
    state - The current state of the customer gateway (pending | available | deleting | deleted).
  - getState
```
public String getState()
```
    The current state of the customer gateway (pending | available | deleting | deleted).
    
    Returns:
    
    The current state of the customer gateway (pending | available | deleting | deleted).
  - withState
```
public CustomerGateway withState(String state)
```
    The current state of the customer gateway (pending | available | deleting | deleted).
    
    Parameters:
    
    state - The current state of the customer gateway (pending | available | deleting | deleted).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of VPN connection the customer gateway supports (ipsec.1).
    
    Parameters:
    
    type - The type of VPN connection the customer gateway supports (ipsec.1).
  - getType
```
public String getType()
```
    The type of VPN connection the customer gateway supports (ipsec.1).
    
    Returns:
    
    The type of VPN connection the customer gateway supports (ipsec.1).
  - withType
```
public CustomerGateway withType(String type)
```
    The type of VPN connection the customer gateway supports (ipsec.1).
    
    Parameters:
    
    type - The type of VPN connection the customer gateway supports (ipsec.1).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeviceName
```
public void setDeviceName(String deviceName)
```
    The name of customer gateway device.
    
    Parameters:
    
    deviceName - The name of customer gateway device.
  - getDeviceName
```
public String getDeviceName()
```
    The name of customer gateway device.
    
    Returns:
    
    The name of customer gateway device.
  - withDeviceName
```
public CustomerGateway withDeviceName(String deviceName)
```
    The name of customer gateway device.
    
    Parameters:
    
    deviceName - The name of customer gateway device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Any tags assigned to the customer gateway.
    
    Returns:
    
    Any tags assigned to the customer gateway.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Any tags assigned to the customer gateway.
    
    Parameters:
    
    tags - Any tags assigned to the customer gateway.
  - withTags
```
public CustomerGateway withTags(Tag... tags)
```
    Any tags assigned to the customer gateway.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Any tags assigned to the customer gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CustomerGateway withTags(Collection<Tag> tags)
```
    Any tags assigned to the customer gateway.
    
    Parameters:
    
    tags - Any tags assigned to the customer gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBgpAsnExtended
```
public void setBgpAsnExtended(String bgpAsnExtended)
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
    
    Parameters:
    
    bgpAsnExtended - The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
  - getBgpAsnExtended
```
public String getBgpAsnExtended()
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
    
    Returns:
    
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
  - withBgpAsnExtended
```
public CustomerGateway withBgpAsnExtended(String bgpAsnExtended)
```
    The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
    
    Parameters:
    
    bgpAsnExtended - The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    
    Valid values: 2,147,483,648 to 4,294,967,295
    
    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 CustomerGateway clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class CustomerGateway

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomerGateway

Method Detail

setBgpAsn

getBgpAsn

withBgpAsn

setCustomerGatewayId

getCustomerGatewayId

withCustomerGatewayId

setIpAddress

getIpAddress

withIpAddress

setCertificateArn

getCertificateArn

withCertificateArn

setState

getState

withState

setType

getType

withType

setDeviceName

getDeviceName

withDeviceName

getTags

setTags

withTags

withTags

setBgpAsnExtended

getBgpAsnExtended

withBgpAsnExtended

toString

equals

hashCode

clone