interface SnapshotProperty

Language	Type name
.NET	Amazon.CDK.AWS.RedshiftServerless.CfnSnapshot.SnapshotProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsredshiftserverless#CfnSnapshot_SnapshotProperty
Java	software.amazon.awscdk.services.redshiftserverless.CfnSnapshot.SnapshotProperty
Python	aws_cdk.aws_redshiftserverless.CfnSnapshot.SnapshotProperty
TypeScript	aws-cdk-lib » aws_redshiftserverless » CfnSnapshot » SnapshotProperty

A snapshot object that contains databases.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshiftserverless as redshiftserverless } from 'aws-cdk-lib';
const snapshotProperty: redshiftserverless.CfnSnapshot.SnapshotProperty = {
  adminUsername: 'adminUsername',
  kmsKeyId: 'kmsKeyId',
  namespaceArn: 'namespaceArn',
  namespaceName: 'namespaceName',
  ownerAccount: 'ownerAccount',
  retentionPeriod: 123,
  snapshotArn: 'snapshotArn',
  snapshotCreateTime: 'snapshotCreateTime',
  snapshotName: 'snapshotName',
  status: 'status',
};

Properties

Name	Type	Description
adminUsername?	string	The username of the database within a snapshot.
kmsKeyId?	string	The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn?	string	The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName?	string	The name of the namepsace.
ownerAccount?	string	The owner AWS ;
retentionPeriod?	number	The retention period of the snapshot created by the scheduled action.
snapshotArn?	string	The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime?	string	The timestamp of when the snapshot was created.
snapshotName?	string	The name of the snapshot.
status?	string	The status of the snapshot.

---

adminUsername?

Type: string (optional)

The username of the database within a snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-adminusername

---

kmsKeyId?

Type: string (optional)

The unique identifier of the KMS key used to encrypt the snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-kmskeyid

---

namespaceArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-namespacearn

---

namespaceName?

Type: string (optional)

The name of the namepsace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-namespacename

---

ownerAccount?

Type: string (optional)

The owner AWS ;

account of the snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-owneraccount

---

retentionPeriod?

Type: number (optional)

The retention period of the snapshot created by the scheduled action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-retentionperiod

---

snapshotArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotarn

---

snapshotCreateTime?

Type: string (optional)

The timestamp of when the snapshot was created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotcreatetime

---

snapshotName?

Type: string (optional)

The name of the snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotname

---

status?

Type: string (optional)

The status of the snapshot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-status