Class: Aws::SSM::Types::AssociationVersionInfo

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

Overview

Information about the association version.

Constant Summary collapse

SENSITIVE =
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_only_at_cron_intervalBoolean

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don’t want an association to run immediately after you create it. This parameter isn’t supported for rate expressions.

Returns:

  • (Boolean)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_idString

The ID created by the system when the association was created.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_nameString

The name specified for the association version when the association version was created.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_versionString

The association version.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#calendar_namesArray<String>

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar].

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar

Returns:

  • (Array<String>)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#compliance_severityString

The severity level that is assigned to the association.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#created_dateTime

The date the association version was created.

Returns:

  • (Time)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_versionString

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#durationInteger

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

Returns:

  • (Integer)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_concurrencyString

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running ‘MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_errorsString

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set ‘MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when ‘MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set ‘MaxConcurrency` to 1 so that executions proceed one at a time.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#nameString

The name specified when the association was created.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

The location in Amazon S3 specified for the association when the association version was created.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#parametersHash<String,Array<String>>

Parameters specified when the association version was created.

Returns:

  • (Hash<String,Array<String>>)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_expressionString

The cron or rate schedule specified for the association when the association version was created.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_offsetInteger

Number of days to wait after the scheduled day to run an association.

Returns:

  • (Integer)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#sync_complianceString

The mode for generating association compliance. You can specify ‘AUTO` or `MANUAL`. In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT`. If the association execution doesn’t run successfully, the association is ‘NON-COMPLIANT`.

In ‘MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use ‘AUTO` mode.

Returns:

  • (String)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.

Returns:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_mapsArray<Hash<String,Array<String>>>

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.

Returns:

  • (Array<Hash<String,Array<String>>>)


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets specified for the association when the association version was created.

Returns:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/aws-sdk-ssm/types.rb', line 1022

class AssociationVersionInfo < Struct.new(
  :association_id,
  :association_version,
  :created_date,
  :name,
  :document_version,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps)
  SENSITIVE = [:parameters]
  include Aws::Structure
end