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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Request to update an environment.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateEnvironmentInput {
/// <p>The name of the application with which the environment is associated.</p>
pub application_name: ::std::option::Option<::std::string::String>,
/// <p>The ID of the environment to update.</p>
/// <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub environment_id: ::std::option::Option<::std::string::String>,
/// <p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub environment_name: ::std::option::Option<::std::string::String>,
/// <p>The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.</p>
pub group_name: ::std::option::Option<::std::string::String>,
/// <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>This specifies the tier to use to update the environment.</p>
/// <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error.</p>
pub tier: ::std::option::Option<crate::types::EnvironmentTier>,
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error.</p>
pub version_label: ::std::option::Option<::std::string::String>,
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
pub template_name: ::std::option::Option<::std::string::String>,
/// <p>This specifies the platform version that the environment will run after the environment is updated.</p>
pub solution_stack_name: ::std::option::Option<::std::string::String>,
/// <p>The ARN of the platform, if used.</p>
pub platform_arn: ::std::option::Option<::std::string::String>,
/// <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>
pub option_settings: ::std::option::Option<::std::vec::Vec<crate::types::ConfigurationOptionSetting>>,
/// <p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>
pub options_to_remove: ::std::option::Option<::std::vec::Vec<crate::types::OptionSpecification>>,
}
impl UpdateEnvironmentInput {
/// <p>The name of the application with which the environment is associated.</p>
pub fn application_name(&self) -> ::std::option::Option<&str> {
self.application_name.as_deref()
}
/// <p>The ID of the environment to update.</p>
/// <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn environment_id(&self) -> ::std::option::Option<&str> {
self.environment_id.as_deref()
}
/// <p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn environment_name(&self) -> ::std::option::Option<&str> {
self.environment_name.as_deref()
}
/// <p>The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.</p>
pub fn group_name(&self) -> ::std::option::Option<&str> {
self.group_name.as_deref()
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>This specifies the tier to use to update the environment.</p>
/// <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error.</p>
pub fn tier(&self) -> ::std::option::Option<&crate::types::EnvironmentTier> {
self.tier.as_ref()
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error.</p>
pub fn version_label(&self) -> ::std::option::Option<&str> {
self.version_label.as_deref()
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
pub fn template_name(&self) -> ::std::option::Option<&str> {
self.template_name.as_deref()
}
/// <p>This specifies the platform version that the environment will run after the environment is updated.</p>
pub fn solution_stack_name(&self) -> ::std::option::Option<&str> {
self.solution_stack_name.as_deref()
}
/// <p>The ARN of the platform, if used.</p>
pub fn platform_arn(&self) -> ::std::option::Option<&str> {
self.platform_arn.as_deref()
}
/// <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.option_settings.is_none()`.
pub fn option_settings(&self) -> &[crate::types::ConfigurationOptionSetting] {
self.option_settings.as_deref().unwrap_or_default()
}
/// <p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.options_to_remove.is_none()`.
pub fn options_to_remove(&self) -> &[crate::types::OptionSpecification] {
self.options_to_remove.as_deref().unwrap_or_default()
}
}
impl UpdateEnvironmentInput {
/// Creates a new builder-style object to manufacture [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
pub fn builder() -> crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder {
crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder::default()
}
}
/// A builder for [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateEnvironmentInputBuilder {
pub(crate) application_name: ::std::option::Option<::std::string::String>,
pub(crate) environment_id: ::std::option::Option<::std::string::String>,
pub(crate) environment_name: ::std::option::Option<::std::string::String>,
pub(crate) group_name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) tier: ::std::option::Option<crate::types::EnvironmentTier>,
pub(crate) version_label: ::std::option::Option<::std::string::String>,
pub(crate) template_name: ::std::option::Option<::std::string::String>,
pub(crate) solution_stack_name: ::std::option::Option<::std::string::String>,
pub(crate) platform_arn: ::std::option::Option<::std::string::String>,
pub(crate) option_settings: ::std::option::Option<::std::vec::Vec<crate::types::ConfigurationOptionSetting>>,
pub(crate) options_to_remove: ::std::option::Option<::std::vec::Vec<crate::types::OptionSpecification>>,
}
impl UpdateEnvironmentInputBuilder {
/// <p>The name of the application with which the environment is associated.</p>
pub fn application_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.application_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the application with which the environment is associated.</p>
pub fn set_application_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.application_name = input;
self
}
/// <p>The name of the application with which the environment is associated.</p>
pub fn get_application_name(&self) -> &::std::option::Option<::std::string::String> {
&self.application_name
}
/// <p>The ID of the environment to update.</p>
/// <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.environment_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the environment to update.</p>
/// <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.environment_id = input;
self
}
/// <p>The ID of the environment to update.</p>
/// <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
&self.environment_id
}
/// <p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn environment_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.environment_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn set_environment_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.environment_name = input;
self
}
/// <p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
/// <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p>
pub fn get_environment_name(&self) -> &::std::option::Option<::std::string::String> {
&self.environment_name
}
/// <p>The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.</p>
pub fn group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.group_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.</p>
pub fn set_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.group_name = input;
self
}
/// <p>The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.</p>
pub fn get_group_name(&self) -> &::std::option::Option<::std::string::String> {
&self.group_name
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>This specifies the tier to use to update the environment.</p>
/// <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error.</p>
pub fn tier(mut self, input: crate::types::EnvironmentTier) -> Self {
self.tier = ::std::option::Option::Some(input);
self
}
/// <p>This specifies the tier to use to update the environment.</p>
/// <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error.</p>
pub fn set_tier(mut self, input: ::std::option::Option<crate::types::EnvironmentTier>) -> Self {
self.tier = input;
self
}
/// <p>This specifies the tier to use to update the environment.</p>
/// <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error.</p>
pub fn get_tier(&self) -> &::std::option::Option<crate::types::EnvironmentTier> {
&self.tier
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error.</p>
pub fn version_label(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_label = ::std::option::Option::Some(input.into());
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error.</p>
pub fn set_version_label(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_label = input;
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error.</p>
pub fn get_version_label(&self) -> &::std::option::Option<::std::string::String> {
&self.version_label
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
pub fn template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.template_name = ::std::option::Option::Some(input.into());
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
pub fn set_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.template_name = input;
self
}
/// <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p>
pub fn get_template_name(&self) -> &::std::option::Option<::std::string::String> {
&self.template_name
}
/// <p>This specifies the platform version that the environment will run after the environment is updated.</p>
pub fn solution_stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.solution_stack_name = ::std::option::Option::Some(input.into());
self
}
/// <p>This specifies the platform version that the environment will run after the environment is updated.</p>
pub fn set_solution_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.solution_stack_name = input;
self
}
/// <p>This specifies the platform version that the environment will run after the environment is updated.</p>
pub fn get_solution_stack_name(&self) -> &::std::option::Option<::std::string::String> {
&self.solution_stack_name
}
/// <p>The ARN of the platform, if used.</p>
pub fn platform_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.platform_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the platform, if used.</p>
pub fn set_platform_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.platform_arn = input;
self
}
/// <p>The ARN of the platform, if used.</p>
pub fn get_platform_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.platform_arn
}
/// Appends an item to `option_settings`.
///
/// To override the contents of this collection use [`set_option_settings`](Self::set_option_settings).
///
/// <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>
pub fn option_settings(mut self, input: crate::types::ConfigurationOptionSetting) -> Self {
let mut v = self.option_settings.unwrap_or_default();
v.push(input);
self.option_settings = ::std::option::Option::Some(v);
self
}
/// <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>
pub fn set_option_settings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ConfigurationOptionSetting>>) -> Self {
self.option_settings = input;
self
}
/// <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>
pub fn get_option_settings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ConfigurationOptionSetting>> {
&self.option_settings
}
/// Appends an item to `options_to_remove`.
///
/// To override the contents of this collection use [`set_options_to_remove`](Self::set_options_to_remove).
///
/// <p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>
pub fn options_to_remove(mut self, input: crate::types::OptionSpecification) -> Self {
let mut v = self.options_to_remove.unwrap_or_default();
v.push(input);
self.options_to_remove = ::std::option::Option::Some(v);
self
}
/// <p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>
pub fn set_options_to_remove(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionSpecification>>) -> Self {
self.options_to_remove = input;
self
}
/// <p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>
pub fn get_options_to_remove(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionSpecification>> {
&self.options_to_remove
}
/// Consumes the builder and constructs a [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_environment::UpdateEnvironmentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_environment::UpdateEnvironmentInput {
application_name: self.application_name,
environment_id: self.environment_id,
environment_name: self.environment_name,
group_name: self.group_name,
description: self.description,
tier: self.tier,
version_label: self.version_label,
template_name: self.template_name,
solution_stack_name: self.solution_stack_name,
platform_arn: self.platform_arn,
option_settings: self.option_settings,
options_to_remove: self.options_to_remove,
})
}
}