Struct aws_sdk_ssm::input::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 to define the parameters and plugin settings 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.

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

Reserved for future use.

Implementations

impl StartSessionInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StartSession, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartSession>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartSessionInput

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 to define the parameters and plugin settings 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.

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

Reserved for future use.

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<StartSessionInput> 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: &StartSessionInput) -> bool

This method tests for !=.

impl StructuralPartialEq for StartSessionInput