@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
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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| 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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnStorageVirtualMachine(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnStorageVirtualMachineProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrResourceArn()
Example: arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456
@Stability(value=Stable) @NotNull public String getAttrStorageVirtualMachineId()
Example: svm-0123456789abcedf1
@Stability(value=Stable) @NotNull public String getAttrUuid()
Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
For more information, see Tag .
@Stability(value=Stable) @NotNull public String getFileSystemId()
@Stability(value=Stable)
public void setFileSystemId(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @Nullable public Object getActiveDirectoryConfiguration()
@Stability(value=Stable)
public void setActiveDirectoryConfiguration(@Nullable
CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty value)
@Stability(value=Stable)
public void setActiveDirectoryConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getRootVolumeSecurityStyle()
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.@Stability(value=Stable)
public void setRootVolumeSecurityStyle(@Nullable
String value)
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.@Stability(value=Stable) @Nullable public String getSvmAdminPassword()
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 .
@Stability(value=Stable)
public void setSvmAdminPassword(@Nullable
String value)
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 .
Copyright © 2022. All rights reserved.