software.amazon.awssdk.services.ssm.model

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:

ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class RegisterTargetWithMaintenanceWindowRequest
extends SSMRequest
implements ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterTargetWithMaintenanceWindowRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RegisterTargetWithMaintenanceWindowRequest.Builder	builder()
String	clientToken() User-provided idempotency token.
String	description() An optional description for the target.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	name() An optional name for the target.
String	ownerInformation() User-provided value that will be included in any CloudWatch 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.
static Class<? extends RegisterTargetWithMaintenanceWindowRequest.Builder>	serializableBuilderClass()
List<Target>	targets() The targets (either instances or tags).
RegisterTargetWithMaintenanceWindowRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	windowId() The ID of the Maintenance Window the target should be registered with.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

windowId

public 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 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 return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The type of target being registered with the Maintenance Window.

See Also:

MaintenanceWindowResourceType

resourceTypeAsString

public 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 return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The type of target being registered with the Maintenance Window.

See Also:

MaintenanceWindowResourceType

targets

public List<Target> targets()

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

ownerInformation

public String ownerInformation()

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

Returns:

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

name

public String name()

An optional name for the target.

Returns:

An optional name for the target.

description

public String description()

An optional description for the target.

Returns:

An optional description for the target.

clientToken

public String clientToken()

User-provided idempotency token.

Returns:

User-provided idempotency token.

toBuilder

public RegisterTargetWithMaintenanceWindowRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

Specified by:

toBuilder in class SSMRequest

Returns:

a builder for type T

builder

public static RegisterTargetWithMaintenanceWindowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterTargetWithMaintenanceWindowRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value