Struct aws_sdk_ssm::operation::start_session::builders::StartSessionInputBuilder

#[non_exhaustive]
pub struct StartSessionInputBuilder { /* private fields */ }

A builder for StartSessionInput.

Implementations

impl StartSessionInputBuilder

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

The managed node to connect to for the session.

This field is required.

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

The managed node to connect to for the session.

pub fn get_target(&self) -> &Option<String>

The managed node to connect to for the session.

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

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 set_document_name(self, input: Option<String>) -> Self

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 get_document_name(&self) -> &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.

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

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 set_reason(self, input: Option<String>) -> Self

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 get_reason(&self) -> &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.

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.

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

pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self

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

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

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

pub fn build(self) -> Result<StartSessionInput, BuildError>

Consumes the builder and constructs a StartSessionInput.

impl StartSessionInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartSessionOutput, SdkError<StartSessionError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartSessionInputBuilder

fn clone(&self) -> StartSessionInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartSessionInputBuilder

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

Formats the value using the given formatter.

impl Default for StartSessionInputBuilder

fn default() -> StartSessionInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartSessionInputBuilder

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