Struct aws_sdk_ssm::operation::start_change_request_execution::StartChangeRequestExecutionInput

#[non_exhaustive]
pub struct StartChangeRequestExecutionInput {
    pub scheduled_time: Option<DateTime>,
    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub change_request_name: Option<String>,
    pub client_token: Option<String>,
    pub auto_approve: Option<bool>,
    pub runbooks: Option<Vec<Runbook>>,
    pub tags: Option<Vec<Tag>>,
    pub scheduled_end_time: Option<DateTime>,
    pub change_details: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scheduled_time: 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.

document_name: Option<String>

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

document_version: Option<String>

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

parameters: Option<HashMap<String, Vec<String>>>

A key-value map of parameters that match the declared parameters in the change template document.

change_request_name: Option<String>

The name of the change request associated with the runbook workflow to be run.

client_token: Option<String>

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

auto_approve: 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.

runbooks: 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.

tags: Option<Vec<Tag>>

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

scheduled_end_time: 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.

change_details: 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.

Implementations

impl StartChangeRequestExecutionInput

pub fn 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.

pub fn document_name(&self) -> Option<&str>

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

pub fn document_version(&self) -> Option<&str>

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

pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>

A key-value map of parameters that match the declared parameters in the change template document.

pub fn change_request_name(&self) -> Option<&str>

The name of the change request associated with the runbook workflow to be run.

pub fn client_token(&self) -> Option<&str>

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) -> 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.

pub fn runbooks(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .runbooks.is_none().

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn 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.

pub fn change_details(&self) -> Option<&str>

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.

impl StartChangeRequestExecutionInput

pub fn builder() -> StartChangeRequestExecutionInputBuilder

Creates a new builder-style object to manufacture StartChangeRequestExecutionInput.

Trait Implementations

impl Clone for StartChangeRequestExecutionInput

fn clone(&self) -> StartChangeRequestExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartChangeRequestExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for StartChangeRequestExecutionInput

fn eq(&self, other: &StartChangeRequestExecutionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartChangeRequestExecutionInput