Interface TargetLocation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TargetLocation.Builder,
,TargetLocation> SdkBuilder<TargetLocation.Builder,
,TargetLocation> SdkPojo
- Enclosing class:
TargetLocation
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Web Services accounts targeted by the current Automation execution.accounts
(Collection<String> accounts) The Amazon Web Services accounts targeted by the current Automation execution.excludeAccounts
(String... excludeAccounts) Amazon Web Services accounts or organizational units to exclude as expanded targets.excludeAccounts
(Collection<String> excludeAccounts) Amazon Web Services accounts or organizational units to exclude as expanded targets.executionRoleName
(String executionRoleName) The Automation execution role used by the currently running Automation.includeChildOrganizationUnits
(Boolean includeChildOrganizationUnits) Indicates whether to include child organizational units (OUs) that are children of the targeted OUs.The Amazon Web Services Regions targeted by the current Automation execution.regions
(Collection<String> regions) The Amazon Web Services Regions targeted by the current Automation execution.default TargetLocation.Builder
targetLocationAlarmConfiguration
(Consumer<AlarmConfiguration.Builder> targetLocationAlarmConfiguration) Sets the value of the TargetLocationAlarmConfiguration property for this object.targetLocationAlarmConfiguration
(AlarmConfiguration targetLocationAlarmConfiguration) Sets the value of the TargetLocationAlarmConfiguration property for this object.targetLocationMaxConcurrency
(String targetLocationMaxConcurrency) The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.targetLocationMaxErrors
(String targetLocationMaxErrors) The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.targets
(Collection<Target> targets) A list of key-value mappings to target resources.targets
(Consumer<Target.Builder>... targets) A list of key-value mappings to target resources.A list of key-value mappings to target resources.targetsMaxConcurrency
(String targetsMaxConcurrency) The maximum number of targets allowed to run this task in parallel.targetsMaxErrors
(String targetsMaxErrors) The maximum number of errors that are allowed before the system stops running the automation on additional targets.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
accounts
The Amazon Web Services accounts targeted by the current Automation execution.
- Parameters:
accounts
- The Amazon Web Services accounts targeted by the current Automation execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accounts
The Amazon Web Services accounts targeted by the current Automation execution.
- Parameters:
accounts
- The Amazon Web Services accounts targeted by the current Automation execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
The Amazon Web Services Regions targeted by the current Automation execution.
- Parameters:
regions
- The Amazon Web Services Regions targeted by the current Automation execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
The Amazon Web Services Regions targeted by the current Automation execution.
- Parameters:
regions
- The Amazon Web Services Regions targeted by the current Automation execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocationMaxConcurrency
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
- Parameters:
targetLocationMaxConcurrency
- The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocationMaxErrors
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
- Parameters:
targetLocationMaxErrors
- The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionRoleName
The Automation execution role used by the currently running Automation. If not specified, the default value is
AWS-SystemsManager-AutomationExecutionRole
.- Parameters:
executionRoleName
- The Automation execution role used by the currently running Automation. If not specified, the default value isAWS-SystemsManager-AutomationExecutionRole
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocationAlarmConfiguration
TargetLocation.Builder targetLocationAlarmConfiguration(AlarmConfiguration targetLocationAlarmConfiguration) Sets the value of the TargetLocationAlarmConfiguration property for this object.- Parameters:
targetLocationAlarmConfiguration
- The new value for the TargetLocationAlarmConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocationAlarmConfiguration
default TargetLocation.Builder targetLocationAlarmConfiguration(Consumer<AlarmConfiguration.Builder> targetLocationAlarmConfiguration) Sets the value of the TargetLocationAlarmConfiguration property for this object. This is a convenience method that creates an instance of theAlarmConfiguration.Builder
avoiding the need to create one manually viaAlarmConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetLocationAlarmConfiguration(AlarmConfiguration)
.- Parameters:
targetLocationAlarmConfiguration
- a consumer that will call methods onAlarmConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
includeChildOrganizationUnits
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is
false
.- Parameters:
includeChildOrganizationUnits
- Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
excludeAccounts
Amazon Web Services accounts or organizational units to exclude as expanded targets.
- Parameters:
excludeAccounts
- Amazon Web Services accounts or organizational units to exclude as expanded targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
excludeAccounts
Amazon Web Services accounts or organizational units to exclude as expanded targets.
- Parameters:
excludeAccounts
- Amazon Web Services accounts or organizational units to exclude as expanded targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theStartAutomationExecution:Targets
parameter if both are supplied.- Parameters:
targets
- A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value forTargetParameterName
.This
Targets
parameter takes precedence over theStartAutomationExecution:Targets
parameter if both are supplied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theStartAutomationExecution:Targets
parameter if both are supplied.- Parameters:
targets
- A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value forTargetParameterName
.This
Targets
parameter takes precedence over theStartAutomationExecution:Targets
parameter if both are supplied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theTargets
parameter takes precedence over theStartAutomationExecution:Targets
parameter if both are supplied.Target.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargets(List<Target>)
.- Parameters:
targets
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetsMaxConcurrency
The maximum number of targets allowed to run this task in parallel. This
TargetsMaxConcurrency
takes precedence over theStartAutomationExecution:MaxConcurrency
parameter if both are supplied.- Parameters:
targetsMaxConcurrency
- The maximum number of targets allowed to run this task in parallel. ThisTargetsMaxConcurrency
takes precedence over theStartAutomationExecution:MaxConcurrency
parameter if both are supplied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theStartAutomationExecution:MaxErrors
parameter if both are supplied.- Parameters:
targetsMaxErrors
- The maximum number of errors that are allowed before the system stops running the automation on additional targets. ThisTargetsMaxErrors
parameter takes precedence over theStartAutomationExecution:MaxErrors
parameter if both are supplied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-