Class CfnSnapshot
A CloudFormation AWS::FSx::Snapshot
.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class CfnSnapshot : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSnapshot
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
A snapshot of an Amazon FSx for OpenZFS volume.
CloudformationResource: AWS::FSx::Snapshot
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html
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(Construct, String, ICfnSnapshotProps) | Create a new |
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 |
Properties
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 | An array of key-value pairs to apply to this resource. |
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(Construct, String, ICfnSnapshotProps)
Create a new AWS::FSx::Snapshot
.
public CfnSnapshot(Construct scope, string id, ICfnSnapshotProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSnapshotProps
- resource properties.
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
Properties
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
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
VolumeId
The ID of the volume that the snapshot is of.
public virtual string VolumeId { get; set; }
Property Value
System.String
Remarks
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>