interface CfnSnapshotProps

Language	Type name
.NET	Amazon.CDK.AWS.Redshift.CfnSnapshotProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsredshift#CfnSnapshotProps
Java	software.amazon.awscdk.services.redshift.CfnSnapshotProps
Python	aws_cdk.aws_redshift.CfnSnapshotProps
TypeScript	aws-cdk-lib » aws_redshift » CfnSnapshotProps

Properties for defining a CfnSnapshot.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshift as redshift } from 'aws-cdk-lib';
const cfnSnapshotProps: redshift.CfnSnapshotProps = {
  clusterIdentifier: 'clusterIdentifier',
  snapshotIdentifier: 'snapshotIdentifier',

  // the properties below are optional
  manualSnapshotRetentionPeriod: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
clusterIdentifier	string	The cluster identifier for which you want a snapshot.
snapshotIdentifier	string	A unique identifier for the snapshot that you are requesting.
manualSnapshotRetentionPeriod?	number	The number of days that a manual snapshot is retained.
tags?	CfnTag[]	A list of tag instances.

---

clusterIdentifier

Type: string

The cluster identifier for which you want a snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-snapshot.html#cfn-redshift-snapshot-clusteridentifier

---

snapshotIdentifier

Type: string

A unique identifier for the snapshot that you are requesting.

This identifier must be unique for all snapshots within the Amazon Web Services account.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-snapshot.html#cfn-redshift-snapshot-snapshotidentifier

---

manualSnapshotRetentionPeriod?

Type: number (optional)

The number of days that a manual snapshot is retained.

If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3653.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-snapshot.html#cfn-redshift-snapshot-manualsnapshotretentionperiod

---

tags?

Type: CfnTag[] (optional)

A list of tag instances.

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