MaintenanceWindowTarget (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.90 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.MaintenanceWindowTarget

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MaintenanceWindowTarget.Builder,MaintenanceWindowTarget>

@Generated(value="software.amazon.awssdk:codegen")
public final class MaintenanceWindowTarget
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MaintenanceWindowTarget.Builder,MaintenanceWindowTarget>

The target registered with the maintenance window.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MaintenanceWindowTarget.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MaintenanceWindowTarget.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MaintenanceWindowTarget.Builder`	`builder()`
`String`	`description()` A 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()` The name for the maintenance window target.
`String`	`ownerInformation()` A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
`MaintenanceWindowResourceType`	`resourceType()` The type of target that is being registered with the maintenance window.
`String`	`resourceTypeAsString()` The type of target that is being registered with the maintenance window.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MaintenanceWindowTarget.Builder>`	`serializableBuilderClass()`
`List<Target>`	`targets()` The targets, either instances or tags.
`MaintenanceWindowTarget.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`windowId()` The ID of the maintenance window to register the target with.
`String`	`windowTargetId()` The ID of the target.

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 to register the target with.
    
    Returns:
    
    The ID of the maintenance window to register the target with.
  - windowTargetId
```
public final String windowTargetId()
```
    The ID of the target.
    
    Returns:
    
    The ID of the target.
  - resourceType
```
public final MaintenanceWindowResourceType resourceType()
```
    The type of target that is being registered with the maintenance window.
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The type of target that is being registered with the maintenance window.
    
    See Also:
    
    MaintenanceWindowResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The type of target that is being registered with the maintenance window.
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The type of target that is 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 the isEmpty() 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, either instances or tags.
    
    Specify instances using the following format:
    
    Key=instanceids,Values=<instanceid1>,<instanceid2>
    
    Tags are specified using the following format:
    
    Key=<tag name>,Values=<tag value>.
    
    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, either instances or tags.
    
    Specify instances using the following format:
    
    Key=instanceids,Values=<instanceid1>,<instanceid2>
    
    Tags are specified using the following format:
    
    Key=<tag name>,Values=<tag value>.
  - ownerInformation
```
public final String ownerInformation()
```
    A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
    
    Returns:
    
    A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
  - name
```
public final String name()
```
    The name for the maintenance window target.
    
    Returns:
    
    The name for the maintenance window target.
  - description
```
public final String description()
```
    A description for the target.
    
    Returns:
    
    A description for the target.
  - toBuilder
```
public MaintenanceWindowTarget.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MaintenanceWindowTarget.Builder,MaintenanceWindowTarget>
  - builder
```
public static MaintenanceWindowTarget.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MaintenanceWindowTarget.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MaintenanceWindowTarget

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

windowId

windowTargetId

resourceType

resourceTypeAsString

hasTargets

targets

ownerInformation

name

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields