Package software.amazon.awscdk.services.redshiftserverless

Interface CfnSnapshot.SnapshotProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSnapshot.SnapshotProperty.Jsii$Proxy

Enclosing class:

CfnSnapshot

@Stability(Stable)
public static interface CfnSnapshot.SnapshotProperty
extends software.amazon.jsii.JsiiSerializable

A snapshot object that contains databases.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshiftserverless.*;
 SnapshotProperty snapshotProperty = SnapshotProperty.builder()
         .adminUsername("adminUsername")
         .kmsKeyId("kmsKeyId")
         .namespaceArn("namespaceArn")
         .namespaceName("namespaceName")
         .ownerAccount("ownerAccount")
         .retentionPeriod(123)
         .snapshotArn("snapshotArn")
         .snapshotCreateTime("snapshotCreateTime")
         .snapshotName("snapshotName")
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSnapshot.SnapshotProperty.Builder	A builder for CfnSnapshot.SnapshotProperty
static final class	CfnSnapshot.SnapshotProperty.Jsii$Proxy	An implementation for CfnSnapshot.SnapshotProperty

Method Summary

Modifier and Type	Method	Description
static CfnSnapshot.SnapshotProperty.Builder	builder()
default String	getAdminUsername()	The username of the database within a snapshot.
default String	getKmsKeyId()	The unique identifier of the KMS key used to encrypt the snapshot.
default String	getNamespaceArn()	The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
default String	getNamespaceName()	The name of the namepsace.
default String	getOwnerAccount()	The owner AWS ;
default Number	getRetentionPeriod()	The retention period of the snapshot created by the scheduled action.
default String	getSnapshotArn()	The Amazon Resource Name (ARN) of the snapshot.
default String	getSnapshotCreateTime()	The timestamp of when the snapshot was created.
default String	getSnapshotName()	The name of the snapshot.
default String	getStatus()	The status of the snapshot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdminUsername

@Stability(Stable)
@Nullable
default String getAdminUsername()

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

getNamespaceArn

@Stability(Stable)
@Nullable
default String getNamespaceArn()

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

getNamespaceName

@Stability(Stable)
@Nullable
default String getNamespaceName()

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

getOwnerAccount

@Stability(Stable)
@Nullable
default String getOwnerAccount()

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

getRetentionPeriod

@Stability(Stable)
@Nullable
default Number getRetentionPeriod()

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

getSnapshotArn

@Stability(Stable)
@Nullable
default String getSnapshotArn()

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

getSnapshotCreateTime

@Stability(Stable)
@Nullable
default String getSnapshotCreateTime()

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

getSnapshotName

@Stability(Stable)
@Nullable
default String getSnapshotName()

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

builder

@Stability(Stable)
static CfnSnapshot.SnapshotProperty.Builder builder()

Returns:

a CfnSnapshot.SnapshotProperty.Builder of CfnSnapshot.SnapshotProperty