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

Class: Aws::SSM::Types::CreateAssociationRequest

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 CreateAssociationRequest data as a hash:

{
  name: "DocumentName", # required
  document_version: "DocumentVersion",
  instance_id: "InstanceId",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  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",
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#document_versionString

The document version you want to associate with the target(s). Can be a specific version or the default version.

Returns:

  • (String)


1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#instance_idString

The instance ID.

Returns:

  • (String)


1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#output_locationTypes::InstanceAssociationOutputLocation

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



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#parametersHash<String,Array<String>>

The parameters for the documents runtime configuration.

Returns:

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


1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#schedule_expressionString

A cron expression when the association will be applied to the target(s).

Returns:

  • (String)


1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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

#targetsArray<Types::Target>

The targets (either instances or tags) for the association.

Returns:



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1512

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