class Amazonite::Ssm::Association

Overview

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

Included Modules

JSON::Serializable

Defined in:

ssm/association.cr

Constructors

.new(pull : JSON::PullParser)
.new(name : String | Nil = nil, instance_id : String | Nil = nil, association_id : String | Nil = nil, association_version : String | Nil = nil, document_version : String | Nil = nil, targets : Array(Target) | Nil = nil, last_execution_date : Time | Nil = nil, overview : AssociationOverview | Nil = nil, schedule_expression : String | Nil = nil, association_name : String | Nil = nil, schedule_offset : Int32 | Nil = nil, duration : Int32 | Nil = nil, target_maps : Array(Hash(String, Array(String))) | Nil = nil)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#association_id : String | Nil
The ID created by the system when you create an association.
#association_id=(association_id : String | Nil)
The ID created by the system when you create an association.
#association_name : String | Nil
The association name.
#association_name=(association_name : String | Nil)
The association name.
#association_version : String | Nil
The association version.
#association_version=(association_version : String | Nil)
The association version.
#document_version : String | Nil
The version of the document used in the association.
#document_version=(document_version : String | Nil)
The version of the document used in the association.
#duration : Int32 | Nil
The number of hours that an association can run on specified targets.
#duration=(duration : Int32 | Nil)
The number of hours that an association can run on specified targets.
#hash(hasher)
See Object#hash(hasher)
#instance_id : String | Nil
The managed node ID.
#instance_id=(instance_id : String | Nil)
The managed node ID.
#last_execution_date : Time | Nil
The date on which the association was last run.
#last_execution_date=(last_execution_date : Time | Nil)
The date on which the association was last run.
#name : String | Nil
The name of the SSM document.
#name=(name : String | Nil)
The name of the SSM document.
#overview : AssociationOverview | Nil
Information about the association.
#overview=(overview : AssociationOverview | Nil)
Information about the association.
#schedule_expression : String | Nil
A cron expression that specifies a schedule when the association runs.
#schedule_expression=(schedule_expression : String | Nil)
A cron expression that specifies a schedule when the association runs.
#schedule_offset : Int32 | Nil
Number of days to wait after the scheduled day to run an association.
#schedule_offset=(schedule_offset : Int32 | Nil)
Number of days to wait after the scheduled day to run an association.
#target_maps : Array(Hash(String, Array(String))) | Nil
A key-value mapping of document parameters to target resources.
#target_maps=(target_maps : Array(Hash(String, Array(String))) | Nil)
A key-value mapping of document parameters to target resources.
#targets : Array(Target) | Nil
The managed nodes targeted by the request to create an association.
#targets=(targets : Array(Target) | Nil)
The managed nodes targeted by the request to create an association.
#validate! : Nil

Constructor Detail

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

[View source]

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[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 association_id : String | Nil #

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

[View source]

def association_id=(association_id : String | Nil) #

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

[View source]

def association_name : String | Nil #

The association name.

[View source]

def association_name=(association_name : String | Nil) #

The association name.

[View source]

def association_version : String | Nil #

The association version.

[View source]

def association_version=(association_version : String | Nil) #

The association version.

[View source]

def document_version : String | Nil #

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

[View source]

def document_version=(document_version : String | Nil) #

[View source]

def duration : Int32 | Nil #

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.

[View source]

def duration=(duration : Int32 | Nil) #

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def instance_id : String | Nil #

The managed node ID.

[View source]

def instance_id=(instance_id : String | Nil) #

The managed node ID.

[View source]

def last_execution_date : Time | Nil #

The date on which the association was last run.

[View source]

def last_execution_date=(last_execution_date : Time | Nil) #

The date on which the association was last run.

[View source]

def name : String | Nil #

The name of the SSM document.

[View source]

def name=(name : String | Nil) #

The name of the SSM document.

[View source]

def overview : AssociationOverview | Nil #

Information about the association.

[View source]

def overview=(overview : AssociationOverview | Nil) #

Information about the association.

[View source]

def schedule_expression : String | Nil #

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

[View source]

def schedule_expression=(schedule_expression : String | Nil) #

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

[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 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 to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

[View source]

def targets=(targets : Array(Target) | Nil) #

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

[View source]

def validate! : Nil #

[View source]