Struct aws_sdk_ssm::client::fluent_builders::StartChangeRequestExecution

pub struct StartChangeRequestExecution { /* private fields */ }

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

impl StartChangeRequestExecution

pub async fn send(
    self
) -> Result<StartChangeRequestExecutionOutput, SdkError<StartChangeRequestExecutionError>>

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.

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.

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.

pub fn document_name(self, input: impl Into<String>) -> Self

The name of the change template document to run during the runbook workflow.

pub fn set_document_name(self, input: Option<String>) -> Self

The name of the change template document to run during the runbook workflow.

pub fn document_version(self, input: impl Into<String>) -> Self

The version of the change template document to run during the runbook workflow.

pub fn set_document_version(self, input: Option<String>) -> Self

The version of the change template document to run during the runbook workflow.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn tags(self, input: Tag) -> Self

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

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.

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.

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.

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.

Trait Implementations

impl Clone for StartChangeRequestExecution

fn clone(&self) -> StartChangeRequestExecution

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartChangeRequestExecution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.