class Amazonite::Ssm::AssociationDescription

• Amazonite::Ssm::AssociationDescription
• Reference
• Object

Overview

Describes the parameters for a document.

Included Modules

• JSON::Serializable

Defined in:

ssm/association_description.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(name : String | Nil = nil, instance_id : String | Nil = nil, association_version : String | Nil = nil, date : Time | Nil = nil, last_update_association_date : Time | Nil = nil, status : AssociationStatus | Nil = nil, overview : AssociationOverview | Nil = nil, document_version : String | Nil = nil, automation_target_parameter_name : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, association_id : String | Nil = nil, targets : Array(Target) | Nil = nil, schedule_expression : String | Nil = nil, output_location : InstanceAssociationOutputLocation | Nil = nil, last_execution_date : Time | Nil = nil, last_successful_execution_date : Time | 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, triggered_alarms : Array(AlarmStateInformation) | Nil = nil, association_dispatch_assume_role : 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.

• #alarm_configuration : AlarmConfiguration | Nil
• #alarm_configuration=(alarm_configuration : AlarmConfiguration | Nil)
• #apply_only_at_cron_interval : Bool | Nil

  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.

• #apply_only_at_cron_interval=(apply_only_at_cron_interval : Bool | Nil)

  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_dispatch_assume_role : String | Nil

  A role used by association to take actions on your behalf.

• #association_dispatch_assume_role=(association_dispatch_assume_role : String | Nil)

  A role used by association to take actions on your behalf.

• #association_id : String | Nil

  The association ID.

• #association_id=(association_id : String | Nil)

  The association ID.

• #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.

• #automation_target_parameter_name : String | Nil

  Choose the parameter that will define how your automation will branch out.

• #automation_target_parameter_name=(automation_target_parameter_name : String | Nil)

  Choose the parameter that will define how your automation will branch out.

• #calendar_names : Array(String) | Nil

  The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.

• #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.

• #compliance_severity : AssociationComplianceSeverity | Nil

  The severity level that is assigned to the association.

• #compliance_severity=(compliance_severity : AssociationComplianceSeverity | Nil)

  The severity level that is assigned to the association.

• #date : Time | Nil

  The date when the association was made.

• #date=(date : Time | Nil)

  The date when the association was made.

• #document_version : String | Nil

  The document version.

• #document_version=(document_version : String | Nil)

  The document version.

• #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.

• #last_successful_execution_date : Time | Nil

  The last date on which the association was successfully run.

• #last_successful_execution_date=(last_successful_execution_date : Time | Nil)

  The last date on which the association was successfully run.

• #last_update_association_date : Time | Nil

  The date when the association was last updated.

• #last_update_association_date=(last_update_association_date : Time | Nil)

  The date when the association was last updated.

• #max_concurrency : String | Nil

  The maximum number of targets allowed to run the association at the same time.

• #max_concurrency=(max_concurrency : String | Nil)

  The maximum number of targets allowed to run the association at the same time.

• #max_errors : String | Nil

  The number of errors that are allowed before the system stops sending requests to run the association on additional targets.

• #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.

• #name : String | Nil

  The name of the SSM document.

• #name=(name : String | Nil)

  The name of the SSM document.

• #output_location : InstanceAssociationOutputLocation | Nil

  An S3 bucket where you want to store the output details of the request.

• #output_location=(output_location : InstanceAssociationOutputLocation | Nil)

  An S3 bucket where you want to store the output details of the request.

• #overview : AssociationOverview | Nil

  Information about the association.

• #overview=(overview : AssociationOverview | Nil)

  Information about the association.

• #parameters : Hash(String, Array(String)) | Nil

  A description of the parameters for a document.

• #parameters=(parameters : Hash(String, Array(String)) | Nil)

  A description of the parameters for a document.

• #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.

• #status : AssociationStatus | Nil

  The association status.

• #status=(status : AssociationStatus | Nil)

  The association status.

• #sync_compliance : AssociationSyncCompliance | Nil

  The mode for generating association compliance.

• #sync_compliance=(sync_compliance : AssociationSyncCompliance | Nil)

  The mode for generating association compliance.

• #target_locations : Array(TargetLocation) | Nil

  The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

• #target_locations=(target_locations : Array(TargetLocation) | Nil)

  The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the 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.

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

  The managed nodes targeted by the request.

• #triggered_alarms : Array(AlarmStateInformation) | Nil

  The CloudWatch alarm that was invoked during the association.

• #triggered_alarms=(triggered_alarms : Array(AlarmStateInformation) | Nil)

  The CloudWatch alarm that was invoked during the association.

• #validate! : Nil

Constructor Detail

Instance Method Detail