class CfnLifecyclePolicy (construct)

Language	Type name
.NET	Amazon.CDK.AWS.DLM.CfnLifecyclePolicy
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdlm#CfnLifecyclePolicy
Java	software.amazon.awscdk.services.dlm.CfnLifecyclePolicy
Python	aws_cdk.aws_dlm.CfnLifecyclePolicy
TypeScript	aws-cdk-lib » aws_dlm » CfnLifecyclePolicy

Implements IConstruct, IDependable, IInspectable, ITaggable

Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources.

The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy.

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

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';

declare const crossRegionCopyTargets: any;
declare const excludeTags: any;
declare const excludeVolumeTypes: any;
const cfnLifecyclePolicy = new dlm.CfnLifecyclePolicy(this, 'MyCfnLifecyclePolicy', /* all optional props */ {
  copyTags: false,
  createInterval: 123,
  crossRegionCopyTargets: crossRegionCopyTargets,
  defaultPolicy: 'defaultPolicy',
  description: 'description',
  exclusions: {
    excludeBootVolumes: false,
    excludeTags: excludeTags,
    excludeVolumeTypes: excludeVolumeTypes,
  },
  executionRoleArn: 'executionRoleArn',
  extendDeletion: false,
  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',
    }],
    copyTags: false,
    createInterval: 123,
    crossRegionCopyTargets: crossRegionCopyTargets,
    eventSource: {
      type: 'type',

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

        // the properties below are optional
        descriptionRegex: 'descriptionRegex',
      },
    },
    exclusions: {
      excludeBootVolumes: false,
      excludeTags: excludeTags,
      excludeVolumeTypes: excludeVolumeTypes,
    },
    extendDeletion: false,
    parameters: {
      excludeBootVolume: false,
      excludeDataVolumeTags: [{
        key: 'key',
        value: 'value',
      }],
      noReboot: false,
    },
    policyLanguage: 'policyLanguage',
    policyType: 'policyType',
    resourceLocations: ['resourceLocations'],
    resourceType: 'resourceType',
    resourceTypes: ['resourceTypes'],
    retainInterval: 123,
    schedules: [{
      archiveRule: {
        retainRule: {
          retentionArchiveTier: {
            count: 123,
            interval: 123,
            intervalUnit: 'intervalUnit',
          },
        },
      },
      copyTags: false,
      createRule: {
        cronExpression: 'cronExpression',
        interval: 123,
        intervalUnit: 'intervalUnit',
        location: 'location',
        scripts: [{
          executeOperationOnScriptFailure: false,
          executionHandler: 'executionHandler',
          executionHandlerService: 'executionHandlerService',
          executionTimeout: 123,
          maximumRetryCount: 123,
          stages: ['stages'],
        }],
        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',
    }],
  },
  retainInterval: 123,
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnLifecyclePolicy(scope: Construct, id: string, props?: CfnLifecyclePolicyProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnLifecyclePolicyProps — Resource properties.

Construct Props

Name	Type	Description
copyTags?	boolean | IResolvable	[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
createInterval?	number	[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
crossRegionCopyTargets?	any	[Default policies only] Specifies destination Regions for snapshot or AMI copies.
defaultPolicy?	string	[Default policies only] Specify the type of default policy to create.
description?	string	A description of the lifecycle policy.
exclusions?	IResolvable | ExclusionsProperty	[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
executionRoleArn?	string	The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
extendDeletion?	boolean | IResolvable	[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
policyDetails?	IResolvable | PolicyDetailsProperty	The configuration details of the lifecycle policy.
retainInterval?	number	[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
state?	string	The activation state of the lifecycle policy.
tags?	CfnTag[]	The tags to apply to the lifecycle policy during creation.

---

copyTags?

Type: boolean | IResolvable (optional)

[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

If you do not specify a value, the default is false .

Default: false

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-copytags

---

createInterval?

Type: number (optional)

[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.

The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

Default: 1

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-createinterval

---

crossRegionCopyTargets?

Type: any (optional)

[Default policies only] Specifies destination Regions for snapshot or AMI copies.

You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-crossregioncopytargets

---

defaultPolicy?

Type: string (optional)

[Default policies only] Specify the type of default policy to create.

• To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME .
• To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-defaultpolicy

---

description?

Type: string (optional)

A description of the lifecycle policy.

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

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

---

exclusions?

Type: IResolvable | ExclusionsProperty (optional)

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.

The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-exclusions

---

executionRoleArn?

Type: string (optional)

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

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

---

extendDeletion?

Type: boolean | IResolvable (optional)

[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

By default ( ExtendDeletion=false ):

• If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true .
• If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true .

If you enable extended deletion ( ExtendDeletion=true ), you override both default behaviors simultaneously.

If you do not specify a value, the default is false .

Default: false

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-extenddeletion

---

policyDetails?

Type: IResolvable | PolicyDetailsProperty (optional)

The configuration details of the lifecycle policy.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

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

---

retainInterval?

Type: number (optional)

[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.

The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

Default: 7

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-retaininterval

---

state?

Type: string (optional)

The activation state of the lifecycle policy.

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

---

tags?

Type: CfnTag[] (optional)

The tags to apply to the lifecycle policy during creation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-tags

Properties

Name	Type	Description
attrArn	string	The Amazon Resource Name (ARN) of the lifecycle policy.
attrId	string
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
copyTags?	boolean | IResolvable	[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
createInterval?	number	[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
crossRegionCopyTargets?	any	[Default policies only] Specifies destination Regions for snapshot or AMI copies.
defaultPolicy?	string	[Default policies only] Specify the type of default policy to create.
description?	string	A description of the lifecycle policy.
exclusions?	IResolvable | ExclusionsProperty	[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
executionRoleArn?	string	The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
extendDeletion?	boolean | IResolvable	[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
policyDetails?	IResolvable | PolicyDetailsProperty	The configuration details of the lifecycle policy.
retainInterval?	number	[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
state?	string	The activation state of the lifecycle policy.
tagsRaw?	CfnTag[]	The tags to apply to the lifecycle policy during creation.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The Amazon Resource Name (ARN) of the lifecycle policy.

---

attrId

Type: string

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

copyTags?

Type: boolean | IResolvable (optional)

[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

---

createInterval?

Type: number (optional)

[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.

---

crossRegionCopyTargets?

Type: any (optional)

[Default policies only] Specifies destination Regions for snapshot or AMI copies.

---

defaultPolicy?

Type: string (optional)

[Default policies only] Specify the type of default policy to create.

---

description?

Type: string (optional)

A description of the lifecycle policy.

---

exclusions?

Type: IResolvable | ExclusionsProperty (optional)

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.

---

executionRoleArn?

Type: string (optional)

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

---

extendDeletion?

Type: boolean | IResolvable (optional)

[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

---

policyDetails?

Type: IResolvable | PolicyDetailsProperty (optional)

The configuration details of the lifecycle policy.

---

retainInterval?

Type: number (optional)

[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.

---

state?

Type: string (optional)

The activation state of the lifecycle policy.

---

tagsRaw?

Type: CfnTag[] (optional)

The tags to apply to the lifecycle policy during creation.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }