Class: AWSCDK::FSX::CfnStorageVirtualMachineProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fsx/cfn_storage_virtual_machine_props.rb

Overview

Properties for defining a CfnStorageVirtualMachine.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_system_id:, name:, active_directory_configuration: nil, root_volume_security_style: nil, svm_admin_password: nil, tags: nil) ⇒ CfnStorageVirtualMachineProps

Returns a new instance of CfnStorageVirtualMachineProps.

Parameters:

  • file_system_id (String) —

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

  • name (String) —

    The name of the SVM.

  • active_directory_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnStorageVirtualMachine::ActiveDirectoryConfigurationProperty, nil) (defaults to: nil) —

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

  • root_volume_security_style (String, nil) (defaults to: nil) —

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

  • svm_admin_password (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of Tag values, with a maximum of 50 elements.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 15

def initialize(file_system_id:, name:, active_directory_configuration: nil, root_volume_security_style: nil, svm_admin_password: nil, tags: nil)
  @file_system_id = file_system_id
  Jsii::Type.check_type(@file_system_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @active_directory_configuration = active_directory_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnStorageVirtualMachine::ActiveDirectoryConfigurationProperty.new(**active_directory_configuration.transform_keys(&:to_sym)) : active_directory_configuration
  Jsii::Type.check_type(@active_directory_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuU3RvcmFnZVZpcnR1YWxNYWNoaW5lLkFjdGl2ZURpcmVjdG9yeUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "activeDirectoryConfiguration") unless @active_directory_configuration.nil?
  @root_volume_security_style = root_volume_security_style
  Jsii::Type.check_type(@root_volume_security_style, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "rootVolumeSecurityStyle") unless @root_volume_security_style.nil?
  @svm_admin_password = svm_admin_password
  Jsii::Type.check_type(@svm_admin_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "svmAdminPassword") unless @svm_admin_password.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#active_directory_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



44
45
46
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 44

def active_directory_configuration
  @active_directory_configuration
end

#file_system_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



34
35
36
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 34

def file_system_id
  @file_system_id
end

#name ⇒ String (readonly)

The name of the SVM.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 39

def name
  @name
end

#root_volume_security_style ⇒ String? (readonly)

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 Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
  • MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.

Returns:

  • (String, nil)

See Also:



53
54
55
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 53

def root_volume_security_style
  @root_volume_security_style
end

#svm_admin_password ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 60

def svm_admin_password
  @svm_admin_password
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of Tag values, with a maximum of 50 elements.

Returns:

See Also:



65
66
67
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 65

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 67

def self.jsii_properties
  {
    :file_system_id => "fileSystemId",
    :name => "name",
    :active_directory_configuration => "activeDirectoryConfiguration",
    :root_volume_security_style => "rootVolumeSecurityStyle",
    :svm_admin_password => "svmAdminPassword",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'fsx/cfn_storage_virtual_machine_props.rb', line 78

def to_jsii
  result = {}
  result.merge!({
    "fileSystemId" => @file_system_id,
    "name" => @name,
    "activeDirectoryConfiguration" => @active_directory_configuration,
    "rootVolumeSecurityStyle" => @root_volume_security_style,
    "svmAdminPassword" => @svm_admin_password,
    "tags" => @tags,
  })
  result.compact
end