class Amazonite::Ssm::RegisterTargetWithMaintenanceWindowRequest

Included Modules

Defined in:

ssm/register_target_with_maintenance_window_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(window_id : String, resource_type : MaintenanceWindowResourceType, targets : Array(Target), owner_information : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, client_token : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def client_token : String | Nil #

User-provided idempotency token.


[View source]
def client_token=(client_token : String | Nil) #

User-provided idempotency token.


[View source]
def description : String | Nil #

An optional description for the target.


[View source]
def description=(description : String | Nil) #

An optional description for the target.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String | Nil #

An optional name for the target.


[View source]
def name=(name : String | Nil) #

An optional name for the target.


[View source]
def owner_information : String | Nil #

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.


[View source]
def owner_information=(owner_information : String | Nil) #

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.


[View source]
def resource_type : MaintenanceWindowResourceType #

The type of target being registered with the maintenance window.


[View source]
def resource_type=(resource_type : MaintenanceWindowResourceType) #

The type of target being registered with the maintenance window.


[View source]
def targets : Array(Target) #

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

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

Key=InstanceIds,Values=,,

Example 2: Use tag key-pairs applied to managed nodes

Key=tag:,Values=,

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values=,

Example 4: Use resource group names

Key=resource-groups:Name,Values=

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=,

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 Amazon Web Services Systems Manager User Guide.


[View source]
def targets=(targets : Array(Target)) #

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

If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

Key=InstanceIds,Values=,,

Example 2: Use tag key-pairs applied to managed nodes

Key=tag:,Values=,

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values=,

Example 4: Use resource group names

Key=resource-groups:Name,Values=

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=,

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 Amazon Web Services Systems Manager User Guide.


[View source]
def validate! : Nil #

[View source]
def window_id : String #

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


[View source]
def window_id=(window_id : String) #

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


[View source]