CreateRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dlm.model.CreateRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
[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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateRule()

Constructors
Constructor and Description
`CreateRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCronExpression()` The schedule, as a Cron expression.
`Integer`	`getInterval()` The interval between snapshots.
`String`	`getIntervalUnit()` The interval unit.
`String`	`getLocation()` [Snapshot policies only] Specifies the destination for snapshots created by the policy.
`List<String>`	`getTimes()` The time, in UTC, to start the operation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCronExpression(String cronExpression)` The schedule, as a Cron expression.
`void`	`setInterval(Integer interval)` The interval between snapshots.
`void`	`setIntervalUnit(String intervalUnit)` The interval unit.
`void`	`setLocation(String location)` [Snapshot policies only] Specifies the destination for snapshots created by the policy.
`void`	`setTimes(Collection<String> times)` The time, in UTC, to start the operation.
`String`	`toString()` Returns a string representation of this object.
`CreateRule`	`withCronExpression(String cronExpression)` The schedule, as a Cron expression.
`CreateRule`	`withInterval(Integer interval)` The interval between snapshots.
`CreateRule`	`withIntervalUnit(IntervalUnitValues intervalUnit)` The interval unit.
`CreateRule`	`withIntervalUnit(String intervalUnit)` The interval unit.
`CreateRule`	`withLocation(LocationValues location)` [Snapshot policies only] Specifies the destination for snapshots created by the policy.
`CreateRule`	`withLocation(String location)` [Snapshot policies only] Specifies the destination for snapshots created by the policy.
`CreateRule`	`withTimes(Collection<String> times)` The time, in UTC, to start the operation.
`CreateRule`	`withTimes(String... times)` The time, in UTC, to start the operation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateRule
```
public CreateRule()
```
- Method Detail
  - setLocation
```
public void setLocation(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    LocationValues
  - getLocation
```
public String getLocation()
```
    [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.
    
    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
  - withLocation
```
public CreateRule withLocation(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationValues
  - withLocation
```
public CreateRule withLocation(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationValues
  - setInterval
```
public void setInterval(Integer interval)
```
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    
    Parameters:
    
    interval - The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
  - getInterval
```
public Integer getInterval()
```
    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.
  - withInterval
```
public CreateRule withInterval(Integer interval)
```
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    
    Parameters:
    
    interval - The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIntervalUnit
```
public void setIntervalUnit(String intervalUnit)
```
    The interval unit.
    
    Parameters:
    
    intervalUnit - The interval unit.
    
    See Also:
    
    IntervalUnitValues
  - getIntervalUnit
```
public String getIntervalUnit()
```
    The interval unit.
    
    Returns:
    
    The interval unit.
    
    See Also:
    
    IntervalUnitValues
  - withIntervalUnit
```
public CreateRule withIntervalUnit(String intervalUnit)
```
    The interval unit.
    
    Parameters:
    
    intervalUnit - The interval unit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntervalUnitValues
  - withIntervalUnit
```
public CreateRule withIntervalUnit(IntervalUnitValues intervalUnit)
```
    The interval unit.
    
    Parameters:
    
    intervalUnit - The interval unit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntervalUnitValues
  - getTimes
```
public List<String> getTimes()
```
    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.
    
    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.
  - setTimes
```
public void setTimes(Collection<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.
    
    Parameters:
    
    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.
  - withTimes
```
public CreateRule withTimes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTimes(java.util.Collection) or withTimes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTimes
```
public CreateRule withTimes(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCronExpression
```
public void setCronExpression(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.
    
    Parameters:
    
    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.
  - getCronExpression
```
public String getCronExpression()
```
    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.
  - withCronExpression
```
public CreateRule withCronExpression(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CreateRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateRule

Method Detail

setLocation

getLocation

withLocation

withLocation

setInterval

getInterval

withInterval

setIntervalUnit

getIntervalUnit

withIntervalUnit

withIntervalUnit

getTimes

setTimes

withTimes

withTimes

setCronExpression

getCronExpression

withCronExpression

toString

equals

hashCode

clone

marshall