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

Class: Aws::SSM::Types::CreateAssociationBatchRequestEntry

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

Overview

Note:

When making an API call, you may pass CreateAssociationBatchRequestEntry data as a hash:

{
  name: "DocumentName", # required
  instance_id: "InstanceId",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  document_version: "DocumentVersion",
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  schedule_expression: "ScheduleExpression",
  output_location: {
    s3_location: {
      output_s3_region: "S3Region",
      output_s3_bucket_name: "S3BucketName",
      output_s3_key_prefix: "S3KeyPrefix",
    },
  },
  association_name: "AssociationName",
}

Describes the association of a Systems Manager document and an instance.

Instance Attribute Summary collapse

Instance Attribute Details

#association_nameString

Specify a descriptive name for the association.

Returns:

  • (String)


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#nameString

The name of the configuration document.

Returns:

  • (String)


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

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



1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

A description of the parameters for a document.

Returns:

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


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)


1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end

#targetsArray<Types::Target>

The instances targeted by the request.

Returns:



1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1645

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name)
  include Aws::Structure
end