Interface ICfnLifecyclePolicyProps

Properties for defining a CfnLifecyclePolicy.

Namespace: Amazon.CDK.AWS.DLM

Assembly: Amazon.CDK.AWS.DLM.dll

Syntax (csharp)

public interface ICfnLifecyclePolicyProps

Syntax (vb)

Public Interface ICfnLifecyclePolicyProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DLM;

var cfnLifecyclePolicyProps = new CfnLifecyclePolicyProps {
    Description = "description",
    ExecutionRoleArn = "executionRoleArn",
    PolicyDetails = new PolicyDetailsProperty {
        Actions = new [] { new ActionProperty {
            CrossRegionCopy = new [] { new CrossRegionCopyActionProperty {
                EncryptionConfiguration = new EncryptionConfigurationProperty {
                    Encrypted = false,

                    // the properties below are optional
                    CmkArn = "cmkArn"
                },
                Target = "target",

                // the properties below are optional
                RetainRule = new CrossRegionCopyRetainRuleProperty {
                    Interval = 123,
                    IntervalUnit = "intervalUnit"
                }
            } },
            Name = "name"
        } },
        EventSource = new EventSourceProperty {
            Type = "type",

            // the properties below are optional
            Parameters = new EventParametersProperty {
                EventType = "eventType",
                SnapshotOwner = new [] { "snapshotOwner" },

                // the properties below are optional
                DescriptionRegex = "descriptionRegex"
            }
        },
        Parameters = new ParametersProperty {
            ExcludeBootVolume = false,
            ExcludeDataVolumeTags = new [] { new CfnTag {
                Key = "key",
                Value = "value"
            } },
            NoReboot = false
        },
        PolicyType = "policyType",
        ResourceLocations = new [] { "resourceLocations" },
        ResourceTypes = new [] { "resourceTypes" },
        Schedules = new [] { new ScheduleProperty {
            ArchiveRule = new ArchiveRuleProperty {
                RetainRule = new ArchiveRetainRuleProperty {
                    RetentionArchiveTier = new RetentionArchiveTierProperty {
                        Count = 123,
                        Interval = 123,
                        IntervalUnit = "intervalUnit"
                    }
                }
            },
            CopyTags = false,
            CreateRule = new CreateRuleProperty {
                CronExpression = "cronExpression",
                Interval = 123,
                IntervalUnit = "intervalUnit",
                Location = "location",
                Times = new [] { "times" }
            },
            CrossRegionCopyRules = new [] { new CrossRegionCopyRuleProperty {
                Encrypted = false,

                // the properties below are optional
                CmkArn = "cmkArn",
                CopyTags = false,
                DeprecateRule = new CrossRegionCopyDeprecateRuleProperty {
                    Interval = 123,
                    IntervalUnit = "intervalUnit"
                },
                RetainRule = new CrossRegionCopyRetainRuleProperty {
                    Interval = 123,
                    IntervalUnit = "intervalUnit"
                },
                Target = "target",
                TargetRegion = "targetRegion"
            } },
            DeprecateRule = new DeprecateRuleProperty {
                Count = 123,
                Interval = 123,
                IntervalUnit = "intervalUnit"
            },
            FastRestoreRule = new FastRestoreRuleProperty {
                AvailabilityZones = new [] { "availabilityZones" },
                Count = 123,
                Interval = 123,
                IntervalUnit = "intervalUnit"
            },
            Name = "name",
            RetainRule = new RetainRuleProperty {
                Count = 123,
                Interval = 123,
                IntervalUnit = "intervalUnit"
            },
            ShareRules = new [] { new ShareRuleProperty {
                TargetAccounts = new [] { "targetAccounts" },
                UnshareInterval = 123,
                UnshareIntervalUnit = "unshareIntervalUnit"
            } },
            TagsToAdd = new [] { new CfnTag {
                Key = "key",
                Value = "value"
            } },
            VariableTags = new [] { new CfnTag {
                Key = "key",
                Value = "value"
            } }
        } },
        TargetTags = new [] { new CfnTag {
            Key = "key",
            Value = "value"
        } }
    },
    State = "state",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

Description	A description of the lifecycle policy.
ExecutionRoleArn	The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
PolicyDetails	The configuration details of the lifecycle policy.
State	The activation state of the lifecycle policy.
Tags	The tags to apply to the lifecycle policy during creation.

Properties

Description

A description of the lifecycle policy.

virtual string Description { get; }

Property Value

System.String

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-description

ExecutionRoleArn

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

virtual string ExecutionRoleArn { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-executionrolearn

PolicyDetails

The configuration details of the lifecycle policy.

virtual object PolicyDetails { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-policydetails

State

The activation state of the lifecycle policy.

virtual string State { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-state