com.amazonaws.services.ec2.model.AuthorizeClientVpnIngressRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.AuthorizeClientVpnIngressRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AuthorizeClientVpnIngressRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The ID of the Client VPN endpoint.
*
*/
private String clientVpnEndpointId;
/**
*
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*
*/
private String targetNetworkCidr;
/**
*
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
* Required if AuthorizeAllGroups is false or not specified.
*
*/
private String accessGroupId;
/**
*
* Indicates whether to grant access to all clients. Specify true to grant all clients who successfully
* establish a VPN connection access to the network. Must be set to true if AccessGroupId
* is not specified.
*
*/
private Boolean authorizeAllGroups;
/**
*
* A brief description of the authorization rule.
*
*/
private String description;
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*/
private String clientToken;
/**
*
* The ID of the Client VPN endpoint.
*
*
* @param clientVpnEndpointId
* The ID of the Client VPN endpoint.
*/
public void setClientVpnEndpointId(String clientVpnEndpointId) {
this.clientVpnEndpointId = clientVpnEndpointId;
}
/**
*
* The ID of the Client VPN endpoint.
*
*
* @return The ID of the Client VPN endpoint.
*/
public String getClientVpnEndpointId() {
return this.clientVpnEndpointId;
}
/**
*
* The ID of the Client VPN endpoint.
*
*
* @param clientVpnEndpointId
* The ID of the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withClientVpnEndpointId(String clientVpnEndpointId) {
setClientVpnEndpointId(clientVpnEndpointId);
return this;
}
/**
*
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*
*
* @param targetNetworkCidr
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*/
public void setTargetNetworkCidr(String targetNetworkCidr) {
this.targetNetworkCidr = targetNetworkCidr;
}
/**
*
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*
*
* @return The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*/
public String getTargetNetworkCidr() {
return this.targetNetworkCidr;
}
/**
*
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
*
*
* @param targetNetworkCidr
* The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withTargetNetworkCidr(String targetNetworkCidr) {
setTargetNetworkCidr(targetNetworkCidr);
return this;
}
/**
*
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
* Required if AuthorizeAllGroups is false or not specified.
*
*
* @param accessGroupId
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP)
* group. Required if AuthorizeAllGroups is false or not specified.
*/
public void setAccessGroupId(String accessGroupId) {
this.accessGroupId = accessGroupId;
}
/**
*
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
* Required if AuthorizeAllGroups is false or not specified.
*
*
* @return The ID of the group to grant access to, for example, the Active Directory group or identity provider
* (IdP) group. Required if AuthorizeAllGroups is false or not specified.
*/
public String getAccessGroupId() {
return this.accessGroupId;
}
/**
*
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
* Required if AuthorizeAllGroups is false or not specified.
*
*
* @param accessGroupId
* The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP)
* group. Required if AuthorizeAllGroups is false or not specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withAccessGroupId(String accessGroupId) {
setAccessGroupId(accessGroupId);
return this;
}
/**
*
* Indicates whether to grant access to all clients. Specify true to grant all clients who successfully
* establish a VPN connection access to the network. Must be set to true if AccessGroupId
* is not specified.
*
*
* @param authorizeAllGroups
* Indicates whether to grant access to all clients. Specify true to grant all clients who
* successfully establish a VPN connection access to the network. Must be set to true if
* AccessGroupId is not specified.
*/
public void setAuthorizeAllGroups(Boolean authorizeAllGroups) {
this.authorizeAllGroups = authorizeAllGroups;
}
/**
*
* Indicates whether to grant access to all clients. Specify true to grant all clients who successfully
* establish a VPN connection access to the network. Must be set to true if AccessGroupId
* is not specified.
*
*
* @return Indicates whether to grant access to all clients. Specify true to grant all clients who
* successfully establish a VPN connection access to the network. Must be set to true if
* AccessGroupId is not specified.
*/
public Boolean getAuthorizeAllGroups() {
return this.authorizeAllGroups;
}
/**
*
* Indicates whether to grant access to all clients. Specify true to grant all clients who successfully
* establish a VPN connection access to the network. Must be set to true if AccessGroupId
* is not specified.
*
*
* @param authorizeAllGroups
* Indicates whether to grant access to all clients. Specify true to grant all clients who
* successfully establish a VPN connection access to the network. Must be set to true if
* AccessGroupId is not specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withAuthorizeAllGroups(Boolean authorizeAllGroups) {
setAuthorizeAllGroups(authorizeAllGroups);
return this;
}
/**
*
* Indicates whether to grant access to all clients. Specify true to grant all clients who successfully
* establish a VPN connection access to the network. Must be set to true if AccessGroupId
* is not specified.
*
*
* @return Indicates whether to grant access to all clients. Specify true to grant all clients who
* successfully establish a VPN connection access to the network. Must be set to true if
* AccessGroupId is not specified.
*/
public Boolean isAuthorizeAllGroups() {
return this.authorizeAllGroups;
}
/**
*
* A brief description of the authorization rule.
*
*
* @param description
* A brief description of the authorization rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A brief description of the authorization rule.
*
*
* @return A brief description of the authorization rule.
*/
public String getDescription() {
return this.description;
}
/**
*
* A brief description of the authorization rule.
*
*
* @param description
* A brief description of the authorization rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthorizeClientVpnIngressRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new AuthorizeClientVpnIngressRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getClientVpnEndpointId() != null)
sb.append("ClientVpnEndpointId: ").append(getClientVpnEndpointId()).append(",");
if (getTargetNetworkCidr() != null)
sb.append("TargetNetworkCidr: ").append(getTargetNetworkCidr()).append(",");
if (getAccessGroupId() != null)
sb.append("AccessGroupId: ").append(getAccessGroupId()).append(",");
if (getAuthorizeAllGroups() != null)
sb.append("AuthorizeAllGroups: ").append(getAuthorizeAllGroups()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AuthorizeClientVpnIngressRequest == false)
return false;
AuthorizeClientVpnIngressRequest other = (AuthorizeClientVpnIngressRequest) obj;
if (other.getClientVpnEndpointId() == null ^ this.getClientVpnEndpointId() == null)
return false;
if (other.getClientVpnEndpointId() != null && other.getClientVpnEndpointId().equals(this.getClientVpnEndpointId()) == false)
return false;
if (other.getTargetNetworkCidr() == null ^ this.getTargetNetworkCidr() == null)
return false;
if (other.getTargetNetworkCidr() != null && other.getTargetNetworkCidr().equals(this.getTargetNetworkCidr()) == false)
return false;
if (other.getAccessGroupId() == null ^ this.getAccessGroupId() == null)
return false;
if (other.getAccessGroupId() != null && other.getAccessGroupId().equals(this.getAccessGroupId()) == false)
return false;
if (other.getAuthorizeAllGroups() == null ^ this.getAuthorizeAllGroups() == null)
return false;
if (other.getAuthorizeAllGroups() != null && other.getAuthorizeAllGroups().equals(this.getAuthorizeAllGroups()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientVpnEndpointId() == null) ? 0 : getClientVpnEndpointId().hashCode());
hashCode = prime * hashCode + ((getTargetNetworkCidr() == null) ? 0 : getTargetNetworkCidr().hashCode());
hashCode = prime * hashCode + ((getAccessGroupId() == null) ? 0 : getAccessGroupId().hashCode());
hashCode = prime * hashCode + ((getAuthorizeAllGroups() == null) ? 0 : getAuthorizeAllGroups().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public AuthorizeClientVpnIngressRequest clone() {
return (AuthorizeClientVpnIngressRequest) super.clone();
}
}