Class PolicyDetails
- java.lang.Object
-
- software.amazon.awssdk.services.dlm.model.PolicyDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>
@Generated("software.amazon.awssdk:codegen") public final class PolicyDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>
Specifies the configuration of a lifecycle policy.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePolicyDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Action>actions()[Event-based policies only] The actions to be performed when the event-based policy is activated.static PolicyDetails.Builderbuilder()BooleancopyTags()[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.IntegercreateInterval()[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.List<CrossRegionCopyTarget>crossRegionCopyTargets()[Default policies only] Specifies destination Regions for snapshot or AMI copies.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventSourceeventSource()[Event-based policies only] The event that activates the event-based policy.Exclusionsexclusions()[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.BooleanextendDeletion()[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActions()For responses, this returns true if the service returned a value for the Actions property.booleanhasCrossRegionCopyTargets()For responses, this returns true if the service returned a value for the CrossRegionCopyTargets property.inthashCode()booleanhasResourceLocations()For responses, this returns true if the service returned a value for the ResourceLocations property.booleanhasResourceTypes()For responses, this returns true if the service returned a value for the ResourceTypes property.booleanhasSchedules()For responses, this returns true if the service returned a value for the Schedules property.booleanhasTargetTags()For responses, this returns true if the service returned a value for the TargetTags property.Parametersparameters()[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.PolicyLanguageValuespolicyLanguage()The type of policy to create.StringpolicyLanguageAsString()The type of policy to create.PolicyTypeValuespolicyType()[Custom policies only] The valid target resource types and actions a policy can manage.StringpolicyTypeAsString()[Custom policies only] The valid target resource types and actions a policy can manage.List<ResourceLocationValues>resourceLocations()[Custom snapshot and AMI policies only] The location of the resources to backup.List<String>resourceLocationsAsStrings()[Custom snapshot and AMI policies only] The location of the resources to backup.ResourceTypeValuesresourceType()[Default policies only] Specify the type of default policy to create.StringresourceTypeAsString()[Default policies only] Specify the type of default policy to create.List<ResourceTypeValues>resourceTypes()[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.List<String>resourceTypesAsStrings()[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.IntegerretainInterval()[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.List<Schedule>schedules()[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.List<SdkField<?>>sdkFields()static Class<? extends PolicyDetails.Builder>serializableBuilderClass()List<Tag>targetTags()[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.PolicyDetails.BuildertoBuilder()StringtoString()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
-
policyType
public final PolicyTypeValues policyType()
[Custom policies only] The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENTto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. SpecifyIMAGE_MANAGEMENTto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. SpecifyEVENT_BASED_POLICYto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.The default is
EBS_SNAPSHOT_MANAGEMENT.If the service returns an enum value that is not available in the current SDK version,
policyTypewill returnPolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompolicyTypeAsString().- Returns:
- [Custom policies only] The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENTto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. SpecifyIMAGE_MANAGEMENTto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. SpecifyEVENT_BASED_POLICYto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.The default is
EBS_SNAPSHOT_MANAGEMENT. - See Also:
PolicyTypeValues
-
policyTypeAsString
public final String policyTypeAsString()
[Custom policies only] The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENTto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. SpecifyIMAGE_MANAGEMENTto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. SpecifyEVENT_BASED_POLICYto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.The default is
EBS_SNAPSHOT_MANAGEMENT.If the service returns an enum value that is not available in the current SDK version,
policyTypewill returnPolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompolicyTypeAsString().- Returns:
- [Custom policies only] The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENTto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. SpecifyIMAGE_MANAGEMENTto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. SpecifyEVENT_BASED_POLICYto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.The default is
EBS_SNAPSHOT_MANAGEMENT. - See Also:
PolicyTypeValues
-
resourceTypes
public final List<ResourceTypeValues> resourceTypes()
[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use
VOLUMEto create snapshots of individual volumes or useINSTANCEto create multi-volume snapshots from the volumes for an instance.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
hasResourceTypes()method.- Returns:
- [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
Use
VOLUMEto create snapshots of individual volumes or useINSTANCEto create multi-volume snapshots from the volumes for an instance.
-
hasResourceTypes
public final boolean hasResourceTypes()
For responses, this returns true if the service returned a value for the ResourceTypes 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.
-
resourceTypesAsStrings
public final List<String> resourceTypesAsStrings()
[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use
VOLUMEto create snapshots of individual volumes or useINSTANCEto create multi-volume snapshots from the volumes for an instance.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
hasResourceTypes()method.- Returns:
- [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
Use
VOLUMEto create snapshots of individual volumes or useINSTANCEto create multi-volume snapshots from the volumes for an instance.
-
resourceLocations
public final List<ResourceLocationValues> resourceLocations()
[Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify
CLOUD. If the source resources are located on an Outpost in your account, specifyOUTPOST.If you specify
OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.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
hasResourceLocations()method.- Returns:
- [Custom snapshot and AMI policies only] The location of the resources to backup. If the source
resources are located in an Amazon Web Services Region, specify
CLOUD. If the source resources are located on an Outpost in your account, specifyOUTPOST.If you specify
OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
-
hasResourceLocations
public final boolean hasResourceLocations()
For responses, this returns true if the service returned a value for the ResourceLocations 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.
-
resourceLocationsAsStrings
public final List<String> resourceLocationsAsStrings()
[Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify
CLOUD. If the source resources are located on an Outpost in your account, specifyOUTPOST.If you specify
OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.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
hasResourceLocations()method.- Returns:
- [Custom snapshot and AMI policies only] The location of the resources to backup. If the source
resources are located in an Amazon Web Services Region, specify
CLOUD. If the source resources are located on an Outpost in your account, specifyOUTPOST.If you specify
OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
-
hasTargetTags
public final boolean hasTargetTags()
For responses, this returns true if the service returned a value for the TargetTags 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.
-
targetTags
public final List<Tag> targetTags()
[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
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
hasTargetTags()method.- Returns:
- [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
-
hasSchedules
public final boolean hasSchedules()
For responses, this returns true if the service returned a value for the Schedules 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.
-
schedules
public final List<Schedule> schedules()
[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
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
hasSchedules()method.- Returns:
- [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
-
parameters
public final Parameters parameters()
[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
- Returns:
- [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI
lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
-
eventSource
public final EventSource eventSource()
[Event-based policies only] The event that activates the event-based policy.
- Returns:
- [Event-based policies only] The event that activates the event-based policy.
-
hasActions
public final boolean hasActions()
For responses, this returns true if the service returned a value for the Actions 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.
-
actions
public final List<Action> actions()
[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
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
hasActions()method.- Returns:
- [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
-
policyLanguage
public final PolicyLanguageValues policyLanguage()
The type of policy to create. Specify one of the following:
-
SIMPLIFIEDTo create a default policy. -
STANDARDTo create a custom policy.
If the service returns an enum value that is not available in the current SDK version,
policyLanguagewill returnPolicyLanguageValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompolicyLanguageAsString().- Returns:
- The type of policy to create. Specify one of the following:
-
SIMPLIFIEDTo create a default policy. -
STANDARDTo create a custom policy.
-
- See Also:
PolicyLanguageValues
-
-
policyLanguageAsString
public final String policyLanguageAsString()
The type of policy to create. Specify one of the following:
-
SIMPLIFIEDTo create a default policy. -
STANDARDTo create a custom policy.
If the service returns an enum value that is not available in the current SDK version,
policyLanguagewill returnPolicyLanguageValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompolicyLanguageAsString().- Returns:
- The type of policy to create. Specify one of the following:
-
SIMPLIFIEDTo create a default policy. -
STANDARDTo create a custom policy.
-
- See Also:
PolicyLanguageValues
-
-
resourceType
public final ResourceTypeValues resourceType()
[Default policies only] Specify the type of default policy to create.
-
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify
VOLUME. -
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify
INSTANCE.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnResourceTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- [Default policies only] Specify the type of default policy to create.
-
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify
VOLUME. -
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify
INSTANCE.
-
- See Also:
ResourceTypeValues
-
-
resourceTypeAsString
public final String resourceTypeAsString()
[Default policies only] Specify the type of default policy to create.
-
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify
VOLUME. -
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify
INSTANCE.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnResourceTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- [Default policies only] Specify the type of default policy to create.
-
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify
VOLUME. -
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify
INSTANCE.
-
- See Also:
ResourceTypeValues
-
-
createInterval
public final Integer createInterval()
[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
Default: 1
- Returns:
- [Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
Default: 1
-
retainInterval
public final Integer retainInterval()
[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
Default: 7
- Returns:
- [Default policies only] Specifies how long the policy should retain snapshots or AMIs before
deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation
frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not
specify a value, the default is 7.
Default: 7
-
copyTags
public final Boolean copyTags()
[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is
false.Default: false
- Returns:
- [Default policies only] Indicates whether the policy should copy tags from the source resource to
the snapshot or AMI. If you do not specify a value, the default is
false.Default: false
-
hasCrossRegionCopyTargets
public final boolean hasCrossRegionCopyTargets()
For responses, this returns true if the service returned a value for the CrossRegionCopyTargets 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.
-
crossRegionCopyTargets
public final List<CrossRegionCopyTarget> crossRegionCopyTargets()
[Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
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
hasCrossRegionCopyTargets()method.- Returns:
- [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
-
extendDeletion
public final Boolean extendDeletion()
[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
By default (ExtendDeletion=false):
-
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify
true. -
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify
true.
If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
If you do not specify a value, the default is
false.Default: false
- Returns:
- [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the
source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
By default (ExtendDeletion=false):
-
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify
true. -
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify
true.
If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
If you do not specify a value, the default is
false.Default: false
-
-
-
exclusions
public final Exclusions exclusions()
[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
- Returns:
- [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
-
toBuilder
public PolicyDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>
-
builder
public static PolicyDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends PolicyDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-