Class: AWSCDK::FSX::CfnFileSystem

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSFSX::IFileSystemRef
Defined in:
fsx/cfn_file_system.rb

Overview

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

You can create any of the following supported file system types:

  • Amazon FSx for Lustre
  • Amazon FSx for NetApp ONTAP
  • FSx for OpenZFS
  • Amazon FSx for Windows File Server

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFileSystem

Create a new AWS::FSx::FileSystem.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::FSX::CfnFileSystemProps) —

    Resource properties.



25
26
27
28
29
30
31
 
# File 'fsx/cfn_file_system.rb', line 25

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystemProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZnN4LkNmbkZpbGVTeXN0ZW1Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'fsx/cfn_file_system.rb', line 196

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_fsx.CfnFileSystem", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_file_system(x) ⇒ Boolean

Checks whether the given object is a CfnFileSystem.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'fsx/cfn_file_system.rb', line 98

def self.is_cfn_file_system(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_fsx.CfnFileSystem", "isCfnFileSystem", [x])
end

.jsii_overridable_methods ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'fsx/cfn_file_system.rb', line 33

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_dns_name => { kind: :property, name: "attrDnsName", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_lustre_mount_name => { kind: :property, name: "attrLustreMountName", is_optional: false },
    :attr_resource_arn => { kind: :property, name: "attrResourceArn", is_optional: false },
    :attr_root_volume_id => { kind: :property, name: "attrRootVolumeId", is_optional: false },
    :file_system_ref => { kind: :property, name: "fileSystemRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :file_system_type => { kind: :property, name: "fileSystemType", is_optional: false },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: false },
    :backup_id => { kind: :property, name: "backupId", is_optional: true },
    :file_system_type_version => { kind: :property, name: "fileSystemTypeVersion", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :lustre_configuration => { kind: :property, name: "lustreConfiguration", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :ontap_configuration => { kind: :property, name: "ontapConfiguration", is_optional: true },
    :open_zfs_configuration => { kind: :property, name: "openZfsConfiguration", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :storage_capacity => { kind: :property, name: "storageCapacity", is_optional: true },
    :storage_type => { kind: :property, name: "storageType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :windows_configuration => { kind: :property, name: "windowsConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



466
467
468
469
 
# File 'fsx/cfn_file_system.rb', line 466

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



478
479
480
481
 
# File 'fsx/cfn_file_system.rb', line 478

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



488
489
490
491
 
# File 'fsx/cfn_file_system.rb', line 488

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



499
500
501
502
503
 
# File 'fsx/cfn_file_system.rb', line 499

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


556
557
558
559
560
 
# File 'fsx/cfn_file_system.rb', line 556

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



566
567
568
569
 
# File 'fsx/cfn_file_system.rb', line 566

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



578
579
580
581
582
 
# File 'fsx/cfn_file_system.rb', line 578

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



591
592
593
594
 
# File 'fsx/cfn_file_system.rb', line 591

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



613
614
615
616
617
618
 
# File 'fsx/cfn_file_system.rb', line 613

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_dns_name ⇒ String

Returns the FSx for Windows file system's DNSName.

Example: amznfsxp1honlek.corp.example.com

Returns:

  • (String) 


205
206
207
 
# File 'fsx/cfn_file_system.rb', line 205

def attr_dns_name()
  jsii_get_property("attrDnsName")
end

#attr_id ⇒ String

Returns:

  • (String) 


210
211
212
 
# File 'fsx/cfn_file_system.rb', line 210

def attr_id()
  jsii_get_property("attrId")
end

#attr_lustre_mount_name ⇒ String

Returns the Lustre file system's LustreMountName .

Example for SCRATCH_1 deployment types: This value is always fsx .

Example for SCRATCH_2 and PERSISTENT deployment types: 2p3fhbmv

Returns:

  • (String) 


221
222
223
 
# File 'fsx/cfn_file_system.rb', line 221

def attr_lustre_mount_name()
  jsii_get_property("attrLustreMountName")
end

#attr_resource_arn ⇒ String

Returns the Amazon Resource Name (ARN) for the Amazon FSx file system.

Example: arn:aws:fsx:us-east-2:111122223333:file-system/fs-0123abcd56789ef0a

Returns:

  • (String) 


230
231
232
 
# File 'fsx/cfn_file_system.rb', line 230

def attr_resource_arn()
  jsii_get_property("attrResourceArn")
end

#attr_root_volume_id ⇒ String

Returns the root volume ID of the FSx for OpenZFS file system.

Example: fsvol-0123456789abcdefa

Returns:

  • (String) 


239
240
241
 
# File 'fsx/cfn_file_system.rb', line 239

def attr_root_volume_id()
  jsii_get_property("attrRootVolumeId")
end

#backup_id ⇒ String?

The ID of the file system backup that you are using to create a file system.

Returns:

  • (String, nil) 


284
285
286
 
# File 'fsx/cfn_file_system.rb', line 284

def backup_id()
  jsii_get_property("backupId")
end

#backup_id=(value) ⇒ Object 



288
289
290
291
 
# File 'fsx/cfn_file_system.rb', line 288

def backup_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupId") unless value.nil?
  jsii_set_property("backupId", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



149
150
151
 
# File 'fsx/cfn_file_system.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'fsx/cfn_file_system.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


622
623
624
625
 
# File 'fsx/cfn_file_system.rb', line 622

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


159
160
161
 
# File 'fsx/cfn_file_system.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'fsx/cfn_file_system.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'fsx/cfn_file_system.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'fsx/cfn_file_system.rb', line 171

def env()
  jsii_get_property("env")
end

#file_system_ref ⇒ AWSCDK::Interfaces::AWSFSX::FileSystemReference

A reference to a FileSystem resource.

Returns:



246
247
248
 
# File 'fsx/cfn_file_system.rb', line 246

def file_system_ref()
  jsii_get_property("fileSystemRef")
end

#file_system_type ⇒ String

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

Returns:

  • (String) 


260
261
262
 
# File 'fsx/cfn_file_system.rb', line 260

def file_system_type()
  jsii_get_property("fileSystemType")
end

#file_system_type=(value) ⇒ Object 



264
265
266
267
 
# File 'fsx/cfn_file_system.rb', line 264

def file_system_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemType")
  jsii_set_property("fileSystemType", value)
end

#file_system_type_version ⇒ String?

For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.

Returns:

  • (String, nil) 


296
297
298
 
# File 'fsx/cfn_file_system.rb', line 296

def file_system_type_version()
  jsii_get_property("fileSystemTypeVersion")
end

#file_system_type_version=(value) ⇒ Object 



300
301
302
303
 
# File 'fsx/cfn_file_system.rb', line 300

def file_system_type_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemTypeVersion") unless value.nil?
  jsii_set_property("fileSystemTypeVersion", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



635
636
637
638
639
 
# File 'fsx/cfn_file_system.rb', line 635

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



646
647
648
649
 
# File 'fsx/cfn_file_system.rb', line 646

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



716
717
718
719
 
# File 'fsx/cfn_file_system.rb', line 716

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

The ID of the AWS Key Management Service ( AWS ) key used to encrypt Amazon FSx file system data.

Returns:

  • (String, nil) 


308
309
310
 
# File 'fsx/cfn_file_system.rb', line 308

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



312
313
314
315
 
# File 'fsx/cfn_file_system.rb', line 312

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


123
124
125
 
# File 'fsx/cfn_file_system.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#lustre_configuration ⇒ AWSCDK::IResolvable, ...

The Lustre configuration for the file system being created.

Returns:



320
321
322
 
# File 'fsx/cfn_file_system.rb', line 320

def lustre_configuration()
  jsii_get_property("lustreConfiguration")
end

#lustre_configuration=(value) ⇒ Object 



324
325
326
327
328
 
# File 'fsx/cfn_file_system.rb', line 324

def lustre_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::LustreConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5MdXN0cmVDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "lustreConfiguration") unless value.nil?
  jsii_set_property("lustreConfiguration", value)
end

#network_type ⇒ String?

The network type of the file system.

Returns:

  • (String, nil) 


333
334
335
 
# File 'fsx/cfn_file_system.rb', line 333

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



337
338
339
340
 
# File 'fsx/cfn_file_system.rb', line 337

def network_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless value.nil?
  jsii_set_property("networkType", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'fsx/cfn_file_system.rb', line 106

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



657
658
659
 
# File 'fsx/cfn_file_system.rb', line 657

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



664
665
666
 
# File 'fsx/cfn_file_system.rb', line 664

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#ontap_configuration ⇒ AWSCDK::IResolvable, ...

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

Returns:



345
346
347
 
# File 'fsx/cfn_file_system.rb', line 345

def ontap_configuration()
  jsii_get_property("ontapConfiguration")
end

#ontap_configuration=(value) ⇒ Object 



349
350
351
352
353
 
# File 'fsx/cfn_file_system.rb', line 349

def ontap_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::OntapConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5PbnRhcENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "ontapConfiguration") unless value.nil?
  jsii_set_property("ontapConfiguration", value)
end

#open_zfs_configuration ⇒ AWSCDK::IResolvable, ...

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

Returns:



358
359
360
 
# File 'fsx/cfn_file_system.rb', line 358

def open_zfs_configuration()
  jsii_get_property("openZfsConfiguration")
end

#open_zfs_configuration=(value) ⇒ Object 



362
363
364
365
366
 
# File 'fsx/cfn_file_system.rb', line 362

def open_zfs_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::OpenZFSConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5PcGVuWkZTQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "openZfsConfiguration") unless value.nil?
  jsii_set_property("openZfsConfiguration", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



457
458
459
460
 
# File 'fsx/cfn_file_system.rb', line 457

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


142
143
144
 
# File 'fsx/cfn_file_system.rb', line 142

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



675
676
677
678
 
# File 'fsx/cfn_file_system.rb', line 675

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


682
683
684
685
 
# File 'fsx/cfn_file_system.rb', line 682

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



692
693
694
695
696
 
# File 'fsx/cfn_file_system.rb', line 692

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_group_ids ⇒ Array<String>?

A list of IDs specifying the security groups to apply to all network interfaces created for file system access.

Returns:

  • (Array<String>, nil) 


371
372
373
 
# File 'fsx/cfn_file_system.rb', line 371

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



375
376
377
378
 
# File 'fsx/cfn_file_system.rb', line 375

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil?
  jsii_set_property("securityGroupIds", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



701
702
703
 
# File 'fsx/cfn_file_system.rb', line 701

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



132
133
134
 
# File 'fsx/cfn_file_system.rb', line 132

def stack()
  jsii_get_property("stack")
end

#storage_capacity ⇒ Numeric?

Sets the storage capacity of the file system that you're creating.

Returns:

  • (Numeric, nil) 


383
384
385
 
# File 'fsx/cfn_file_system.rb', line 383

def storage_capacity()
  jsii_get_property("storageCapacity")
end

#storage_capacity=(value) ⇒ Object 



387
388
389
390
 
# File 'fsx/cfn_file_system.rb', line 387

def storage_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageCapacity") unless value.nil?
  jsii_set_property("storageCapacity", value)
end

#storage_type ⇒ String?

Sets the storage class for the file system that you're creating.

Returns:

  • (String, nil) 


395
396
397
 
# File 'fsx/cfn_file_system.rb', line 395

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



399
400
401
402
 
# File 'fsx/cfn_file_system.rb', line 399

def storage_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless value.nil?
  jsii_set_property("storageType", value)
end

#subnet_ids ⇒ Array<String>

Specifies the IDs of the subnets that the file system will be accessible from.

Returns:

  • (Array<String>) 


272
273
274
 
# File 'fsx/cfn_file_system.rb', line 272

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



276
277
278
279
 
# File 'fsx/cfn_file_system.rb', line 276

def subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds")
  jsii_set_property("subnetIds", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



253
254
255
 
# File 'fsx/cfn_file_system.rb', line 253

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to associate with the file system.

Returns:



407
408
409
 
# File 'fsx/cfn_file_system.rb', line 407

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



411
412
413
414
415
 
# File 'fsx/cfn_file_system.rb', line 411

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



433
434
435
 
# File 'fsx/cfn_file_system.rb', line 433

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'fsx/cfn_file_system.rb', line 179

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


189
190
191
 
# File 'fsx/cfn_file_system.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


707
708
709
710
 
# File 'fsx/cfn_file_system.rb', line 707

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#windows_configuration ⇒ AWSCDK::IResolvable, ...

The configuration object for the Microsoft Windows file system you are creating.

Returns:



420
421
422
 
# File 'fsx/cfn_file_system.rb', line 420

def windows_configuration()
  jsii_get_property("windowsConfiguration")
end

#windows_configuration=(value) ⇒ Object 



424
425
426
427
428
 
# File 'fsx/cfn_file_system.rb', line 424

def windows_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::WindowsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5XaW5kb3dzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "windowsConfiguration") unless value.nil?
  jsii_set_property("windowsConfiguration", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


446
447
448
449
450
451
 
# File 'fsx/cfn_file_system.rb', line 446

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end