Package software.amazon.awssdk.services.ec2.model

Class CreateInstanceEventWindowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateInstanceEventWindowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateInstanceEventWindowRequest.Builder,CreateInstanceEventWindowRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateInstanceEventWindowRequest
extends Ec2Request
implements ToCopyableBuilder<CreateInstanceEventWindowRequest.Builder,CreateInstanceEventWindowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateInstanceEventWindowRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateInstanceEventWindowRequest.Builder	builder()
String	cronExpression()	The cron expression for the event window, for example, * 0-4,20-23 * * 1,5.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
boolean	hasTimeRanges()	For responses, this returns true if the service returned a value for the TimeRanges property.
String	name()	The name of the event window.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateInstanceEventWindowRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	The tags to apply to the event window.
List<InstanceEventWindowTimeRangeRequest>	timeRanges()	The time range for the event window.
CreateInstanceEventWindowRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

name

public final String name()

The name of the event window.

Returns:

The name of the event window.

hasTimeRanges

public final boolean hasTimeRanges()

For responses, this returns true if the service returned a value for the TimeRanges 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.

timeRanges

public final List<InstanceEventWindowTimeRangeRequest> timeRanges()

The time range for the event window. If you specify a time range, you can't specify a cron expression.

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 hasTimeRanges() method.

Returns:

The time range for the event window. If you specify a time range, you can't specify a cron expression.

cronExpression

public final String cronExpression()

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

• Only hour and day of the week values are supported.

• For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

• The minute, month, and year must be specified by *.

• The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

• Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

• The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

Returns:

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

• Only hour and day of the week values are supported.

• For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

• The minute, month, and year must be specified by *.

• The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

• Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

• The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications 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.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to apply to the event window.

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 hasTagSpecifications() method.

Returns:

The tags to apply to the event window.

toBuilder

public CreateInstanceEventWindowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateInstanceEventWindowRequest.Builder,CreateInstanceEventWindowRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateInstanceEventWindowRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo