com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#deleteCustomerGateway(DeleteCustomerGatewayRequest) DeleteCustomerGateway operation}.
*
* Deletes a customer gateway. You must delete the VPN connection before
* deleting the customer gateway.
*
*
* You can have a single active customer gateway per AWS account (active
* means that you've created a VPN connection with that customer
* gateway). AWS might delete any customer gateway you leave inactive for
* an extended period of time.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#deleteCustomerGateway(DeleteCustomerGatewayRequest)
*/
public class DeleteCustomerGatewayRequest extends AmazonWebServiceRequest {
/**
* The ID of the customer gateway to delete.
*/
private String customerGatewayId;
/**
* Default constructor for a new DeleteCustomerGatewayRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DeleteCustomerGatewayRequest() {}
/**
* Constructs a new DeleteCustomerGatewayRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param customerGatewayId The ID of the customer gateway to delete.
*/
public DeleteCustomerGatewayRequest(String customerGatewayId) {
this.customerGatewayId = customerGatewayId;
}
/**
* The ID of the customer gateway to delete.
*
* @return The ID of the customer gateway to delete.
*/
public String getCustomerGatewayId() {
return customerGatewayId;
}
/**
* The ID of the customer gateway to delete.
*
* @param customerGatewayId The ID of the customer gateway to delete.
*/
public void setCustomerGatewayId(String customerGatewayId) {
this.customerGatewayId = customerGatewayId;
}
/**
* The ID of the customer gateway to delete.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param customerGatewayId The ID of the customer gateway to delete.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DeleteCustomerGatewayRequest withCustomerGatewayId(String customerGatewayId) {
this.customerGatewayId = customerGatewayId;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("CustomerGatewayId: " + customerGatewayId + ", ");
sb.append("}");
return sb.toString();
}
}