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

Class: Aws::SSM::Types::RegisterTargetWithMaintenanceWindowRequest

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

{
  window_id: "MaintenanceWindowId", # required
  resource_type: "INSTANCE", # required, accepts INSTANCE
  targets: [ # required
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  owner_information: "OwnerInformation",
  name: "MaintenanceWindowName",
  description: "MaintenanceWindowDescription",
  client_token: "ClientToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

User-provided idempotency token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#descriptionString

An optional description for the target.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#nameString

An optional name for the target.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#owner_informationString

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#resource_typeString

The type of target being registered with the Maintenance Window.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#window_idString

The ID of the Maintenance Window the target should be registered with.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8200

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end