Class CfnSnapshot
A snapshot of an Amazon FSx for OpenZFS volume.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSnapshot : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSnapshot
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html
CloudformationResource: AWS::FSx::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.FSx;
var cfnSnapshot = new CfnSnapshot(this, "MyCfnSnapshot", new CfnSnapshotProps {
Name = "name",
VolumeId = "volumeId",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSnapshot(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSnapshot(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSnapshot(Construct, String, ICfnSnapshotProps) |
Properties
AttrId | |
AttrResourceArn | Returns the snapshot's Amazon Resource Name (ARN). |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | The name of the snapshot. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of |
VolumeId | The ID of the volume that the snapshot is of. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSnapshot(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSnapshot(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSnapshot(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSnapshot(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSnapshot(Construct, String, ICfnSnapshotProps)
public CfnSnapshot(Construct scope, string id, ICfnSnapshotProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSnapshotProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrResourceArn
Returns the snapshot's Amazon Resource Name (ARN).
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5
CloudformationAttribute: ResourceARN
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
The name of the snapshot.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of Tag
values, with a maximum of 50 elements.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VolumeId
The ID of the volume that the snapshot is of.
public virtual string VolumeId { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>