amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Description

Registers a target with a maintenance window.

Synopsis

Creating a Request

data RegisterTargetWithMaintenanceWindow Source #

Constructors

RegisterTargetWithMaintenanceWindow' 

Fields

  • clientToken :: Maybe Text

    User-provided idempotency token.

  • description :: Maybe (Sensitive Text)

    An optional description for the target.

  • name :: Maybe Text

    An optional name for the target.

  • ownerInformation :: Maybe (Sensitive Text)

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

  • windowId :: Text

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

  • resourceType :: MaintenanceWindowResourceType

    The type of target being registered with the maintenance window.

  • targets :: [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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

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

    Example 3: Use tag-keys applied to managed nodes

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

Instances

Instances details
ToJSON RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

ToHeaders RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

ToPath RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

ToQuery RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

AWSRequest RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Generic RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Show RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

NFData RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Eq RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Hashable RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

type AWSResponse RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

type Rep RegisterTargetWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

type Rep RegisterTargetWithMaintenanceWindow = D1 ('MetaData "RegisterTargetWithMaintenanceWindow" "Amazonka.SSM.RegisterTargetWithMaintenanceWindow" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "RegisterTargetWithMaintenanceWindow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "ownerInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MaintenanceWindowResourceType) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Target])))))

newRegisterTargetWithMaintenanceWindow Source #

Create a value of RegisterTargetWithMaintenanceWindow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:RegisterTargetWithMaintenanceWindow', registerTargetWithMaintenanceWindow_clientToken - User-provided idempotency token.

RegisterTargetWithMaintenanceWindow, registerTargetWithMaintenanceWindow_description - An optional description for the target.

RegisterTargetWithMaintenanceWindow, registerTargetWithMaintenanceWindow_name - An optional name for the target.

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

RegisterTargetWithMaintenanceWindow, registerTargetWithMaintenanceWindow_windowId - The ID of the maintenance window the target should be registered with.

RegisterTargetWithMaintenanceWindow, registerTargetWithMaintenanceWindow_resourceType - The type of target being registered with the maintenance window.

RegisterTargetWithMaintenanceWindow, registerTargetWithMaintenanceWindow_targets - 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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

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

Example 3: Use tag-keys applied to managed nodes

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

Request Lenses

registerTargetWithMaintenanceWindow_ownerInformation :: Lens' RegisterTargetWithMaintenanceWindow (Maybe Text) Source #

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

registerTargetWithMaintenanceWindow_windowId :: Lens' RegisterTargetWithMaintenanceWindow Text Source #

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

registerTargetWithMaintenanceWindow_targets :: Lens' RegisterTargetWithMaintenanceWindow [Target] Source #

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=<instance-id-1>,<instance-id-2>,<instance-id-3>

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

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

Example 3: Use tag-keys applied to managed nodes

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

Destructuring the Response

data RegisterTargetWithMaintenanceWindowResponse Source #

Constructors

RegisterTargetWithMaintenanceWindowResponse' 

Fields

Instances

Instances details
Generic RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Read RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Show RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

NFData RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

Eq RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

type Rep RegisterTargetWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTargetWithMaintenanceWindow

type Rep RegisterTargetWithMaintenanceWindowResponse = D1 ('MetaData "RegisterTargetWithMaintenanceWindowResponse" "Amazonka.SSM.RegisterTargetWithMaintenanceWindow" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "RegisterTargetWithMaintenanceWindowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "windowTargetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterTargetWithMaintenanceWindowResponse Source #

Create a value of RegisterTargetWithMaintenanceWindowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterTargetWithMaintenanceWindowResponse, registerTargetWithMaintenanceWindowResponse_windowTargetId - The ID of the target definition in this maintenance window.

$sel:httpStatus:RegisterTargetWithMaintenanceWindowResponse', registerTargetWithMaintenanceWindowResponse_httpStatus - The response's http status code.

Response Lenses