Struct aws_sdk_dlm::types::builders::PolicyDetailsBuilder

#[non_exhaustive]
pub struct PolicyDetailsBuilder { /* private fields */ }

A builder for PolicyDetails.

Implementations

impl PolicyDetailsBuilder

pub fn policy_type(self, input: PolicyTypeValues) -> Self

[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 set_policy_type(self, input: Option<PolicyTypeValues>) -> Self

[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 get_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, input: ResourceTypeValues) -> Self

Appends an item to resource_types.

To override the contents of this collection use set_resource_types.

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

pub fn set_resource_types(self, input: Option<Vec<ResourceTypeValues>>) -> Self

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

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

pub fn resource_locations(self, input: ResourceLocationValues) -> Self

Appends an item to resource_locations.

To override the contents of this collection use set_resource_locations.

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

pub fn set_resource_locations( self, input: Option<Vec<ResourceLocationValues>> ) -> Self

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

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

pub fn target_tags(self, input: Tag) -> Self

Appends an item to target_tags.

To override the contents of this collection use set_target_tags.

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

pub fn set_target_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn get_target_tags(&self) -> &Option<Vec<Tag>>

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

pub fn schedules(self, input: Schedule) -> Self

Appends an item to schedules.

To override the contents of this collection use set_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.

pub fn set_schedules(self, input: Option<Vec<Schedule>>) -> Self

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

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

pub fn parameters(self, input: Parameters) -> Self

[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 set_parameters(self, input: Option<Parameters>) -> Self

[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 get_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, input: EventSource) -> Self

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

pub fn set_event_source(self, input: Option<EventSource>) -> Self

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

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

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

pub fn actions(self, input: Action) -> Self

Appends an item to actions.

To override the contents of this collection use set_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.

pub fn set_actions(self, input: Option<Vec<Action>>) -> Self

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

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

pub fn policy_language(self, input: PolicyLanguageValues) -> Self

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 set_policy_language(self, input: Option<PolicyLanguageValues>) -> Self

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 get_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, input: ResourceTypeValues) -> Self

[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 set_resource_type(self, input: Option<ResourceTypeValues>) -> Self

[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 get_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, input: i32) -> Self

[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 set_create_interval(self, input: Option<i32>) -> Self

[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 get_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, input: i32) -> Self

[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 set_retain_interval(self, input: Option<i32>) -> Self

[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 get_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, input: bool) -> Self

[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 set_copy_tags(self, input: Option<bool>) -> Self

[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 get_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, input: CrossRegionCopyTarget) -> Self

Appends an item to cross_region_copy_targets.

To override the contents of this collection use set_cross_region_copy_targets.

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

pub fn set_cross_region_copy_targets( self, input: Option<Vec<CrossRegionCopyTarget>> ) -> Self

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

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

pub fn extend_deletion(self, input: bool) -> Self

[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 set_extend_deletion(self, input: Option<bool>) -> Self

[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 get_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, input: Exclusions) -> Self

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

pub fn set_exclusions(self, input: Option<Exclusions>) -> Self

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

pub fn get_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.

pub fn build(self) -> PolicyDetails

Consumes the builder and constructs a PolicyDetails.

Trait Implementations

impl Clone for PolicyDetailsBuilder

fn clone(&self) -> PolicyDetailsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PolicyDetailsBuilder

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

Formats the value using the given formatter.

impl Default for PolicyDetailsBuilder

fn default() -> PolicyDetailsBuilder

Returns the “default value” for a type.

impl PartialEq for PolicyDetailsBuilder

fn eq(&self, other: &PolicyDetailsBuilder) -> 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 PolicyDetailsBuilder