Struct aws_sdk_dlm::types::PolicyDetails

#[non_exhaustive]
pub struct PolicyDetails {

    pub policy_type: Option<PolicyTypeValues>,
    pub resource_types: Option<Vec<ResourceTypeValues>>,
    pub resource_locations: Option<Vec<ResourceLocationValues>>,
    pub target_tags: Option<Vec<Tag>>,
    pub schedules: Option<Vec<Schedule>>,
    pub parameters: Option<Parameters>,
    pub event_source: Option<EventSource>,
    pub actions: Option<Vec<Action>>,
    pub policy_language: Option<PolicyLanguageValues>,
    pub resource_type: Option<ResourceTypeValues>,
    pub create_interval: Option<i32>,
    pub retain_interval: Option<i32>,
    pub copy_tags: Option<bool>,
    pub cross_region_copy_targets: Option<Vec<CrossRegionCopyTarget>>,
    pub extend_deletion: Option<bool>,
    pub exclusions: Option<Exclusions>,
}

Specifies the configuration of a lifecycle policy.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

policy_type: Option<PolicyTypeValues>

[Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to 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.

resource_types: Option<Vec<ResourceTypeValues>>

[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

resource_locations: Option<Vec<ResourceLocationValues>>

[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, specify OUTPOST.

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.

target_tags: Option<Vec<Tag>>

[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

schedules: Option<Vec<Schedule>>

[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: Option<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.

event_source: Option<EventSource>

[Event-based policies only] The event that activates the event-based policy.

actions: Option<Vec<Action>>

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

policy_language: Option<PolicyLanguageValues>

The type of policy to create. Specify one of the following:

• SIMPLIFIED To create a default policy.

• STANDARD To create a custom policy.

resource_type: Option<ResourceTypeValues>

[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.

create_interval: Option<i32>

[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

retain_interval: Option<i32>

[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

copy_tags: Option<bool>

[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

cross_region_copy_targets: Option<Vec<CrossRegionCopyTarget>>

[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.

extend_deletion: Option<bool>

[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: Option<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.

Implementations

impl PolicyDetails

pub fn policy_type(&self) -> Option<&PolicyTypeValues>

[Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to 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.

pub fn resource_types(&self) -> &[ResourceTypeValues]

[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_types.is_none().

pub fn resource_locations(&self) -> &[ResourceLocationValues]

[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, specify OUTPOST.

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_locations.is_none().

pub fn target_tags(&self) -> &[Tag]

[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_tags.is_none().

pub fn schedules(&self) -> &[Schedule]

[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .schedules.is_none().

pub fn parameters(&self) -> Option<&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.

pub fn event_source(&self) -> Option<&EventSource>

[Event-based policies only] The event that activates the event-based policy.

pub fn actions(&self) -> &[Action]

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions.is_none().

pub fn policy_language(&self) -> Option<&PolicyLanguageValues>

The type of policy to create. Specify one of the following:

• SIMPLIFIED To create a default policy.

• STANDARD To create a custom policy.

pub fn resource_type(&self) -> Option<&ResourceTypeValues>

[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.

pub fn create_interval(&self) -> Option<i32>

[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

pub fn retain_interval(&self) -> Option<i32>

[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

pub fn copy_tags(&self) -> Option<bool>

[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

pub fn cross_region_copy_targets(&self) -> &[CrossRegionCopyTarget]

[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cross_region_copy_targets.is_none().

pub fn extend_deletion(&self) -> Option<bool>

[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

pub fn exclusions(&self) -> Option<&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.

impl PolicyDetails

pub fn builder() -> PolicyDetailsBuilder

Creates a new builder-style object to manufacture PolicyDetails.

Trait Implementations

impl Clone for PolicyDetails

fn clone(&self) -> PolicyDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PolicyDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PolicyDetails

fn eq(&self, other: &PolicyDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PolicyDetails