Package software.amazon.awssdk.services.ssm.model

Interface StartSessionRequest.Builder

    • Method Detail

      • target

        StartSessionRequest.Builder target​(String target)

        The managed node to connect to for the session.

        Parameters:
        target - The managed node to connect to for the session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentName

        StartSessionRequest.Builder documentName​(String documentName)

        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.

        Parameters:
        documentName - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reason

        StartSessionRequest.Builder reason​(String reason)

        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:
        reason - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameters

        StartSessionRequest.Builder parameters​(Map<String,​? extends Collection<String>> parameters)

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

        Parameters:
        parameters - The values you want to specify for the parameters defined in the Session document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.