Class CfnRuleMixinProps

Properties for CfnRulePropsMixin.

Inheritance

object

CfnRuleMixinProps

Implements

ICfnRuleMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Rbin

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnRuleMixinProps : ICfnRuleMixinProps

Syntax (vb)

Public Class CfnRuleMixinProps Implements ICfnRuleMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.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.CfnPropertyMixins.AWS.Rbin;

             var cfnRuleMixinProps = new CfnRuleMixinProps {
                 Description = "description",
                 ExcludeResourceTags = new [] { new ResourceTagProperty {
                     ResourceTagKey = "resourceTagKey",
                     ResourceTagValue = "resourceTagValue"
                 } },
                 LockConfiguration = new UnlockDelayProperty {
                     UnlockDelayUnit = "unlockDelayUnit",
                     UnlockDelayValue = 123
                 },
                 ResourceTags = new [] { new ResourceTagProperty {
                     ResourceTagKey = "resourceTagKey",
                     ResourceTagValue = "resourceTagValue"
                 } },
                 ResourceType = "resourceType",
                 RetentionPeriod = new RetentionPeriodProperty {
                     RetentionPeriodUnit = "retentionPeriodUnit",
                     RetentionPeriodValue = 123
                 },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnRuleMixinProps()

Properties for CfnRulePropsMixin.

Properties

Description	The retention rule description.
ExcludeResourceTags	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
LockConfiguration	Information about the retention rule lock configuration.
ResourceTags	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
ResourceType	The resource type to be retained by the retention rule.
RetentionPeriod	Information about the retention period for which the retention rule is to retain resources.
Status	The state of the retention rule.
Tags	Information about the tags to assign to the retention rule.

Constructors

CfnRuleMixinProps()

Properties for CfnRulePropsMixin.

public CfnRuleMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.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.CfnPropertyMixins.AWS.Rbin;

             var cfnRuleMixinProps = new CfnRuleMixinProps {
                 Description = "description",
                 ExcludeResourceTags = new [] { new ResourceTagProperty {
                     ResourceTagKey = "resourceTagKey",
                     ResourceTagValue = "resourceTagValue"
                 } },
                 LockConfiguration = new UnlockDelayProperty {
                     UnlockDelayUnit = "unlockDelayUnit",
                     UnlockDelayValue = 123
                 },
                 ResourceTags = new [] { new ResourceTagProperty {
                     ResourceTagKey = "resourceTagKey",
                     ResourceTagValue = "resourceTagValue"
                 } },
                 ResourceType = "resourceType",
                 RetentionPeriod = new RetentionPeriodProperty {
                     RetentionPeriodUnit = "retentionPeriodUnit",
                     RetentionPeriodValue = 123
                 },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

The retention rule description.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-description

ExcludeResourceTags

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.

public object? ExcludeResourceTags { get; set; }

Property Value

object

Remarks

Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-excluderesourcetags

Type union: either IResolvable or (either IResolvable or CfnRulePropsMixin.IResourceTagProperty)[]

LockConfiguration

Information about the retention rule lock configuration.

public object? LockConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-lockconfiguration

Type union: either IResolvable or CfnRulePropsMixin.IUnlockDelayProperty

ResourceTags

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.

public object? ResourceTags { get; set; }

Property Value

object

Remarks

For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetags

Type union: either IResolvable or (either IResolvable or CfnRulePropsMixin.IResourceTagProperty)[]

ResourceType

The resource type to be retained by the retention rule.

public string? ResourceType { get; set; }

Property Value

string

Remarks

Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetype

RetentionPeriod

Information about the retention period for which the retention rule is to retain resources.

public object? RetentionPeriod { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-retentionperiod

Type union: either IResolvable or CfnRulePropsMixin.IRetentionPeriodProperty

Status

The state of the retention rule.

public string? Status { get; set; }

Property Value

string

Remarks

Only retention rules that are in the available state retain resources.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-status

Implements

ICfnRuleMixinProps