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:

SdkPojo, ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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()
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterTargetWithMaintenanceWindowRequest.Builder>	serializableBuilderClass()
List<Target>	targets() The targets to register with the maintenance window.
RegisterTargetWithMaintenanceWindowRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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

hasTargets

public boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

public List<Target> targets()

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

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

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

Example 3: Use tag-keys applied to instances

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 AWS Systems Manager User Guide.

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

You can use hasTargets() to see if a value was sent in this field.

Returns:

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

You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

Example 1: Specify instance IDs

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

Example 2: Use tag key-pairs applied to instances

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

Example 3: Use tag-keys applied to instances

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 AWS Systems Manager User Guide.

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 AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.