Class CfnLifecyclePolicy

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnLifecyclePolicy

Implements

IInspectable

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(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<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.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.OpenSearchServerless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLifecyclePolicy : CfnResource, IInspectable

Syntax (vb)

Public Class CfnLifecyclePolicy
    Inherits CfnResource
    Implements IInspectable

Remarks

Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html

CloudformationResource: AWS::OpenSearchServerless::LifecyclePolicy

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

var cfnLifecyclePolicy = new CfnLifecyclePolicy(this, "MyCfnLifecyclePolicy", new CfnLifecyclePolicyProps {
    Name = "name",
    Policy = "policy",
    Type = "type",

    // the properties below are optional
    Description = "description"
});

Synopsis

Constructors

CfnLifecyclePolicy(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnLifecyclePolicy(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnLifecyclePolicy(Construct, String, ICfnLifecyclePolicyProps)

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Description	The description of the lifecycle policy.
Name	The name of the lifecycle policy.
Policy	The JSON policy document without any whitespaces.
Type	The type of lifecycle policy.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnLifecyclePolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnLifecyclePolicy(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnLifecyclePolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnLifecyclePolicy(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnLifecyclePolicy(Construct, String, ICfnLifecyclePolicyProps)

public CfnLifecyclePolicy(Construct scope, string id, ICfnLifecyclePolicyProps props)

Parameters

scope Constructs.Construct

Scope in which this resource is defined.

id System.String

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

props ICfnLifecyclePolicyProps

Resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

Description

The description of the lifecycle policy.

public virtual string Description { get; set; }

Property Value

System.String

Name

The name of the lifecycle policy.

public virtual string Name { get; set; }

Property Value

System.String

Policy

The JSON policy document without any whitespaces.

public virtual string Policy { get; set; }

Property Value

System.String

Type

The type of lifecycle policy.

public virtual string Type { get; set; }

Property Value

System.String

Methods

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.

RenderProperties(IDictionary<String, Object>)

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

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable