Struct aws_sdk_dlm::operation::create_lifecycle_policy::builders::CreateLifecyclePolicyFluentBuilder

pub struct CreateLifecyclePolicyFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateLifecyclePolicy.

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

• Custom EBS snapshot policy

• Custom EBS-backed AMI policy

• Cross-account copy event policy

• Default policy for EBS snapshots

• Default policy for EBS-backed AMIs

For more information, see Default policies vs custom policies.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Implementations

impl CreateLifecyclePolicyFluentBuilder

pub fn as_input(&self) -> &CreateLifecyclePolicyInputBuilder

Access the CreateLifecyclePolicy as a reference.

pub async fn send( self ) -> Result<CreateLifecyclePolicyOutput, SdkError<CreateLifecyclePolicyError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateLifecyclePolicyOutput, CreateLifecyclePolicyError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn execution_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

pub fn set_execution_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

pub fn get_execution_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

pub fn description(self, input: impl Into<String>) -> Self

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

pub fn set_description(self, input: Option<String>) -> Self

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

pub fn get_description(&self) -> &Option<String>

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

pub fn state(self, input: SettablePolicyStateValues) -> Self

The activation state of the lifecycle policy after creation.

pub fn set_state(self, input: Option<SettablePolicyStateValues>) -> Self

The activation state of the lifecycle policy after creation.

pub fn get_state(&self) -> &Option<SettablePolicyStateValues>

The activation state of the lifecycle policy after creation.

pub fn policy_details(self, input: PolicyDetails) -> Self

The configuration details of the lifecycle policy.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

pub fn set_policy_details(self, input: Option<PolicyDetails>) -> Self

The configuration details of the lifecycle policy.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

pub fn get_policy_details(&self) -> &Option<PolicyDetails>

The configuration details of the lifecycle policy.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

The tags to apply to the lifecycle policy during creation.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags to apply to the lifecycle policy during creation.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tags to apply to the lifecycle policy during creation.

pub fn default_policy(self, input: DefaultPolicyTypeValues) -> 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_default_policy(self, input: Option<DefaultPolicyTypeValues>) -> 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_default_policy(&self) -> &Option<DefaultPolicyTypeValues>

[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 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 cross_region_copy_targets(self, input: CrossRegionCopyTarget) -> Self

Appends an item to CrossRegionCopyTargets.

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

Trait Implementations

impl Clone for CreateLifecyclePolicyFluentBuilder

fn clone(&self) -> CreateLifecyclePolicyFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateLifecyclePolicyFluentBuilder

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

Formats the value using the given formatter.