Class: Aws::SSM::Types::TargetLocation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accounts ⇒ Array<String>

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

Returns:

  • (Array<String>)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_accounts ⇒ Array<String>

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

Returns:

  • (Array<String>)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_name ⇒ String

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

Returns:

  • (String)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#include_child_organization_units ⇒ Boolean

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

Returns:

  • (Boolean)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

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

Returns:

  • (Array<String>)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#target_location_alarm_configuration ⇒ Types::AlarmConfiguration

The details for the CloudWatch alarm you want to apply to an automation or command.



19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#target_location_max_concurrency ⇒ String

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency has a default value of 1.

Returns:

  • (String)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#target_location_max_errors ⇒ String

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors has a default value of 0.

Returns:

  • (String)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

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.

Returns:



19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#targets_max_concurrency ⇒ String

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:

  • (String)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end

#targets_max_errors ⇒ String

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:

  • (String)


19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 19970

class TargetLocation < Struct.new(
  :accounts,
  :regions,
  :target_location_max_concurrency,
  :target_location_max_errors,
  :execution_role_name,
  :target_location_alarm_configuration,
  :include_child_organization_units,
  :exclude_accounts,
  :targets,
  :targets_max_concurrency,
  :targets_max_errors)
  SENSITIVE = []
  include Aws::Structure
end