1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ModifyVolumeInput {
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub dry_run: ::std::option::Option<bool>,
/// <p>The ID of the volume.</p>
pub volume_id: ::std::option::Option<::std::string::String>,
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li>
/// <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li>
/// <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li>
/// <li> <p> <code>standard</code>: 1-1,024</p> </li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub size: ::std::option::Option<i32>,
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub volume_type: ::std::option::Option<crate::types::VolumeType>,
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li>
/// <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li>
/// <li> <p> <code>io2</code>: 100-64,000 IOPS</p> </li>
/// </ul>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub iops: ::std::option::Option<i32>,
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 1,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>
pub throughput: ::std::option::Option<i32>,
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub multi_attach_enabled: ::std::option::Option<bool>,
}
impl ModifyVolumeInput {
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(&self) -> ::std::option::Option<bool> {
self.dry_run
}
/// <p>The ID of the volume.</p>
pub fn volume_id(&self) -> ::std::option::Option<&str> {
self.volume_id.as_deref()
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li>
/// <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li>
/// <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li>
/// <li> <p> <code>standard</code>: 1-1,024</p> </li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn size(&self) -> ::std::option::Option<i32> {
self.size
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn volume_type(&self) -> ::std::option::Option<&crate::types::VolumeType> {
self.volume_type.as_ref()
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li>
/// <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li>
/// <li> <p> <code>io2</code>: 100-64,000 IOPS</p> </li>
/// </ul>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn iops(&self) -> ::std::option::Option<i32> {
self.iops
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 1,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>
pub fn throughput(&self) -> ::std::option::Option<i32> {
self.throughput
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn multi_attach_enabled(&self) -> ::std::option::Option<bool> {
self.multi_attach_enabled
}
}
impl ModifyVolumeInput {
/// Creates a new builder-style object to manufacture [`ModifyVolumeInput`](crate::operation::modify_volume::ModifyVolumeInput).
pub fn builder() -> crate::operation::modify_volume::builders::ModifyVolumeInputBuilder {
crate::operation::modify_volume::builders::ModifyVolumeInputBuilder::default()
}
}
/// A builder for [`ModifyVolumeInput`](crate::operation::modify_volume::ModifyVolumeInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct ModifyVolumeInputBuilder {
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) volume_id: ::std::option::Option<::std::string::String>,
pub(crate) size: ::std::option::Option<i32>,
pub(crate) volume_type: ::std::option::Option<crate::types::VolumeType>,
pub(crate) iops: ::std::option::Option<i32>,
pub(crate) throughput: ::std::option::Option<i32>,
pub(crate) multi_attach_enabled: ::std::option::Option<bool>,
}
impl ModifyVolumeInputBuilder {
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.dry_run = ::std::option::Option::Some(input);
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.dry_run = input;
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
&self.dry_run
}
/// <p>The ID of the volume.</p>
pub fn volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.volume_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the volume.</p>
pub fn set_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.volume_id = input;
self
}
/// <p>The ID of the volume.</p>
pub fn get_volume_id(&self) -> &::std::option::Option<::std::string::String> {
&self.volume_id
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li>
/// <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li>
/// <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li>
/// <li> <p> <code>standard</code>: 1-1,024</p> </li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn size(mut self, input: i32) -> Self {
self.size = ::std::option::Option::Some(input);
self
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li>
/// <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li>
/// <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li>
/// <li> <p> <code>standard</code>: 1-1,024</p> </li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn set_size(mut self, input: ::std::option::Option<i32>) -> Self {
self.size = input;
self
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li>
/// <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li>
/// <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li>
/// <li> <p> <code>standard</code>: 1-1,024</p> </li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn get_size(&self) -> &::std::option::Option<i32> {
&self.size
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn volume_type(mut self, input: crate::types::VolumeType) -> Self {
self.volume_type = ::std::option::Option::Some(input);
self
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn set_volume_type(mut self, input: ::std::option::Option<crate::types::VolumeType>) -> Self {
self.volume_type = input;
self
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn get_volume_type(&self) -> &::std::option::Option<crate::types::VolumeType> {
&self.volume_type
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li>
/// <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li>
/// <li> <p> <code>io2</code>: 100-64,000 IOPS</p> </li>
/// </ul>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn iops(mut self, input: i32) -> Self {
self.iops = ::std::option::Option::Some(input);
self
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li>
/// <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li>
/// <li> <p> <code>io2</code>: 100-64,000 IOPS</p> </li>
/// </ul>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn set_iops(mut self, input: ::std::option::Option<i32>) -> Self {
self.iops = input;
self
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li>
/// <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li>
/// <li> <p> <code>io2</code>: 100-64,000 IOPS</p> </li>
/// </ul>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn get_iops(&self) -> &::std::option::Option<i32> {
&self.iops
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 1,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>
pub fn throughput(mut self, input: i32) -> Self {
self.throughput = ::std::option::Option::Some(input);
self
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 1,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>
pub fn set_throughput(mut self, input: ::std::option::Option<i32>) -> Self {
self.throughput = input;
self
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 1,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>
pub fn get_throughput(&self) -> &::std::option::Option<i32> {
&self.throughput
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn multi_attach_enabled(mut self, input: bool) -> Self {
self.multi_attach_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn set_multi_attach_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.multi_attach_enabled = input;
self
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn get_multi_attach_enabled(&self) -> &::std::option::Option<bool> {
&self.multi_attach_enabled
}
/// Consumes the builder and constructs a [`ModifyVolumeInput`](crate::operation::modify_volume::ModifyVolumeInput).
pub fn build(self) -> ::std::result::Result<crate::operation::modify_volume::ModifyVolumeInput, ::aws_smithy_http::operation::error::BuildError> {
::std::result::Result::Ok(crate::operation::modify_volume::ModifyVolumeInput {
dry_run: self.dry_run,
volume_id: self.volume_id,
size: self.size,
volume_type: self.volume_type,
iops: self.iops,
throughput: self.throughput,
multi_attach_enabled: self.multi_attach_enabled,
})
}
}