com.amazonaws.services.ec2.model.CreateImageRequest 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#createImage(CreateImageRequest) CreateImage operation}.
*
* Creates an AMI that uses an Amazon EBS root device from a "running"
* or "stopped" instance. AMIs that use an Amazon EBS root device boot
* faster than AMIs that use instance stores. They can be up to 1 TiB in
* size, use storage that persists on instance failure, and can be
* stopped and started.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#createImage(CreateImageRequest)
*/
public class CreateImageRequest extends AmazonWebServiceRequest {
/**
* The ID of the instance from which to create the new image.
*/
private String instanceId;
/**
* The name for the new AMI being created.
*/
private String name;
/**
* The description for the new AMI being created.
*/
private String description;
/**
* By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*/
private Boolean noReboot;
/**
* Default constructor for a new CreateImageRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public CreateImageRequest() {}
/**
* Constructs a new CreateImageRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param instanceId The ID of the instance from which to create the new
* image.
* @param name The name for the new AMI being created.
*/
public CreateImageRequest(String instanceId, String name) {
this.instanceId = instanceId;
this.name = name;
}
/**
* The ID of the instance from which to create the new image.
*
* @return The ID of the instance from which to create the new image.
*/
public String getInstanceId() {
return instanceId;
}
/**
* The ID of the instance from which to create the new image.
*
* @param instanceId The ID of the instance from which to create the new image.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
* The ID of the instance from which to create the new image.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceId The ID of the instance from which to create the new image.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateImageRequest withInstanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
/**
* The name for the new AMI being created.
*
* @return The name for the new AMI being created.
*/
public String getName() {
return name;
}
/**
* The name for the new AMI being created.
*
* @param name The name for the new AMI being created.
*/
public void setName(String name) {
this.name = name;
}
/**
* The name for the new AMI being created.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param name The name for the new AMI being created.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateImageRequest withName(String name) {
this.name = name;
return this;
}
/**
* The description for the new AMI being created.
*
* @return The description for the new AMI being created.
*/
public String getDescription() {
return description;
}
/**
* The description for the new AMI being created.
*
* @param description The description for the new AMI being created.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* The description for the new AMI being created.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param description The description for the new AMI being created.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateImageRequest withDescription(String description) {
this.description = description;
return this;
}
/**
* By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*
* @return By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*/
public Boolean isNoReboot() {
return noReboot;
}
/**
* By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*
* @param noReboot By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*/
public void setNoReboot(Boolean noReboot) {
this.noReboot = noReboot;
}
/**
* By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param noReboot By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateImageRequest withNoReboot(Boolean noReboot) {
this.noReboot = noReboot;
return this;
}
/**
* By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*
* @return By default this property is set to false, which means
* Amazon EC2 attempts to cleanly shut down the instance before image
* creation and reboots the instance afterwards. When set to true, Amazon
* EC2 will not shut down the instance before creating the image. When
* this option is used, file system integrity on the created image cannot
* be guaranteed.
*/
public Boolean getNoReboot() {
return noReboot;
}
/**
* 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("InstanceId: " + instanceId + ", ");
sb.append("Name: " + name + ", ");
sb.append("Description: " + description + ", ");
sb.append("NoReboot: " + noReboot + ", ");
sb.append("}");
return sb.toString();
}
}