software.amazon.awscdk.services.fsx

Class CfnStorageVirtualMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.fsx.CfnStorageVirtualMachine

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.447Z")
 @Stability(value=Stable)
public class CfnStorageVirtualMachine
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FSx::StorageVirtualMachine`.

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

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.fsx.*;
 CfnStorageVirtualMachine cfnStorageVirtualMachine = CfnStorageVirtualMachine.Builder.create(this, "MyCfnStorageVirtualMachine")
         .fileSystemId("fileSystemId")
         .name("name")
         // the properties below are optional
         .activeDirectoryConfiguration(ActiveDirectoryConfigurationProperty.builder()
                 .netBiosName("netBiosName")
                 .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder()
                         .dnsIps(List.of("dnsIps"))
                         .domainName("domainName")
                         .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
                         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                         .password("password")
                         .userName("userName")
                         .build())
                 .build())
         .rootVolumeSecurityStyle("rootVolumeSecurityStyle")
         .svmAdminPassword("svmAdminPassword")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty Describes the self-managed Microsoft Active Directory to which you want to join the SVM.
static class	CfnStorageVirtualMachine.Builder A fluent builder for CfnStorageVirtualMachine.
static interface	CfnStorageVirtualMachine.SelfManagedActiveDirectoryConfigurationProperty The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStorageVirtualMachine(software.constructs.Construct scope, String id, CfnStorageVirtualMachineProps props) Create a new `AWS::FSx::StorageVirtualMachine`.
protected	CfnStorageVirtualMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStorageVirtualMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActiveDirectoryConfiguration() Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
String	getAttrResourceArn() Returns the storage virtual machine's Amazon Resource Name (ARN).
String	getAttrStorageVirtualMachineId() Returns the storgage virtual machine's system generated ID.
String	getAttrUuid() Returns the storage virtual machine's system generated unique identifier (UUID).
protected Map<String,Object>	getCfnProperties()
String	getFileSystemId() Specifies the FSx for ONTAP file system on which to create the SVM.
String	getName() The name of the SVM.
String	getRootVolumeSecurityStyle() The security style of the root volume of the SVM.
String	getSvmAdminPassword() Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActiveDirectoryConfiguration(CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty value) Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
void	setActiveDirectoryConfiguration(IResolvable value) Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
void	setFileSystemId(String value) Specifies the FSx for ONTAP file system on which to create the SVM.
void	setName(String value) The name of the SVM.
void	setRootVolumeSecurityStyle(String value) The security style of the root volume of the SVM.
void	setSvmAdminPassword(String value) Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStorageVirtualMachine

protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObjectRef objRef)

CfnStorageVirtualMachine

protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStorageVirtualMachine

@Stability(value=Stable)
public CfnStorageVirtualMachine(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         CfnStorageVirtualMachineProps props)

Create a new `AWS::FSx::StorageVirtualMachine`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrResourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrResourceArn()

Returns the storage virtual machine's Amazon Resource Name (ARN).

Example: arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456

getAttrStorageVirtualMachineId

@Stability(value=Stable)
 @NotNull
public String getAttrStorageVirtualMachineId()

Returns the storgage virtual machine's system generated ID.

Example: svm-0123456789abcedf1

getAttrUuid

@Stability(value=Stable)
 @NotNull
public String getAttrUuid()

Returns the storage virtual machine's system generated unique identifier (UUID).

Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getFileSystemId

@Stability(value=Stable)
 @NotNull
public String getFileSystemId()

Specifies the FSx for ONTAP file system on which to create the SVM.

setFileSystemId

@Stability(value=Stable)
public void setFileSystemId(@NotNull
                                                     String value)

Specifies the FSx for ONTAP file system on which to create the SVM.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the SVM.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the SVM.

getActiveDirectoryConfiguration

@Stability(value=Stable)
 @Nullable
public Object getActiveDirectoryConfiguration()

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

setActiveDirectoryConfiguration

@Stability(value=Stable)
public void setActiveDirectoryConfiguration(@Nullable
                                                                     CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty value)

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

setActiveDirectoryConfiguration

@Stability(value=Stable)
public void setActiveDirectoryConfiguration(@Nullable
                                                                     IResolvable value)

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

getRootVolumeSecurityStyle

@Stability(value=Stable)
 @Nullable
public String getRootVolumeSecurityStyle()

The security style of the root volume of the SVM. Specify one of the following values:.

• UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
• NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
• MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

setRootVolumeSecurityStyle

@Stability(value=Stable)
public void setRootVolumeSecurityStyle(@Nullable
                                                                String value)

The security style of the root volume of the SVM. Specify one of the following values:.

• UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
• NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
• MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

getSvmAdminPassword

@Stability(value=Stable)
 @Nullable
public String getSvmAdminPassword()

Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

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 .

setSvmAdminPassword

@Stability(value=Stable)
public void setSvmAdminPassword(@Nullable
                                                         String value)

Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

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 .