Class: Aws::SSM::Types::RegisterTargetWithMaintenanceWindowRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::RegisterTargetWithMaintenanceWindowRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
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",
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
User-provided idempotency token.
-
#description ⇒ String
An optional description for the target.
-
#name ⇒ String
An optional name for the target.
-
#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.
-
#resource_type ⇒ String
The type of target being registered with the maintenance window.
-
#targets ⇒ Array<Types::Target>
The targets to register with the maintenance window.
-
#window_id ⇒ String
The ID of the maintenance window the target should be registered with.
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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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 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 `
<note markdown=“1”> For ‘Key=resource-groups:ResourceTypeFilters`, specify resource types in the following format
`Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
‘
</note>
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*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 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.
13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 |
# File 'lib/aws-sdk-ssm/types.rb', line 13489 class RegisterTargetWithMaintenanceWindowRequest < Struct.new( :window_id, :resource_type, :targets, :owner_information, :name, :description, :client_token) include Aws::Structure end |