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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TargetLocation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`accounts()`	The Amazon Web Services accounts targeted by the current Automation execution.
`static TargetLocation.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`excludeAccounts()`	Amazon Web Services accounts or organizational units to exclude as expanded targets.
`String`	`executionRoleName()`	The Automation execution role used by the currently running Automation.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccounts()`	For responses, this returns true if the service returned a value for the Accounts property.
`boolean`	`hasExcludeAccounts()`	For responses, this returns true if the service returned a value for the ExcludeAccounts property.
`int`	`hashCode()`
`boolean`	`hasRegions()`	For responses, this returns true if the service returned a value for the Regions property.
`boolean`	`hasTargets()`	For responses, this returns true if the service returned a value for the Targets property.
`Boolean`	`includeChildOrganizationUnits()`	Indicates whether to include child organizational units (OUs) that are children of the targeted OUs.
`List<String>`	`regions()`	The Amazon Web Services Regions targeted by the current Automation execution.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TargetLocation.Builder>`	`serializableBuilderClass()`
`AlarmConfiguration`	`targetLocationAlarmConfiguration()`	Returns the value of the TargetLocationAlarmConfiguration property for this object.
`String`	`targetLocationMaxConcurrency()`	The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
`String`	`targetLocationMaxErrors()`	The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
`List<Target>`	`targets()`	A list of key-value mappings to target resources.
`String`	`targetsMaxConcurrency()`	The maximum number of targets allowed to run this task in parallel.
`String`	`targetsMaxErrors()`	The maximum number of errors that are allowed before the system stops running the automation on additional targets.
`TargetLocation.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TargetLocation.Builder,TargetLocation>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TargetLocation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAccounts

accounts

hasRegions

regions

targetLocationMaxConcurrency

targetLocationMaxErrors

executionRoleName

targetLocationAlarmConfiguration

includeChildOrganizationUnits

hasExcludeAccounts

excludeAccounts

hasTargets

targets

targetsMaxConcurrency

targetsMaxErrors

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField