You are viewing an outdated version of provider-aws-dlm.Go to Latest
upbound/provider-aws-dlm@v1.14.0
LifecyclePolicy
dlm.aws.upbound.io
LifecyclePolicy
upbound/provider-aws-dlm@v1.14.0dlm.aws.upbound.io

LifecyclePolicy is the Schema for the LifecyclePolicys API. Provides a Data Lifecycle Manager (DLM) lifecycle policy for managing snapshots.

Type

CRD

Group

dlm.aws.upbound.io

Version

apiVersion: dlm.aws.upbound.io/v1beta1

kind: LifecyclePolicy

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

LifecyclePolicySpec defines the desired state of LifecyclePolicy

forProvider
requiredobject
requiredobject

No description provided.

object

Reference to a Role in iam to populate executionRoleArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate executionRoleArn.

policy
object
object

Policies for selection.

resolve
string
array

See the policy_details configuration block. Max of 1.

action
array
array

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the action configuration block.

array

The rule for copying shared snapshots across Regions. See the cross_region_copy configuration block.

array

The encryption settings for the copied snapshot. See the encryption_configuration block. Max of 1 per action.

cmkArn
string
encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
name
string
array

The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the event_source configuration block.

array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

eventType
string
array

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.

type
string
array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

array

The location of the resources to backup. If the source resources are located in an AWS 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. Valid values are CLOUD and OUTPOST.

array

A list of resource types that should be targeted by the lifecycle policy. Valid values are VOLUME and INSTANCE.

array

See the schedule configuration block.

copyTags
boolean
array

See the create_rule block. Max of 1 per schedule.

interval
number
location
string
times
array
array

A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with cron_expression. Must be set if interval is set.

array

See the cross_region_copy_rule block. Max of 3 per schedule.

cmkArn
string
cmkArnRef
object
object

Reference to a Key in kms to populate cmkArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate cmkArn.

policy
object
object

Policies for selection.

resolve
string
copyTags
boolean
array

See the deprecate_rule block. Max of 1 per schedule.

encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
array

See the deprecate_rule block. Max of 1 per schedule.

count
number
interval
number
array

See the fast_restore_rule block. Max of 1 per schedule.

array

The Availability Zones in which to enable fast snapshot restore.

count
number
interval
number
name
string
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

count
number
interval
number
array

See the share_rule block. Max of 1 per schedule.

array

The IDs of the AWS accounts with which to share the snapshots.

tagsToAdd
object
region
requiredstring
state
string
tags
object
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

object

Reference to a Role in iam to populate executionRoleArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate executionRoleArn.

policy
object
object

Policies for selection.

resolve
string
array

See the policy_details configuration block. Max of 1.

action
array
array

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the action configuration block.

array

The rule for copying shared snapshots across Regions. See the cross_region_copy configuration block.

array

The encryption settings for the copied snapshot. See the encryption_configuration block. Max of 1 per action.

cmkArn
string
encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
name
string
array

The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the event_source configuration block.

array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

eventType
string
array

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.

type
string
array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

array

The location of the resources to backup. If the source resources are located in an AWS 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. Valid values are CLOUD and OUTPOST.

array

A list of resource types that should be targeted by the lifecycle policy. Valid values are VOLUME and INSTANCE.

array

See the schedule configuration block.

copyTags
boolean
array

See the create_rule block. Max of 1 per schedule.

interval
number
location
string
times
array
array

A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with cron_expression. Must be set if interval is set.

array

See the cross_region_copy_rule block. Max of 3 per schedule.

cmkArn
string
cmkArnRef
object
object

Reference to a Key in kms to populate cmkArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate cmkArn.

policy
object
object

Policies for selection.

resolve
string
copyTags
boolean
array

See the deprecate_rule block. Max of 1 per schedule.

encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
array

See the deprecate_rule block. Max of 1 per schedule.

count
number
interval
number
array

See the fast_restore_rule block. Max of 1 per schedule.

array

The Availability Zones in which to enable fast snapshot restore.

count
number
interval
number
name
string
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

count
number
interval
number
array

See the share_rule block. Max of 1 per schedule.

array

The IDs of the AWS accounts with which to share the snapshots.

tagsToAdd
object
state
string
tags
object
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

LifecyclePolicyStatus defines the observed state of LifecyclePolicy.

object

No description provided.

arn
string
id
string
array

See the policy_details configuration block. Max of 1.

action
array
array

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the action configuration block.

array

The rule for copying shared snapshots across Regions. See the cross_region_copy configuration block.

array

The encryption settings for the copied snapshot. See the encryption_configuration block. Max of 1 per action.

cmkArn
string
encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
name
string
array

The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the event_source configuration block.

array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

eventType
string
array

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.

type
string
array

A set of optional parameters for snapshot and AMI lifecycle policies. See the parameters configuration block.

array

The location of the resources to backup. If the source resources are located in an AWS 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. Valid values are CLOUD and OUTPOST.

array

A list of resource types that should be targeted by the lifecycle policy. Valid values are VOLUME and INSTANCE.

array

See the schedule configuration block.

copyTags
boolean
array

See the create_rule block. Max of 1 per schedule.

interval
number
location
string
times
array
array

A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with cron_expression. Must be set if interval is set.

array

See the cross_region_copy_rule block. Max of 3 per schedule.

cmkArn
string
copyTags
boolean
array

See the deprecate_rule block. Max of 1 per schedule.

encrypted
boolean
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

target
string
array

See the deprecate_rule block. Max of 1 per schedule.

count
number
interval
number
array

See the fast_restore_rule block. Max of 1 per schedule.

array

The Availability Zones in which to enable fast snapshot restore.

count
number
interval
number
name
string
array

Specifies the retention rule for cross-Region snapshot copies. See the retain_rule block. Max of 1 per action.

count
number
interval
number
array

See the share_rule block. Max of 1 per schedule.

array

The IDs of the AWS accounts with which to share the snapshots.

tagsToAdd
object
state
string
tags
object
tagsAll
object
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions