Class CfnStorageVirtualMachine
A CloudFormation AWS::FSx::StorageVirtualMachine
.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class CfnStorageVirtualMachine : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStorageVirtualMachine
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
CloudformationResource: AWS::FSx::StorageVirtualMachine
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 cfnStorageVirtualMachine = new CfnStorageVirtualMachine(this, "MyCfnStorageVirtualMachine", new CfnStorageVirtualMachineProps {
FileSystemId = "fileSystemId",
Name = "name",
// the properties below are optional
ActiveDirectoryConfiguration = new ActiveDirectoryConfigurationProperty {
NetBiosName = "netBiosName",
SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
DnsIps = new [] { "dnsIps" },
DomainName = "domainName",
FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
Password = "password",
UserName = "userName"
}
},
RootVolumeSecurityStyle = "rootVolumeSecurityStyle",
SvmAdminPassword = "svmAdminPassword",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnStorageVirtualMachine(Construct, String, ICfnStorageVirtualMachineProps) | Create a new |
CfnStorageVirtualMachine(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStorageVirtualMachine(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ActiveDirectoryConfiguration | Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable. |
AttrResourceArn | Returns the storage virtual machine's Amazon Resource Name (ARN). |
AttrStorageVirtualMachineId | Returns the storgage virtual machine's system generated ID. |
AttrUuid | Returns the storage virtual machine's system generated unique identifier (UUID). |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
FileSystemId | Specifies the FSx for ONTAP file system on which to create the SVM. |
Name | The name of the SVM. |
RootVolumeSecurityStyle | The security style of the root volume of the SVM. Specify one of the following values:. |
SvmAdminPassword | Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStorageVirtualMachine(Construct, String, ICfnStorageVirtualMachineProps)
Create a new AWS::FSx::StorageVirtualMachine
.
public CfnStorageVirtualMachine(Construct scope, string id, ICfnStorageVirtualMachineProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnStorageVirtualMachineProps
- resource properties.
CfnStorageVirtualMachine(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStorageVirtualMachine(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStorageVirtualMachine(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStorageVirtualMachine(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ActiveDirectoryConfiguration
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
public virtual object ActiveDirectoryConfiguration { get; set; }
Property Value
System.Object
Remarks
AttrResourceArn
Returns the storage virtual machine's Amazon Resource Name (ARN).
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456
CloudformationAttribute: ResourceARN
AttrStorageVirtualMachineId
Returns the storgage virtual machine's system generated ID.
public virtual string AttrStorageVirtualMachineId { get; }
Property Value
System.String
Remarks
Example: svm-0123456789abcedf1
CloudformationAttribute: StorageVirtualMachineId
AttrUuid
Returns the storage virtual machine's system generated unique identifier (UUID).
public virtual string AttrUuid { get; }
Property Value
System.String
Remarks
Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc
CloudformationAttribute: UUID
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
FileSystemId
Specifies the FSx for ONTAP file system on which to create the SVM.
public virtual string FileSystemId { get; set; }
Property Value
System.String
Remarks
Name
The name of the SVM.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
RootVolumeSecurityStyle
The security style of the root volume of the SVM. Specify one of the following values:.
public virtual string RootVolumeSecurityStyle { get; set; }
Property Value
System.String
Remarks
SvmAdminPassword
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.
public virtual string SvmAdminPassword { get; set; }
Property Value
System.String
Remarks
Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin
user to manage the SVM. For more information, see Managing SVMs using the NetApp ONTAP CLI in the FSx for ONTAP User Guide .
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
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>