class Amazonite::Ssm::CreateAssociationBatchRequestEntry

Overview

Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

Included Modules

Defined in:

ssm/create_association_batch_request_entry.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String, instance_id : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, automation_target_parameter_name : String | Nil = nil, document_version : String | Nil = nil, targets : Array(Target) | Nil = nil, schedule_expression : String | Nil = nil, output_location : InstanceAssociationOutputLocation | Nil = nil, association_name : String | Nil = nil, max_errors : String | Nil = nil, max_concurrency : String | Nil = nil, compliance_severity : AssociationComplianceSeverity | Nil = nil, sync_compliance : AssociationSyncCompliance | Nil = nil, apply_only_at_cron_interval : Bool | Nil = nil, calendar_names : Array(String) | Nil = nil, target_locations : Array(TargetLocation) | Nil = nil, schedule_offset : Int32 | Nil = nil, duration : Int32 | Nil = nil, target_maps : Array(Hash(String, Array(String))) | Nil = nil, alarm_configuration : AlarmConfiguration | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def alarm_configuration : AlarmConfiguration | Nil #

[View source]
def alarm_configuration=(alarm_configuration : AlarmConfiguration | Nil) #

[View source]
def apply_only_at_cron_interval : Bool | Nil #

By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.

For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.

This parameter isn't supported for rate expressions.


[View source]
def apply_only_at_cron_interval=(apply_only_at_cron_interval : Bool | Nil) #

By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.

For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.

This parameter isn't supported for rate expressions.


[View source]
def association_name : String | Nil #

Specify a descriptive name for the association.


[View source]
def association_name=(association_name : String | Nil) #

Specify a descriptive name for the association.


[View source]
def automation_target_parameter_name : String | Nil #

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 tool in Amazon Web Services Systems Manager.


[View source]
def automation_target_parameter_name=(automation_target_parameter_name : String | Nil) #

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 tool in Amazon Web Services Systems Manager.


[View source]
def calendar_names : Array(String) | Nil #

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 in the Amazon Web Services Systems Manager User Guide.


[View source]
def calendar_names=(calendar_names : Array(String) | Nil) #

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 in the Amazon Web Services Systems Manager User Guide.


[View source]
def compliance_severity : AssociationComplianceSeverity | Nil #

The severity level to assign to the association.


[View source]
def compliance_severity=(compliance_severity : AssociationComplianceSeverity | Nil) #

The severity level to assign to the association.


[View source]
def document_version : String | Nil #

The document version.


[View source]
def document_version=(document_version : String | Nil) #

The document version.


[View source]
def duration : Int32 | Nil #

The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

The Duration parameter applies only when both these conditions are true:

  • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

  • The command specifies the [ApplyOnlyAtCronInterval](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval) parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.


[View source]
def duration=(duration : Int32 | Nil) #

The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

The Duration parameter applies only when both these conditions are true:

  • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

  • The command specifies the [ApplyOnlyAtCronInterval](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval) parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def instance_id : String | Nil #

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.


[View source]
def instance_id=(instance_id : String | Nil) #

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.


[View source]
def max_concurrency : String | Nil #

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.


[View source]
def max_concurrency=(max_concurrency : String | Nil) #

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.


[View source]
def max_errors : String | Nil #

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.


[View source]
def max_errors=(max_errors : String | Nil) #

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.


[View source]
def 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.


[View source]
def name=(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.


[View source]
def output_location : InstanceAssociationOutputLocation | Nil #

An S3 bucket where you want to store the results of this request.


[View source]
def output_location=(output_location : InstanceAssociationOutputLocation | Nil) #

An S3 bucket where you want to store the results of this request.


[View source]
def parameters : Hash(String, Array(String)) | Nil #

A description of the parameters for a document.


[View source]
def parameters=(parameters : Hash(String, Array(String)) | Nil) #

A description of the parameters for a document.


[View source]
def schedule_expression : String | Nil #

A cron expression that specifies a schedule when the association runs.


[View source]
def schedule_expression=(schedule_expression : String | Nil) #

A cron expression that specifies a schedule when the association runs.


[View source]
def schedule_offset : Int32 | Nil #

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


[View source]
def schedule_offset=(schedule_offset : Int32 | Nil) #

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


[View source]
def sync_compliance : AssociationSyncCompliance | Nil #

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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.


[View source]
def sync_compliance=(sync_compliance : AssociationSyncCompliance | Nil) #

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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.


[View source]
def target_locations : Array(TargetLocation) | Nil #

Use this action to create an association in multiple Regions and multiple accounts.


[View source]
def target_locations=(target_locations : Array(TargetLocation) | Nil) #

Use this action to create an association in multiple Regions and multiple accounts.


[View source]
def target_maps : Array(Hash(String, Array(String))) | Nil #

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


[View source]
def target_maps=(target_maps : Array(Hash(String, Array(String))) | Nil) #

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


[View source]
def targets : Array(Target) | Nil #

The managed nodes targeted by the request.


[View source]
def targets=(targets : Array(Target) | Nil) #

The managed nodes targeted by the request.


[View source]
def validate! : Nil #

[View source]