CreateIpsecServerRequest (vpc20160428 7.9.1 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.vpc20160428.models.CreateIpsecServerRequest

public class CreateIpsecServerRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`clientIpPool` The client CIDR block from which an IP address is allocated to the virtual network interface controller (NIC) of the client.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`String`	`dryRun` Specifies whether to only precheck this request.
`Boolean`	`effectImmediately` Specify whether to start connection negotiations immediately.
`String`	`ikeConfig` The configuration of Phase 1 negotiation.
`String`	`ipsecConfig` The configuration of Phase 2 negotiation.
`String`	`ipSecServerName` The name of the IPsec server.
`String`	`localSubnet` The local CIDR blocks, which are the CIDR blocks of the virtual private cloud (VPC) for the client to access.
`String`	`psk` The pre-shared key.
`Boolean`	`pskEnabled` Indicates whether pre-shared key authentication is enabled.
`String`	`regionId` The ID of the region where the VPN gateway is deployed.
`String`	`vpnGatewayId` The ID of the VPN gateway.

构造器概要

构造器
构造器和说明

CreateIpsecServerRequest()

构造器
构造器和说明
`CreateIpsecServerRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateIpsecServerRequest`	`build(Map<String,?> map)`
`String`	`getClientIpPool()`
`String`	`getClientToken()`
`String`	`getDryRun()`
`Boolean`	`getEffectImmediately()`
`String`	`getIkeConfig()`
`String`	`getIpsecConfig()`
`String`	`getIpSecServerName()`
`String`	`getLocalSubnet()`
`String`	`getPsk()`
`Boolean`	`getPskEnabled()`
`String`	`getRegionId()`
`String`	`getVpnGatewayId()`
`CreateIpsecServerRequest`	`setClientIpPool(String clientIpPool)`
`CreateIpsecServerRequest`	`setClientToken(String clientToken)`
`CreateIpsecServerRequest`	`setDryRun(String dryRun)`
`CreateIpsecServerRequest`	`setEffectImmediately(Boolean effectImmediately)`
`CreateIpsecServerRequest`	`setIkeConfig(String ikeConfig)`
`CreateIpsecServerRequest`	`setIpsecConfig(String ipsecConfig)`
`CreateIpsecServerRequest`	`setIpSecServerName(String ipSecServerName)`
`CreateIpsecServerRequest`	`setLocalSubnet(String localSubnet)`
`CreateIpsecServerRequest`	`setPsk(String psk)`
`CreateIpsecServerRequest`	`setPskEnabled(Boolean pskEnabled)`
`CreateIpsecServerRequest`	`setRegionId(String regionId)`
`CreateIpsecServerRequest`	`setVpnGatewayId(String vpnGatewayId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - clientIpPool
```
@NameInMap(value="ClientIpPool")
public String clientIpPool
```
    The client CIDR block from which an IP address is allocated to the virtual network interface controller (NIC) of the client.
    
    The client CIDR block must not overlap with the CIDR blocks of the VPC.
    
    This parameter is required.
    example:
    10.0.0.0/24
  - clientToken
```
@NameInMap(value="ClientToken")
public String clientToken
```
    The client token that is used to ensure the idempotence of the request.
    
    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.
    
    If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    
    example:
    d7d24a21-f4ba-4454-9173-b38****
  - dryRun
```
@NameInMap(value="DryRun")
public String dryRun
```
    Specifies whether to only precheck this request. Valid values:
    - true: prechecks the request without creating the IPsec server. The system checks the required parameters, request format, and service limits. If the request fails to pass the precheck, an error code is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    - false (default): sends the request. This is the default value. If the request passes the precheck, the system creates the IPsec server.
    example:
    false
  - effectImmediately
```
@NameInMap(value="EffectImmediately")
public Boolean effectImmediately
```
    Specify whether to start connection negotiations immediately. Valid values:
    - true: immediately initiates negotiations after the configuration is complete.
    - false (default): initiates negotiations when inbound traffic is detected. This is the default value.
    example:
    true
  - ikeConfig
```
@NameInMap(value="IkeConfig")
public String ikeConfig
```
    The configuration of Phase 1 negotiation. Valid values:
    - IkeVersion: the IKE version. Valid values: ikev1 and ikev2. Default value: ikev2.
    - IkeMode: the IKE negotiation mode. Default value: main.
    - IkeEncAlg: the encryption algorithm that is used in Phase 1 negotiation. Default value: aes.
    - IkeAuthAlg: the authentication algorithm that is used in Phase 1 negotiation. Default value: sha1.
    - IkePfs: the Diffie-Hellman key exchange algorithm that is used in Phase 1 negotiation. Default value: group2.
    - IkeLifetime: the security association (SA) lifetime determined by Phase 1 negotiation. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
    - LocalId: the identifier of the IPsec server. The value can be a fully qualified domain name (FQDN) or an IP address. The default value is the public IP address of the VPN gateway.
    - RemoteId: the peer identifier. The value can be an FQDN or an IP address. The default value is empty.
    example:
    {"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
  - ipSecServerName
```
@NameInMap(value="IpSecServerName")
public String ipSecServerName
```
    The name of the IPsec server.
    
    The name must be 1 to 100 characters in length.
    example:
    test
  - ipsecConfig
```
@NameInMap(value="IpsecConfig")
public String ipsecConfig
```
    The configuration of Phase 2 negotiation. Valid values:
    - IpsecEncAlg: the encryption algorithm that is used in Phase 2 negotiation. Default value: aes.
    - IpsecAuthAlg: the authentication algorithm that is used in Phase 2 negotiation. Default value: sha1.
    - IpsecPfs: forwards packets of all protocols. The Diffie-Hellman key exchange algorithm that is used in Phase 2 negotiation. Default value: group2.
    - IpsecLifetime: the SA lifetime determined by Phase 2 negotiation. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
    example:
    {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
  - localSubnet
```
@NameInMap(value="LocalSubnet")
public String localSubnet
```
    The local CIDR blocks, which are the CIDR blocks of the virtual private cloud (VPC) for the client to access.
    
    Multiple CIDR blocks are separated with commas (,). Example: 192.168.1.0/24,192.168.2.0/24.
    
    This parameter is required.
    example:
    192.168.0.0/24
  - psk
```
@NameInMap(value="Psk")
public String psk
```
    The pre-shared key.
    
    The pre-shared key is used for identity authentication between the IPsec server and the client. The key must be 1 to 100 characters in length.
    
    If you do not specify a pre-shared key, the system randomly generates a 16-character string as the pre-shared key. You can call the ListIpsecServers operation to query the pre-shared keys that are generated by the system.
    
    The pre-shared key of the IPsec server must be the same as the client key. Otherwise, the IPsec server cannot be connected to the client.
    
    example:
    Cfd123****
  - pskEnabled
```
@NameInMap(value="PskEnabled")
public Boolean pskEnabled
```
    Indicates whether pre-shared key authentication is enabled. If you set the value to true, pre-shared key authentication is enabled.
    
    This parameter is required.
    
    example:
    true
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The ID of the region where the VPN gateway is deployed.
    
    This parameter is required.
    example:
    cn-hangzhou
  - vpnGatewayId
```
@NameInMap(value="VpnGatewayId")
public String vpnGatewayId
```
    The ID of the VPN gateway.
    
    This parameter is required.
    example:
    vpn-bp17lofy9fd0dnvzv****
- 构造器详细资料
  - CreateIpsecServerRequest
```
public CreateIpsecServerRequest()
```
- 方法详细资料
  - build
```
public static CreateIpsecServerRequest build(Map<String,?> map)
                                      throws Exception
```
    抛出:
    
    Exception
  - setClientIpPool
```
public CreateIpsecServerRequest setClientIpPool(String clientIpPool)
```
  - getClientIpPool
```
public String getClientIpPool()
```
  - setClientToken
```
public CreateIpsecServerRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setDryRun
```
public CreateIpsecServerRequest setDryRun(String dryRun)
```
  - getDryRun
```
public String getDryRun()
```
  - setEffectImmediately
```
public CreateIpsecServerRequest setEffectImmediately(Boolean effectImmediately)
```
  - getEffectImmediately
```
public Boolean getEffectImmediately()
```
  - setIkeConfig
```
public CreateIpsecServerRequest setIkeConfig(String ikeConfig)
```
  - getIkeConfig
```
public String getIkeConfig()
```
  - setIpSecServerName
```
public CreateIpsecServerRequest setIpSecServerName(String ipSecServerName)
```
  - getIpSecServerName
```
public String getIpSecServerName()
```
  - setIpsecConfig
```
public CreateIpsecServerRequest setIpsecConfig(String ipsecConfig)
```
  - getIpsecConfig
```
public String getIpsecConfig()
```
  - setLocalSubnet
```
public CreateIpsecServerRequest setLocalSubnet(String localSubnet)
```
  - getLocalSubnet
```
public String getLocalSubnet()
```
  - setPsk
```
public CreateIpsecServerRequest setPsk(String psk)
```
  - getPsk
```
public String getPsk()
```
  - setPskEnabled
```
public CreateIpsecServerRequest setPskEnabled(Boolean pskEnabled)
```
  - getPskEnabled
```
public Boolean getPskEnabled()
```
  - setRegionId
```
public CreateIpsecServerRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setVpnGatewayId
```
public CreateIpsecServerRequest setVpnGatewayId(String vpnGatewayId)
```
  - getVpnGatewayId
```
public String getVpnGatewayId()
```

类 CreateIpsecServerRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

clientIpPool

clientToken

dryRun

effectImmediately

ikeConfig

ipSecServerName

ipsecConfig

localSubnet

psk

pskEnabled

regionId

vpnGatewayId

构造器详细资料

CreateIpsecServerRequest

方法详细资料

build

setClientIpPool

getClientIpPool

setClientToken

getClientToken

setDryRun

getDryRun

setEffectImmediately

getEffectImmediately

setIkeConfig

getIkeConfig

setIpSecServerName

getIpSecServerName

setIpsecConfig

getIpsecConfig

setLocalSubnet

getLocalSubnet

setPsk

getPsk

setPskEnabled

getPskEnabled

setRegionId

getRegionId

setVpnGatewayId

getVpnGatewayId