Class SsmAutomation

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

Details about the Systems Manager automation document that will be used as a runbook during an incident.

See Also:

  • Method Details

    • documentName

      public final String documentName()

      The automation document's name.

      Returns:
      The automation document's name.

    • documentVersion

      public final String documentVersion()

      The automation document's version to use when running.

      Returns:
      The automation document's version to use when running.

    • hasDynamicParameters

      public final boolean hasDynamicParameters()
      For responses, this returns true if the service returned a value for the DynamicParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dynamicParameters

      public final Map<String,DynamicSsmParameterValue> dynamicParameters()

      The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDynamicParameters() method.

      Returns:
      The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final Map<String,List<String>> parameters()

      The key-value pair parameters to use when running the automation document.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      The key-value pair parameters to use when running the automation document.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

      Returns:
      The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

    • targetAccount

      public final SsmTargetAccount targetAccount()

      The account that the automation document will be run in. This can be in either the management account or an application account.

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

      Returns:
      The account that the automation document will be run in. This can be in either the management account or an application account.
      See Also:

    • targetAccountAsString

      public final String targetAccountAsString()

      The account that the automation document will be run in. This can be in either the management account or an application account.

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

      Returns:
      The account that the automation document will be run in. This can be in either the management account or an application account.
      See Also:

    • toBuilder

      public SsmAutomation.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<SsmAutomation.Builder,SsmAutomation>
      Returns:
      a builder for type T

    • builder

      public static SsmAutomation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SsmAutomation.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.