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

Class: Aws::SSM::Types::UpdateAssociationRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#association_idString

The ID of the association you want to update.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#association_nameString

The name of the association that you want to update.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#association_versionString

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#document_versionString

The document version you want update for the association.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#nameString

The name of the association document.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#output_locationTypes::InstanceAssociationOutputLocation

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



9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#parametersHash<String,Array<String>>

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {\{ssm:parameter-name\}\}

Returns:

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


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#schedule_expressionString

The cron expression used to schedule the association that you want to update.

Returns:

  • (String)


9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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

#targetsArray<Types::Target>

The targets of the association.

Returns:



9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9267

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