You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Information about the association version.

Instance Attribute Summary collapse

Instance Attribute Details

#association_idString

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

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#association_nameString

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

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#association_versionString

The association version.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#compliance_severityString

The severity level that is assigned to the association.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#created_dateTime

The date the association version was created.

Returns:

  • (Time)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#document_versionString

The version of a Systems Manager document used when the association version was created.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  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 instances 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)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#nameString

The name specified when the association was created.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

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



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

Parameters specified when the association version was created.

Returns:

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


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end

#targetsArray<Types::Target>

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

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 715

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)
  include Aws::Structure
end