Class RegisterTargetWithMaintenanceWindowRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssm.model.SsmRequest
-
- software.amazon.awssdk.services.ssm.model.RegisterTargetWithMaintenanceWindowRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterTargetWithMaintenanceWindowRequest extends SsmRequest implements ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
RegisterTargetWithMaintenanceWindowRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RegisterTargetWithMaintenanceWindowRequest.Builder
builder()
String
clientToken()
User-provided idempotency token.String
description()
An optional description for the target.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTargets()
For responses, this returns true if the service returned a value for the Targets property.String
name()
An optional name for the target.String
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.MaintenanceWindowResourceType
resourceType()
The type of target being registered with the maintenance window.String
resourceTypeAsString()
The type of target being registered with the maintenance window.List<SdkField<?>>
sdkFields()
static Class<? extends RegisterTargetWithMaintenanceWindowRequest.Builder>
serializableBuilderClass()
List<Target>
targets()
The targets to register with the maintenance window.RegisterTargetWithMaintenanceWindowRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
windowId()
The ID of the maintenance window the target should be registered with.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
windowId
public final String windowId()
The ID of the maintenance window the target should be registered with.
- Returns:
- The ID of the maintenance window the target should be registered with.
-
resourceType
public final MaintenanceWindowResourceType resourceType()
The type of target being registered with the maintenance window.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnMaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of target being registered with the maintenance window.
- See Also:
MaintenanceWindowResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The type of target being registered with the maintenance window.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnMaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of target being registered with the maintenance window.
- See Also:
MaintenanceWindowResourceType
-
hasTargets
public final boolean hasTargets()
For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
targets
public final List<Target> 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 formatKey=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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTargets()
method.- Returns:
- 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 formatKey=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.
-
ownerInformation
public final String 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.
- Returns:
- User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
-
name
public final String name()
An optional name for the target.
- Returns:
- An optional name for the target.
-
description
public final String description()
An optional description for the target.
- Returns:
- An optional description for the target.
-
clientToken
public final String clientToken()
User-provided idempotency token.
- Returns:
- User-provided idempotency token.
-
toBuilder
public RegisterTargetWithMaintenanceWindowRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static RegisterTargetWithMaintenanceWindowRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends RegisterTargetWithMaintenanceWindowRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-