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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAssociationRequest as input to an Aws::Client method, you can use a vanilla 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",
    },
  },
  association_name: "AssociationName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#association_nameString

Specify a descriptive name for the association.

Returns:

  • (String)

    Specify a descriptive name for the association.

#document_versionString

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

Returns:

  • (String)

    The document version you want to associate with the target(s).

#instance_idString

The instance ID.

Returns:

  • (String)

    The instance ID.

#nameString

The name of the Systems Manager document.

Returns:

  • (String)

    The name of the Systems Manager document.

#output_locationTypes::InstanceAssociationOutputLocation

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

Returns:

#parametersHash<String,Array<String>>

The parameters for the documents runtime configuration.

Returns:

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

    The parameters for the documents runtime configuration.

#schedule_expressionString

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

Returns:

  • (String)

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

#targetsArray<Types::Target>

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

Returns:

  • (Array<Types::Target>)

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