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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

User-provided idempotency token.

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

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#description ⇒ String

An optional description for the target.

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#name ⇒ String

An optional name for the target.

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#owner_information ⇒ String

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

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#resource_type ⇒ String

The type of target being registered with the Maintenance Window.

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#targets ⇒ Array<Types::Target>

The targets (either instances or tags).

Specify instances using the following format:

‘Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`

Specify tags using either of the following formats:

‘Key=tag:<tag-key>,Values=<tag-value-1>,<tag-value-2>`

‘Key=tag-key,Values=<tag-key-1>,<tag-key-2>`

Returns:



11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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

#window_id ⇒ String

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

Returns:

  • (String) 


11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
 
# File 'lib/aws-sdk-ssm/types.rb', line 11214

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