Class CfnSnapshot

Resource Type definition for AWS::MemoryDB::Snapshot.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSnapshot

Implements

IInspectable

ISnapshotRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

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.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.MemoryDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSnapshot : CfnResource, IInspectable, ISnapshotRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnSnapshot Inherits CfnResource Implements IInspectable, ISnapshotRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

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

             var cfnSnapshot = new CfnSnapshot(this, "MyCfnSnapshot", new CfnSnapshotProps {
                 ClusterName = "clusterName",
                 SnapshotName = "snapshotName",

                 // the properties below are optional
                 KmsKeyId = "kmsKeyId",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnSnapshot(Construct, string, ICfnSnapshotProps)

Create a new AWS::MemoryDB::Snapshot.

Properties

AttrArn	The ARN (Amazon Resource Name) of the snapshot.
AttrClusterConfiguration	Resource Type definition for AWS::MemoryDB::Snapshot.
AttrDataTiering	Enables data tiering.
AttrSource	Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
AttrStatus	The status of the snapshot.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Resource Type definition for AWS::MemoryDB::Snapshot.
CfnPropertyNames	Resource Type definition for AWS::MemoryDB::Snapshot.
ClusterName	The name of the cluster from which the snapshot was taken.
KmsKeyId	The ID of the KMS key used to encrypt the snapshot.
SnapshotName	The name of the snapshot.
SnapshotRef	A reference to a Snapshot resource.
Tags	A list of tags to be added to this resource.

Methods

ArnForSnapshot(ISnapshotRef)	Resource Type definition for AWS::MemoryDB::Snapshot.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSnapshot(object)	Checks whether the given object is a CfnSnapshot.
RenderProperties(IDictionary<string, object>)	Resource Type definition for AWS::MemoryDB::Snapshot.

Constructors

CfnSnapshot(Construct, string, ICfnSnapshotProps)

Create a new AWS::MemoryDB::Snapshot.

public CfnSnapshot(Construct scope, string id, ICfnSnapshotProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnSnapshotProps

Resource properties.

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN (Amazon Resource Name) of the snapshot.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrClusterConfiguration

Resource Type definition for AWS::MemoryDB::Snapshot.

public virtual IResolvable AttrClusterConfiguration { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: ClusterConfiguration

AttrDataTiering

Enables data tiering.

public virtual string AttrDataTiering { get; }

Property Value

string

Remarks

Data tiering is only supported for clusters using the r6gd node type.

CloudformationAttribute: DataTiering

AttrSource

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

public virtual string AttrSource { get; }

Property Value

string

Remarks

CloudformationAttribute: Source

AttrStatus

The status of the snapshot.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

Valid values: creating | available | restoring | copying | deleting.

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::MemoryDB::Snapshot.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::MemoryDB::Snapshot.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

ClusterName

The name of the cluster from which the snapshot was taken.

public virtual string ClusterName { get; set; }

Property Value

string

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

KmsKeyId

The ID of the KMS key used to encrypt the snapshot.

public virtual string? KmsKeyId { get; set; }

Property Value

string

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

SnapshotName

The name of the snapshot.

public virtual string SnapshotName { get; set; }

Property Value

string

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

SnapshotRef

A reference to a Snapshot resource.

public virtual ISnapshotReference SnapshotRef { get; }

Property Value

ISnapshotReference

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

Tags

A list of tags to be added to this resource.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

Methods

ArnForSnapshot(ISnapshotRef)

Resource Type definition for AWS::MemoryDB::Snapshot.

public static string ArnForSnapshot(ISnapshotRef resource)

Parameters

resource ISnapshotRef

Returns

string

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

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

             var cfnSnapshot = new CfnSnapshot(this, "MyCfnSnapshot", new CfnSnapshotProps {
                 ClusterName = "clusterName",
                 SnapshotName = "snapshotName",

                 // the properties below are optional
                 KmsKeyId = "kmsKeyId",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

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.

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

IsCfnSnapshot(object)

Checks whether the given object is a CfnSnapshot.

public static bool IsCfnSnapshot(object x)

Parameters

x object

Returns

bool

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::MemoryDB::Snapshot.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Represents a copy of an entire cluster as of the time when the snapshot was taken.

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

CloudformationResource: AWS::MemoryDB::Snapshot

ExampleMetadata: fixture=_generated

Implements

IInspectable

ISnapshotRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2