Class CfnRule

Creates a Recycle Bin retention rule. You can create two types of retention rules:.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnRule

Implements

IInspectable

IRuleRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Rbin

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRule : CfnResource, IInspectable, IRuleRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnRule Inherits CfnResource Implements IInspectable, IRuleRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

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

             var cfnRule = new CfnRule(this, "MyCfnRule", new CfnRuleProps {
                 ResourceType = "resourceType",
                 RetentionPeriod = new RetentionPeriodProperty {
                     RetentionPeriodUnit = "retentionPeriodUnit",
                     RetentionPeriodValue = 123
                 },

                 // the properties below are optional
                 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"
                 } },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnRule(Construct, string, ICfnRuleProps)

Create a new AWS::Rbin::Rule.

Properties

AttrArn	The Amazon Resource Name (ARN) of the retention rule.
AttrIdentifier	The unique ID of the retention rule.
AttrLockState	[Region-level retention rules only] The lock state for the retention rule.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a Recycle Bin retention rule. You can create two types of retention rules:.
CfnPropertyNames	Creates a Recycle Bin retention rule. You can create two types of retention rules:.
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.
RuleRef	A reference to a Rule resource.
Status	The state of the retention rule.
Tags	Information about the tags to assign to the retention rule.

Methods

ArnForRule(IRuleRef)	Creates a Recycle Bin retention rule. You can create two types of retention rules:.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnRule(object)	Checks whether the given object is a CfnRule.
RenderProperties(IDictionary<string, object>)	Creates a Recycle Bin retention rule. You can create two types of retention rules:.

Constructors

CfnRule(Construct, string, ICfnRuleProps)

Create a new AWS::Rbin::Rule.

public CfnRule(Construct scope, string id, ICfnRuleProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnRuleProps

Resource properties.

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the retention rule.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrIdentifier

The unique ID of the retention rule.

public virtual string AttrIdentifier { get; }

Property Value

string

Remarks

CloudformationAttribute: Identifier

AttrLockState

[Region-level retention rules only] The lock state for the retention rule.

public virtual string AttrLockState { get; }

Property Value

string

Remarks

CloudformationAttribute: LockState

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

CfnProperties

Creates a Recycle Bin retention rule. You can create two types of retention rules:.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a Recycle Bin retention rule. You can create two types of retention rules:.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Description

The retention rule description.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

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 virtual object? ExcludeResourceTags { get; set; }

Property Value

object

Remarks

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

LockConfiguration

Information about the retention rule lock configuration.

public virtual object? LockConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnRule.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 virtual object? ResourceTags { get; set; }

Property Value

object

Remarks

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

ResourceType

The resource type to be retained by the retention rule.

public virtual string ResourceType { get; set; }

Property Value

string

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

RetentionPeriod

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

public virtual object RetentionPeriod { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnRule.IRetentionPeriodProperty

RuleRef

A reference to a Rule resource.

public virtual IRuleReference RuleRef { get; }

Property Value

IRuleReference

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Status

The state of the retention rule.

public virtual string? Status { get; set; }

Property Value

string

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Tags

Information about the tags to assign to the retention rule.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Methods

ArnForRule(IRuleRef)

Creates a Recycle Bin retention rule. You can create two types of retention rules:.

public static string ArnForRule(IRuleRef resource)

Parameters

resource IRuleRef

Returns

string

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

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

             var cfnRule = new CfnRule(this, "MyCfnRule", new CfnRuleProps {
                 ResourceType = "resourceType",
                 RetentionPeriod = new RetentionPeriodProperty {
                     RetentionPeriodUnit = "retentionPeriodUnit",
                     RetentionPeriodValue = 123
                 },

                 // the properties below are optional
                 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"
                 } },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

IsCfnRule(object)

Checks whether the given object is a CfnRule.

public static bool IsCfnRule(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a Recycle Bin retention rule. You can create two types of retention rules:.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

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

CloudformationResource: AWS::Rbin::Rule

ExampleMetadata: fixture=_generated

Implements

IInspectable

IRuleRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2