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, RESOURCE_GROUP
  targets: [ # required
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  owner_information: "OwnerInformation",
  name: "MaintenanceWindowName",
  description: "MaintenanceWindowDescription",
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[:owner_information, :description]

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)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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

#descriptionString

An optional description for the target.

Returns:

  • (String)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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

#nameString

An optional name for the target.

Returns:

  • (String)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

class RegisterTargetWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :resource_type,
  :targets,
  :owner_information,
  :name,
  :description,
  :client_token)
  SENSITIVE = [:owner_information, :description]
  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)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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

#resource_typeString

The type of target being registered with the maintenance window.

Returns:

  • (String)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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

#targetsArray<Types::Target>

The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

Example 3: Use tag-keys applied to instances

Key=tag-key,Values=my-tag-key-1,my-tag-key-2

Example 4: Use resource group names

Key=resource-groups:Name,Values=resource-group-name

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.

Returns:



14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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

#window_idString

The ID of the maintenance window the target should be registered with.

Returns:

  • (String)


14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14591

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