Class: AWSCDK::EFS::FileSystem

Inherits:
Resource
  • Object
show all
Includes:
IFileSystem
Defined in:
efs/file_system.rb

Overview

The Elastic File System implementation of IFileSystem.

It creates a new, empty file system in Amazon Elastic File System (Amazon EFS). It also creates mount target (AWS::EFS::MountTarget) implicitly to mount the EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2) instance or another resource.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ FileSystem

Constructor for creating a new EFS FileSystem.

Parameters:



20
21
22
23
24
25
26
 
# File 'efs/file_system.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EFS::FileSystemProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWZzLkZpbGVTeXN0ZW1Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.DEFAULT_PORT ⇒ Numeric

The default port File System listens on.

Returns:

  • (Numeric) 


115
116
117
 
# File 'efs/file_system.rb', line 115

def self.DEFAULT_PORT()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_efs.FileSystem", "DEFAULT_PORT")
end

.from_file_system_attributes(scope, id, attrs) ⇒ AWSCDK::EFS::IFileSystem

Import an existing File System from the given properties.

Parameters:

Returns:



61
62
63
64
65
66
67
 
# File 'efs/file_system.rb', line 61

def self.from_file_system_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EFS::FileSystemAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWZzLkZpbGVTeXN0ZW1BdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_efs.FileSystem", "fromFileSystemAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'efs/file_system.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :file_system_arn => { kind: :property, name: "fileSystemArn", is_optional: false },
    :file_system_id => { kind: :property, name: "fileSystemId", is_optional: false },
    :file_system_ref => { kind: :property, name: "fileSystemRef", is_optional: false },
    :mount_targets_available => { kind: :property, name: "mountTargetsAvailable", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_access_point => { kind: :method, name: "addAccessPoint", is_optional: false },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_read_write => { kind: :method, name: "grantReadWrite", is_optional: false },
    :grant_root_access => { kind: :method, name: "grantRootAccess", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


122
123
124
 
# File 'efs/file_system.rb', line 122

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_efs.FileSystem", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_access_point(id, access_point_options = nil) ⇒ AWSCDK::EFS::AccessPoint

create access point from this filesystem.

Parameters:

Returns:



256
257
258
259
260
261
 
# File 'efs/file_system.rb', line 256

def add_access_point(id, access_point_options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  access_point_options = access_point_options.is_a?(Hash) ? ::AWSCDK::EFS::AccessPointOptions.new(**access_point_options.transform_keys(&:to_sym)) : access_point_options
  Jsii::Type.check_type(access_point_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWZzLkFjY2Vzc1BvaW50T3B0aW9ucyJ9")), "accessPointOptions") unless access_point_options.nil?
  jsii_call_method("addAccessPoint", [id, access_point_options])
end

#add_to_resource_policy(statement) ⇒ AWSCDK::IAM::AddToResourcePolicyResult

Adds a statement to the resource policy associated with this file system.

A resource policy will be automatically created upon the first call to add_to_resource_policy.

Note that this does not work with imported file systems.

Parameters:

Returns:



271
272
273
274
 
# File 'efs/file_system.rb', line 271

def add_to_resource_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToResourcePolicy", [statement])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



194
195
196
197
 
# File 'efs/file_system.rb', line 194

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



211
212
213
214
 
# File 'efs/file_system.rb', line 211

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#connections ⇒ AWSCDK::EC2::Connections

The security groups/rules used to allow network connections to the file system.

Returns:



129
130
131
 
# File 'efs/file_system.rb', line 129

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



87
88
89
 
# File 'efs/file_system.rb', line 87

def env()
  jsii_get_property("env")
end

#file_system_arn ⇒ String

The ARN of the file system.

Returns:

  • (String) 


136
137
138
 
# File 'efs/file_system.rb', line 136

def file_system_arn()
  jsii_get_property("fileSystemArn")
end

#file_system_id ⇒ String

The ID of the file system, assigned by Amazon EFS.

Returns:

  • (String) 


143
144
145
 
# File 'efs/file_system.rb', line 143

def file_system_id()
  jsii_get_property("fileSystemId")
end

#file_system_ref ⇒ AWSCDK::Interfaces::AWSEFS::FileSystemReference

A reference to a FileSystem resource.

Returns:



150
151
152
 
# File 'efs/file_system.rb', line 150

def file_system_ref()
  jsii_get_property("fileSystemRef")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


217
218
219
 
# File 'efs/file_system.rb', line 217

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


231
232
233
234
235
236
 
# File 'efs/file_system.rb', line 231

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


246
247
248
249
 
# File 'efs/file_system.rb', line 246

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grant the actions defined in actions to the given grantee on this File System resource.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    Principal to grant right to.

  • actions (Array<String>) —

    The actions to grant.

Returns:



283
284
285
286
287
288
289
 
# File 'efs/file_system.rb', line 283

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grant read permissions for this file system to an IAM principal.

[disable-awslint:no-grants]

Parameters:

Returns:



297
298
299
300
 
# File 'efs/file_system.rb', line 297

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_read_write(grantee) ⇒ AWSCDK::IAM::Grant

Grant read and write permissions for this file system to an IAM principal.

[disable-awslint:no-grants]

Parameters:

Returns:



308
309
310
311
 
# File 'efs/file_system.rb', line 308

def grant_read_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantReadWrite", [grantee])
end

#grant_root_access(grantee) ⇒ AWSCDK::IAM::Grant

As root user, grant read and write permissions for this file system to an IAM principal.

[disable-awslint:no-grants]

Parameters:

Returns:



319
320
321
322
 
# File 'efs/file_system.rb', line 319

def grant_root_access(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRootAccess", [grantee])
end

#mount_targets_available ⇒ Constructs::IDependable

Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.

Returns:

  • (Constructs::IDependable) 


157
158
159
 
# File 'efs/file_system.rb', line 157

def mount_targets_available()
  jsii_get_property("mountTargetsAvailable")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


72
73
74
 
# File 'efs/file_system.rb', line 72

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


101
102
103
 
# File 'efs/file_system.rb', line 101

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



108
109
110
 
# File 'efs/file_system.rb', line 108

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


164
165
166
 
# File 'efs/file_system.rb', line 164

def to_string()
  jsii_call_method("toString", [])
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) 


177
178
179
180
181
182
 
# File 'efs/file_system.rb', line 177

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