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.

Constant Summary collapse

SENSITIVE =
[]

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.

Returns:

  • (Boolean)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_idString

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

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_nameString

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

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_versionString

The association version.

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_severityString

The severity level that is assigned to the association.

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateTime

The date the association version was created.

Returns:

  • (Time)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

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

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  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)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  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)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name specified when the association was created.

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

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



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,Array<String>>

Parameters specified when the association version was created.

Returns:

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


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Returns:

  • (String)


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<Types::Target>

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

Returns:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 822

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)
  SENSITIVE = []
  include Aws::Structure
end