Class: Aws::SSM::Types::CreateAssociationBatchRequestEntry
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::CreateAssociationBatchRequestEntry
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
Constant Summary collapse
- SENSITIVE =
[:parameters]
Instance Attribute Summary collapse
-
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm you want to apply to an automation or command.
-
#apply_only_at_cron_interval ⇒ Boolean
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.
-
#association_name ⇒ String
Specify a descriptive name for the association.
-
#automation_target_parameter_name ⇒ String
Specify the target for the association.
-
#calendar_names ⇒ Array<String>
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
-
#compliance_severity ⇒ String
The severity level to assign to the association.
-
#document_version ⇒ String
The document version.
-
#instance_id ⇒ String
The managed node ID.
-
#max_concurrency ⇒ String
The maximum number of targets allowed to run the association at the same time.
-
#max_errors ⇒ String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
-
#name ⇒ String
The name of the SSM document that contains the configuration information for the managed node.
-
#output_location ⇒ Types::InstanceAssociationOutputLocation
An S3 bucket where you want to store the results of this request.
-
#parameters ⇒ Hash<String,Array<String>>
A description of the parameters for a document.
-
#schedule_expression ⇒ String
A cron expression that specifies a schedule when the association runs.
-
#schedule_offset ⇒ Integer
Number of days to wait after the scheduled day to run an association.
-
#sync_compliance ⇒ String
The mode for generating association compliance.
-
#target_locations ⇒ Array<Types::TargetLocation>
Use this action to create an association in multiple Regions and multiple accounts.
-
#target_maps ⇒ Array<Hash<String,Array<String>>>
A key-value mapping of document parameters to target resources.
-
#targets ⇒ Array<Types::Target>
The managed nodes targeted by the request.
Instance Attribute Details
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm you want to apply to an automation or command.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#apply_only_at_cron_interval ⇒ Boolean
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.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#association_name ⇒ String
Specify a descriptive name for the association.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#automation_target_parameter_name ⇒ String
Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#calendar_names ⇒ Array<String>
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#compliance_severity ⇒ String
The severity level to assign to the association.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#document_version ⇒ String
The document version.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#instance_id ⇒ String
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for
an association, use the Targets
parameter. Requests that include
the parameter InstanceID
with Systems Manager documents (SSM
documents) that use schema version 2.0 or later will fail. In
addition, if you use the parameter InstanceId
, you can't use the
parameters AssociationName
, DocumentVersion
, MaxErrors
,
MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use
these parameters, you must use the Targets
parameter.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#max_concurrency ⇒ String
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
.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#max_errors ⇒ String
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.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#name ⇒ String
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name.
For example, AWS-ApplyPatchBaseline
or My-Document
.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#output_location ⇒ Types::InstanceAssociationOutputLocation
An S3 bucket where you want to store the results of this request.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#parameters ⇒ Hash<String,Array<String>>
A description of the parameters for a document.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#schedule_expression ⇒ String
A cron expression that specifies a schedule when the association runs.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#schedule_offset ⇒ Integer
Number of days to wait after the scheduled day to run an association.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#sync_compliance ⇒ String
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.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#target_locations ⇒ Array<Types::TargetLocation>
Use this action to create an association in multiple Regions and multiple accounts.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#target_maps ⇒ Array<Hash<String,Array<String>>>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The managed nodes targeted by the request.
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2949 class CreateAssociationBatchRequestEntry < Struct.new( :name, :instance_id, :parameters, :automation_target_parameter_name, :document_version, :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, :target_maps, :alarm_configuration) SENSITIVE = [:parameters] include Aws::Structure end |