Class TargetLocation

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

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

See Also:

  • Method Details

    • hasAccounts

      public final boolean hasAccounts()
      For responses, this returns true if the service returned a value for the Accounts 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.

    • accounts

      public final List<String> accounts()

      The Amazon Web Services accounts targeted by the current Automation execution.

      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 hasAccounts() method.

      Returns:
      The Amazon Web Services accounts targeted by the current Automation execution.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions 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.

    • regions

      public final List<String> regions()

      The Amazon Web Services Regions targeted by the current Automation execution.

      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 hasRegions() method.

      Returns:
      The Amazon Web Services Regions targeted by the current Automation execution.

    • targetLocationMaxConcurrency

      public final String targetLocationMaxConcurrency()

      The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

      Returns:
      The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

    • targetLocationMaxErrors

      public final String targetLocationMaxErrors()

      The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

      Returns:
      The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

    • executionRoleName

      public final String executionRoleName()

      The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

      Returns:
      The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

    • targetLocationAlarmConfiguration

      public final AlarmConfiguration targetLocationAlarmConfiguration()
      Returns the value of the TargetLocationAlarmConfiguration property for this object.
      Returns:
      The value of the TargetLocationAlarmConfiguration property for this object.

    • includeChildOrganizationUnits

      public final Boolean includeChildOrganizationUnits()

      Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.

      Returns:
      Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.

    • hasExcludeAccounts

      public final boolean hasExcludeAccounts()
      For responses, this returns true if the service returned a value for the ExcludeAccounts 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.

    • excludeAccounts

      public final List<String> excludeAccounts()

      Amazon Web Services accounts or organizational units to exclude as expanded targets.

      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 hasExcludeAccounts() method.

      Returns:
      Amazon Web Services accounts or organizational units to exclude as expanded targets.

    • hasTargets

      public final boolean hasTargets()
      For responses, this returns true if the service returned a value for the Targets 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.

    • targets

      public final List<Target> targets()

      A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.

      This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.

      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 hasTargets() method.

      Returns:
      A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.

      This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.

    • targetsMaxConcurrency

      public final String targetsMaxConcurrency()

      The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.

      Returns:
      The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.

    • targetsMaxErrors

      public final String targetsMaxErrors()

      The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.

      Returns:
      The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.

    • toBuilder

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

    • builder

      public static TargetLocation.Builder builder()

    • serializableBuilderClass

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