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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_environment::_update_environment_output::UpdateEnvironmentOutputBuilder;
pub use crate::operation::update_environment::_update_environment_input::UpdateEnvironmentInputBuilder;
impl UpdateEnvironmentInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::update_environment::UpdateEnvironmentOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_environment::UpdateEnvironmentError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.update_environment();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `UpdateEnvironment`.
///
/// <p>Update an environment.</p>
/// <p>If the environment is associated with an environment account connection, <i>don't</i> update or include the <code>protonServiceRoleArn</code> and <code>provisioningRepository</code> parameter to update or connect to an environment account connection.</p>
/// <p>You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.</p>
/// <p>If the environment <i>isn't</i> associated with an environment account connection, <i>don't</i> update or include the <code>environmentAccountConnectionId</code> parameter. You <i>can't</i> update or connect the environment to an environment account connection if it <i>isn't</i> already associated with an environment connection.</p>
/// <p>You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t update both.</p>
/// <p>If the environment was configured for Amazon Web Services-managed provisioning, omit the <code>provisioningRepository</code> parameter.</p>
/// <p>If the environment was configured for self-managed provisioning, specify the <code>provisioningRepository</code> parameter and omit the <code>protonServiceRoleArn</code> and <code>environmentAccountConnectionId</code> parameters.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton User Guide</i>.</p>
/// <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
/// <dl>
/// <dt></dt>
/// <dd>
/// <p> <code>NONE</code> </p>
/// <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>CURRENT_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MINOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MAJOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.</p>
/// </dd>
/// </dl>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateEnvironmentFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::update_environment::UpdateEnvironmentOutput,
crate::operation::update_environment::UpdateEnvironmentError,
> for UpdateEnvironmentFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::update_environment::UpdateEnvironmentOutput,
crate::operation::update_environment::UpdateEnvironmentError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl UpdateEnvironmentFluentBuilder {
/// Creates a new `UpdateEnvironment`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the UpdateEnvironment as a reference.
pub fn as_input(&self) -> &crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::update_environment::UpdateEnvironmentOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_environment::UpdateEnvironmentError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::update_environment::UpdateEnvironment::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::update_environment::UpdateEnvironment::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::update_environment::UpdateEnvironmentOutput,
crate::operation::update_environment::UpdateEnvironmentError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the environment to update.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of the environment to update.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The name of the environment to update.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_name()
}
/// <p>A description of the environment update.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description of the environment update.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>A description of the environment update.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_description()
}
/// <p>The formatted specification that defines the update.</p>
pub fn spec(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.spec(input.into());
self
}
/// <p>The formatted specification that defines the update.</p>
pub fn set_spec(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_spec(input);
self
}
/// <p>The formatted specification that defines the update.</p>
pub fn get_spec(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_spec()
}
/// <p>The major version of the environment to update.</p>
pub fn template_major_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.template_major_version(input.into());
self
}
/// <p>The major version of the environment to update.</p>
pub fn set_template_major_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_template_major_version(input);
self
}
/// <p>The major version of the environment to update.</p>
pub fn get_template_major_version(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_template_major_version()
}
/// <p>The minor version of the environment to update.</p>
pub fn template_minor_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.template_minor_version(input.into());
self
}
/// <p>The minor version of the environment to update.</p>
pub fn set_template_minor_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_template_minor_version(input);
self
}
/// <p>The minor version of the environment to update.</p>
pub fn get_template_minor_version(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_template_minor_version()
}
/// <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p>
pub fn proton_service_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.proton_service_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p>
pub fn set_proton_service_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_proton_service_role_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p>
pub fn get_proton_service_role_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_proton_service_role_arn()
}
/// <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
/// <dl>
/// <dt></dt>
/// <dd>
/// <p> <code>NONE</code> </p>
/// <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>CURRENT_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MINOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MAJOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</p>
/// </dd>
/// </dl>
pub fn deployment_type(mut self, input: crate::types::DeploymentUpdateType) -> Self {
self.inner = self.inner.deployment_type(input);
self
}
/// <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
/// <dl>
/// <dt></dt>
/// <dd>
/// <p> <code>NONE</code> </p>
/// <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>CURRENT_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MINOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MAJOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</p>
/// </dd>
/// </dl>
pub fn set_deployment_type(mut self, input: ::std::option::Option<crate::types::DeploymentUpdateType>) -> Self {
self.inner = self.inner.set_deployment_type(input);
self
}
/// <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
/// <dl>
/// <dt></dt>
/// <dd>
/// <p> <code>NONE</code> </p>
/// <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>CURRENT_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MINOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p>
/// </dd>
/// <dt></dt>
/// <dd>
/// <p> <code>MAJOR_VERSION</code> </p>
/// <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</p>
/// </dd>
/// </dl>
pub fn get_deployment_type(&self) -> &::std::option::Option<crate::types::DeploymentUpdateType> {
self.inner.get_deployment_type()
}
/// <p>The ID of the environment account connection.</p>
/// <p>You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.</p>
pub fn environment_account_connection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.environment_account_connection_id(input.into());
self
}
/// <p>The ID of the environment account connection.</p>
/// <p>You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.</p>
pub fn set_environment_account_connection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_environment_account_connection_id(input);
self
}
/// <p>The ID of the environment account connection.</p>
/// <p>You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.</p>
pub fn get_environment_account_connection_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_environment_account_connection_id()
}
/// <p>The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see <code>CreateRepository</code>.</p>
pub fn provisioning_repository(mut self, input: crate::types::RepositoryBranchInput) -> Self {
self.inner = self.inner.provisioning_repository(input);
self
}
/// <p>The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see <code>CreateRepository</code>.</p>
pub fn set_provisioning_repository(mut self, input: ::std::option::Option<crate::types::RepositoryBranchInput>) -> Self {
self.inner = self.inner.set_provisioning_repository(input);
self
}
/// <p>The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see <code>CreateRepository</code>.</p>
pub fn get_provisioning_repository(&self) -> &::std::option::Option<crate::types::RepositoryBranchInput> {
self.inner.get_provisioning_repository()
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</p>
/// <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
/// <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>
pub fn component_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.component_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</p>
/// <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
/// <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>
pub fn set_component_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_component_role_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</p>
/// <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
/// <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>
pub fn get_component_role_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_component_role_arn()
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</p>
pub fn codebuild_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.codebuild_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</p>
pub fn set_codebuild_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_codebuild_role_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</p>
pub fn get_codebuild_role_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_codebuild_role_arn()
}
}