pub struct StartChangeRequestExecutionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartChangeRequestExecution
.
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
Implementations§
Source§impl StartChangeRequestExecutionFluentBuilder
impl StartChangeRequestExecutionFluentBuilder
Sourcepub fn as_input(&self) -> &StartChangeRequestExecutionInputBuilder
pub fn as_input(&self) -> &StartChangeRequestExecutionInputBuilder
Access the StartChangeRequestExecution as a reference.
Sourcepub async fn send(
self,
) -> Result<StartChangeRequestExecutionOutput, SdkError<StartChangeRequestExecutionError, HttpResponse>>
pub async fn send( self, ) -> Result<StartChangeRequestExecutionOutput, SdkError<StartChangeRequestExecutionError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartChangeRequestExecutionOutput, StartChangeRequestExecutionError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartChangeRequestExecutionOutput, StartChangeRequestExecutionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn scheduled_time(self, input: DateTime) -> Self
pub fn scheduled_time(self, input: DateTime) -> Self
The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Sourcepub fn set_scheduled_time(self, input: Option<DateTime>) -> Self
pub fn set_scheduled_time(self, input: Option<DateTime>) -> Self
The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Sourcepub fn get_scheduled_time(&self) -> &Option<DateTime>
pub fn get_scheduled_time(&self) -> &Option<DateTime>
The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Sourcepub fn document_name(self, input: impl Into<String>) -> Self
pub fn document_name(self, input: impl Into<String>) -> Self
The name of the change template document to run during the runbook workflow.
Sourcepub fn set_document_name(self, input: Option<String>) -> Self
pub fn set_document_name(self, input: Option<String>) -> Self
The name of the change template document to run during the runbook workflow.
Sourcepub fn get_document_name(&self) -> &Option<String>
pub fn get_document_name(&self) -> &Option<String>
The name of the change template document to run during the runbook workflow.
Sourcepub fn document_version(self, input: impl Into<String>) -> Self
pub fn document_version(self, input: impl Into<String>) -> Self
The version of the change template document to run during the runbook workflow.
Sourcepub fn set_document_version(self, input: Option<String>) -> Self
pub fn set_document_version(self, input: Option<String>) -> Self
The version of the change template document to run during the runbook workflow.
Sourcepub fn get_document_version(&self) -> &Option<String>
pub fn get_document_version(&self) -> &Option<String>
The version of the change template document to run during the runbook workflow.
Sourcepub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to Parameters
.
To override the contents of this collection use set_parameters
.
A key-value map of parameters that match the declared parameters in the change template document.
Sourcepub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
A key-value map of parameters that match the declared parameters in the change template document.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>
A key-value map of parameters that match the declared parameters in the change template document.
Sourcepub fn change_request_name(self, input: impl Into<String>) -> Self
pub fn change_request_name(self, input: impl Into<String>) -> Self
The name of the change request associated with the runbook workflow to be run.
Sourcepub fn set_change_request_name(self, input: Option<String>) -> Self
pub fn set_change_request_name(self, input: Option<String>) -> Self
The name of the change request associated with the runbook workflow to be run.
Sourcepub fn get_change_request_name(&self) -> &Option<String>
pub fn get_change_request_name(&self) -> &Option<String>
The name of the change request associated with the runbook workflow to be run.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
Sourcepub fn auto_approve(self, input: bool) -> Self
pub fn auto_approve(self, input: bool) -> Self
Indicates whether the change request can be approved automatically without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting AutoApprove
to true
in StartChangeRequestExecution
creates a change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED
, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN
.
Sourcepub fn set_auto_approve(self, input: Option<bool>) -> Self
pub fn set_auto_approve(self, input: Option<bool>) -> Self
Indicates whether the change request can be approved automatically without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting AutoApprove
to true
in StartChangeRequestExecution
creates a change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED
, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN
.
Sourcepub fn get_auto_approve(&self) -> &Option<bool>
pub fn get_auto_approve(&self) -> &Option<bool>
Indicates whether the change request can be approved automatically without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting AutoApprove
to true
in StartChangeRequestExecution
creates a change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED
, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN
.
Sourcepub fn runbooks(self, input: Runbook) -> Self
pub fn runbooks(self, input: Runbook) -> Self
Appends an item to Runbooks
.
To override the contents of this collection use set_runbooks
.
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Sourcepub fn set_runbooks(self, input: Option<Vec<Runbook>>) -> Self
pub fn set_runbooks(self, input: Option<Vec<Runbook>>) -> Self
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Sourcepub fn get_runbooks(&self) -> &Option<Vec<Runbook>>
pub fn get_runbooks(&self) -> &Option<Vec<Runbook>>
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
-
Key=Environment,Value=Production
-
Key=Region,Value=us-east-2
The Array Members
maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution
action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource
action to add up to a total of 50 tags to an existing change request configuration.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
-
Key=Environment,Value=Production
-
Key=Region,Value=us-east-2
The Array Members
maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution
action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource
action to add up to a total of 50 tags to an existing change request configuration.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
-
Key=Environment,Value=Production
-
Key=Region,Value=us-east-2
The Array Members
maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution
action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource
action to add up to a total of 50 tags to an existing change request configuration.
Sourcepub fn scheduled_end_time(self, input: DateTime) -> Self
pub fn scheduled_end_time(self, input: DateTime) -> Self
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
Sourcepub fn set_scheduled_end_time(self, input: Option<DateTime>) -> Self
pub fn set_scheduled_end_time(self, input: Option<DateTime>) -> Self
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
Sourcepub fn get_scheduled_end_time(&self) -> &Option<DateTime>
pub fn get_scheduled_end_time(&self) -> &Option<DateTime>
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
Sourcepub fn change_details(self, input: impl Into<String>) -> Self
pub fn change_details(self, input: impl Into<String>) -> Self
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
Sourcepub fn set_change_details(self, input: Option<String>) -> Self
pub fn set_change_details(self, input: Option<String>) -> Self
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
Sourcepub fn get_change_details(&self) -> &Option<String>
pub fn get_change_details(&self) -> &Option<String>
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
Trait Implementations§
Source§impl Clone for StartChangeRequestExecutionFluentBuilder
impl Clone for StartChangeRequestExecutionFluentBuilder
Source§fn clone(&self) -> StartChangeRequestExecutionFluentBuilder
fn clone(&self) -> StartChangeRequestExecutionFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartChangeRequestExecutionFluentBuilder
impl !RefUnwindSafe for StartChangeRequestExecutionFluentBuilder
impl Send for StartChangeRequestExecutionFluentBuilder
impl Sync for StartChangeRequestExecutionFluentBuilder
impl Unpin for StartChangeRequestExecutionFluentBuilder
impl !UnwindSafe for StartChangeRequestExecutionFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);