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

Interface CommandPlugin.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CommandPlugin.Builder,CommandPlugin>, SdkBuilder<CommandPlugin.Builder,CommandPlugin>, SdkPojo
Enclosing class:
CommandPlugin
public static interface CommandPlugin.Builder extends SdkPojo, CopyableBuilder<CommandPlugin.Builder,CommandPlugin>

  • Method Details

    • name

      CommandPlugin.Builder name(String name)

      The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

      Parameters:
      name - The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      CommandPlugin.Builder status(String status)

      The status of this plugin. You can run a document with multiple plugins.

      Parameters:
      status - The status of this plugin. You can run a document with multiple plugins.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CommandPlugin.Builder status(CommandPluginStatus status)

      The status of this plugin. You can run a document with multiple plugins.

      Parameters:
      status - The status of this plugin. You can run a document with multiple plugins.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusDetails

      CommandPlugin.Builder statusDetails(String statusDetails)

      A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

      • Pending: The command hasn't been sent to the managed node.

      • In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

      • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

      • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

      • Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

      • Cancelled: The command was terminated before it was completed. This is a terminal state.

      • Undeliverable: The command can't be delivered to the managed node. The managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

      Parameters:
      statusDetails - A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

      • Pending: The command hasn't been sent to the managed node.

      • In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

      • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

      • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

      • Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

      • Cancelled: The command was terminated before it was completed. This is a terminal state.

      • Undeliverable: The command can't be delivered to the managed node. The managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseCode

      CommandPlugin.Builder responseCode(Integer responseCode)

      A numeric response code generated after running the plugin.

      Parameters:
      responseCode - A numeric response code generated after running the plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseStartDateTime

      CommandPlugin.Builder responseStartDateTime(Instant responseStartDateTime)

      The time the plugin started running.

      Parameters:
      responseStartDateTime - The time the plugin started running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseFinishDateTime

      CommandPlugin.Builder responseFinishDateTime(Instant responseFinishDateTime)

      The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

      Parameters:
      responseFinishDateTime - The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • output

      CommandPlugin.Builder output(String output)

      Output of the plugin execution.

      Parameters:
      output - Output of the plugin execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardOutputUrl

      CommandPlugin.Builder standardOutputUrl(String standardOutputUrl)

      The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.

      Parameters:
      standardOutputUrl - The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardErrorUrl

      CommandPlugin.Builder standardErrorUrl(String standardErrorUrl)

      The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.

      Parameters:
      standardErrorUrl - The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3Region

      CommandPlugin.Builder outputS3Region(String outputS3Region)

      (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.

      Parameters:
      outputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3BucketName

      CommandPlugin.Builder outputS3BucketName(String outputS3BucketName)

      The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

      doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

      doc-example-bucket is the name of the S3 bucket;

      ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

      Parameters:
      outputS3BucketName - The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

      doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

      doc-example-bucket is the name of the S3 bucket;

      ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3KeyPrefix

      CommandPlugin.Builder outputS3KeyPrefix(String outputS3KeyPrefix)

      The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

      doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

      doc-example-bucket is the name of the S3 bucket;

      ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

      Parameters:
      outputS3KeyPrefix - The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

      doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

      doc-example-bucket is the name of the S3 bucket;

      ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

      Returns:
      Returns a reference to this object so that method calls can be chained together.