Class Schedule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Schedule.Builder,
Schedule>
[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArchiveRule
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule.static Schedule.Builder
builder()
final Boolean
copyTags()
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.final CreateRule
The creation rule.final List
<CrossRegionCopyRule> Specifies a rule for copying snapshots or AMIs across regions.final DeprecateRule
[Custom AMI policies only] The AMI deprecation rule for the schedule.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FastRestoreRule
[Custom snapshot policies only] The rule for enabling fast snapshot restore.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CrossRegionCopyRules property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ShareRules property.final boolean
For responses, this returns true if the service returned a value for the TagsToAdd property.final boolean
For responses, this returns true if the service returned a value for the VariableTags property.final String
name()
The name of the schedule.final RetainRule
The retention rule for snapshots or AMIs created by the policy.static Class
<? extends Schedule.Builder> [Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.The tags to apply to policy-created resources.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.[AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the schedule.
- Returns:
- The name of the schedule.
-
copyTags
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
- Returns:
- Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
-
hasTagsToAdd
public final boolean hasTagsToAdd()For responses, this returns true if the service returned a value for the TagsToAdd property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tagsToAdd
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
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
hasTagsToAdd()
method.- Returns:
- The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
-
hasVariableTags
public final boolean hasVariableTags()For responses, this returns true if the service returned a value for the VariableTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
variableTags
[AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
$(instance-id)
or$(timestamp)
. Variable tags are only valid for EBS Snapshot Management – Instance policies.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
hasVariableTags()
method.- Returns:
- [AMI policies and snapshot policies that target instances only] A collection of key/value pairs
with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key.
Values must be in one of the two following formats:
$(instance-id)
or$(timestamp)
. Variable tags are only valid for EBS Snapshot Management – Instance policies.
-
createRule
The creation rule.
- Returns:
- The creation rule.
-
retainRule
The retention rule for snapshots or AMIs created by the policy.
- Returns:
- The retention rule for snapshots or AMIs created by the policy.
-
fastRestoreRule
[Custom snapshot policies only] The rule for enabling fast snapshot restore.
- Returns:
- [Custom snapshot policies only] The rule for enabling fast snapshot restore.
-
hasCrossRegionCopyRules
public final boolean hasCrossRegionCopyRules()For responses, this returns true if the service returned a value for the CrossRegionCopyRules property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
crossRegionCopyRules
Specifies a rule for copying snapshots or AMIs across regions.
You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
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
hasCrossRegionCopyRules()
method.- Returns:
- Specifies a rule for copying snapshots or AMIs across regions.
You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
-
deprecateRule
[Custom AMI policies only] The AMI deprecation rule for the schedule.
- Returns:
- [Custom AMI policies only] The AMI deprecation rule for the schedule.
-
archiveRule
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
- Returns:
- [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule.
When you specify an archiving rule, snapshots are automatically moved from the standard tier to the
archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive
tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
-
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 interfaceToCopyableBuilder<Schedule.Builder,
Schedule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-