aws-cdk-lib.aws_dlm.CfnLifecyclePolicyProps

interface CfnLifecyclePolicyProps

LanguageType name
.NETAmazon.CDK.AWS.DLM.CfnLifecyclePolicyProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdlm#CfnLifecyclePolicyProps
Javasoftware.amazon.awscdk.services.dlm.CfnLifecyclePolicyProps
Pythonaws_cdk.aws_dlm.CfnLifecyclePolicyProps
TypeScript aws-cdk-lib » aws_dlm » CfnLifecyclePolicyProps

Properties for defining a CfnLifecyclePolicy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dlm as dlm } from 'aws-cdk-lib';
const cfnLifecyclePolicyProps: dlm.CfnLifecyclePolicyProps = {
  description: 'description',
  executionRoleArn: 'executionRoleArn',
  policyDetails: {
    actions: [{
      crossRegionCopy: [{
        encryptionConfiguration: {
          encrypted: false,

          // the properties below are optional
          cmkArn: 'cmkArn',
        },
        target: 'target',

        // the properties below are optional
        retainRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
      }],
      name: 'name',
    }],
    eventSource: {
      type: 'type',

      // the properties below are optional
      parameters: {
        eventType: 'eventType',
        snapshotOwner: ['snapshotOwner'],

        // the properties below are optional
        descriptionRegex: 'descriptionRegex',
      },
    },
    parameters: {
      excludeBootVolume: false,
      excludeDataVolumeTags: [{
        key: 'key',
        value: 'value',
      }],
      noReboot: false,
    },
    policyType: 'policyType',
    resourceLocations: ['resourceLocations'],
    resourceTypes: ['resourceTypes'],
    schedules: [{
      archiveRule: {
        retainRule: {
          retentionArchiveTier: {
            count: 123,
            interval: 123,
            intervalUnit: 'intervalUnit',
          },
        },
      },
      copyTags: false,
      createRule: {
        cronExpression: 'cronExpression',
        interval: 123,
        intervalUnit: 'intervalUnit',
        location: 'location',
        times: ['times'],
      },
      crossRegionCopyRules: [{
        encrypted: false,

        // the properties below are optional
        cmkArn: 'cmkArn',
        copyTags: false,
        deprecateRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
        retainRule: {
          interval: 123,
          intervalUnit: 'intervalUnit',
        },
        target: 'target',
        targetRegion: 'targetRegion',
      }],
      deprecateRule: {
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      fastRestoreRule: {
        availabilityZones: ['availabilityZones'],
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      name: 'name',
      retainRule: {
        count: 123,
        interval: 123,
        intervalUnit: 'intervalUnit',
      },
      shareRules: [{
        targetAccounts: ['targetAccounts'],
        unshareInterval: 123,
        unshareIntervalUnit: 'unshareIntervalUnit',
      }],
      tagsToAdd: [{
        key: 'key',
        value: 'value',
      }],
      variableTags: [{
        key: 'key',
        value: 'value',
      }],
    }],
    targetTags: [{
      key: 'key',
      value: 'value',
    }],
  },
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
description?stringA description of the lifecycle policy.
executionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
policyDetails?IResolvable | PolicyDetailsPropertyThe configuration details of the lifecycle policy.
state?stringThe activation state of the lifecycle policy.
tags?CfnTag[]The tags to apply to the lifecycle policy during creation.

description?

Type: string (optional)

A description of the lifecycle policy.

The characters ^[0-9A-Za-z _-]+$ are supported.


executionRoleArn?

Type: string (optional)

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


policyDetails?

Type: IResolvable | PolicyDetailsProperty (optional)

The configuration details of the lifecycle policy.


state?

Type: string (optional)

The activation state of the lifecycle policy.


tags?

Type: CfnTag[] (optional)

The tags to apply to the lifecycle policy during creation.