Struct aws_sdk_ssm::operation::start_session::StartSessionInput

#[non_exhaustive]
pub struct StartSessionInput {
    pub target: Option<String>,
    pub document_name: Option<String>,
    pub reason: Option<String>,
    pub parameters: Option<HashMap<String, Vec<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.

target: Option<String>

The managed node to connect to for the session.

document_name: Option<String>

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

reason: Option<String>

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

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

The values you want to specify for the parameters defined in the Session document.

Implementations

impl StartSessionInput

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

The managed node to connect to for the session.

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

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

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

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

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

The values you want to specify for the parameters defined in the Session document.

impl StartSessionInput

pub fn builder() -> StartSessionInputBuilder

Creates a new builder-style object to manufacture StartSessionInput.

Trait Implementations

impl Clone for StartSessionInput

fn clone(&self) -> StartSessionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartSessionInput

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

Formats the value using the given formatter.

impl PartialEq for StartSessionInput

fn eq(&self, other: &StartSessionInput) -> 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 StartSessionInput