software.amazon.awssdk.services.dlm.model

Class CreateRule

java.lang.Object

software.amazon.awssdk.services.dlm.model.CreateRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateRule.Builder,CreateRule>

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

[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

• You must specify either CronExpression, or Interval, IntervalUnit, and Times.

• If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRule.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRule.Builder	builder()
String	cronExpression() The schedule, as a Cron expression.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTimes() For responses, this returns true if the service returned a value for the Times property.
Integer	interval() The interval between snapshots.
IntervalUnitValues	intervalUnit() The interval unit.
String	intervalUnitAsString() The interval unit.
LocationValues	location() [Snapshot policies only] Specifies the destination for snapshots created by the policy.
String	locationAsString() [Snapshot policies only] Specifies the destination for snapshots created by the policy.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRule.Builder>	serializableBuilderClass()
List<String>	times() The time, in UTC, to start the operation.
CreateRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

location

public final LocationValues location()

[Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

If the service returns an enum value that is not available in the current SDK version, location will return LocationValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

Returns:

[Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

See Also:

LocationValues

locationAsString

public final String locationAsString()

[Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

If the service returns an enum value that is not available in the current SDK version, location will return LocationValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

Returns:

[Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

See Also:

LocationValues

interval

public final Integer interval()

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

Returns:

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

intervalUnit

public final IntervalUnitValues intervalUnit()

The interval unit.

If the service returns an enum value that is not available in the current SDK version, intervalUnit will return IntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

Returns:

The interval unit.

See Also:

IntervalUnitValues

intervalUnitAsString

public final String intervalUnitAsString()

The interval unit.

If the service returns an enum value that is not available in the current SDK version, intervalUnit will return IntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

Returns:

The interval unit.

See Also:

IntervalUnitValues

hasTimes

public final boolean hasTimes()

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

times

public final List<String> times()

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

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

Returns:

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

cronExpression

public final String cronExpression()

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

Returns:

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

toBuilder

public CreateRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRule.Builder,CreateRule>

builder

public static CreateRule.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRule.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