Class CommandPlugin

java.lang.Object
software.amazon.awssdk.services.ssm.model.CommandPlugin
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CommandPlugin.Builder,CommandPlugin>
@Generated("software.amazon.awssdk:codegen") public final class CommandPlugin extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CommandPlugin.Builder,CommandPlugin>

Describes plugin details.

See Also:

  • Method Details

    • name

      public final 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.

      Returns:
      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.

    • status

      public final CommandPluginStatus status()

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

      If the service returns an enum value that is not available in the current SDK version, status will return CommandPluginStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of this plugin. You can run a document with multiple plugins.
      See Also:

    • statusAsString

      public final String statusAsString()

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

      If the service returns an enum value that is not available in the current SDK version, status will return CommandPluginStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of this plugin. You can run a document with multiple plugins.
      See Also:

    • statusDetails

      public final 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.

      Returns:
      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.

    • responseCode

      public final Integer responseCode()

      A numeric response code generated after running the plugin.

      Returns:
      A numeric response code generated after running the plugin.

    • responseStartDateTime

      public final Instant responseStartDateTime()

      The time the plugin started running.

      Returns:
      The time the plugin started running.

    • responseFinishDateTime

      public final Instant responseFinishDateTime()

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

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

    • output

      public final String output()

      Output of the plugin execution.

      Returns:
      Output of the plugin execution.

    • standardOutputUrl

      public final 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.

      Returns:
      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.

    • standardErrorUrl

      public final 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.

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

    • outputS3Region

      public final 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.

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

    • outputS3BucketName

      public final 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:

      amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

      amzn-s3-demo-bucket is the name of the S3 bucket;

      my-prefix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

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

      amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

      amzn-s3-demo-bucket is the name of the S3 bucket;

      my-prefix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

    • outputS3KeyPrefix

      public final 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:

      amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

      amzn-s3-demo-bucket is the name of the S3 bucket;

      my-prefix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

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

      amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

      amzn-s3-demo-bucket is the name of the S3 bucket;

      my-prefix is the name of the S3 prefix;

      i-02573cafcfEXAMPLE is the managed node ID;

      awsrunShellScript is the name of the plugin.

    • toBuilder

      public CommandPlugin.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CommandPlugin.Builder,CommandPlugin>
      Returns:
      a builder for type T

    • builder

      public static CommandPlugin.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CommandPlugin.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.