You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::AssociationDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Describes the parameters for a document.

Instance Attribute Summary collapse

Instance Attribute Details

#association_idString

The association ID.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#association_nameString

The association name.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#association_versionString

The association version.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#dateTime

The date when the association was made.

Returns:

  • (Time)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#last_execution_dateTime

The date on which the association was last run.

Returns:

  • (Time)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#last_successful_execution_dateTime

The last date on which the association was successfully run.

Returns:

  • (Time)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#last_update_association_dateTime

The date when the association was last updated.

Returns:

  • (Time)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#overviewTypes::AssociationOverview

Information about the association.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

A description of the parameters for a document.

Returns:

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


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#statusTypes::AssociationStatus

The association status.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end

#targetsArray<Types::Target>

The instances targeted by the request.

Returns:



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 270

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name)
  include Aws::Structure
end