Module: AWSCDK::EFS::IFileSystem

Includes:
AWSCDK::EC2::IConnectable, IAM::IResourceWithPolicy, Interfaces::AWSEFS::IFileSystemRef
Included in:
FileSystem
Defined in:
efs/i_file_system.rb

Overview

Represents an Amazon EFS file system.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'efs/i_file_system.rb', line 154

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :file_system_ref => { kind: :property, name: "fileSystemRef", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :file_system_arn => { kind: :property, name: "fileSystemArn", is_optional: false },
    :file_system_id => { kind: :property, name: "fileSystemId", is_optional: false },
    :mount_targets_available => { kind: :property, name: "mountTargetsAvailable", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", 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

Instance Method Details

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

Add a statement to the resource's resource policy.

Parameters:

Returns:



92
93
94
95
 
# File 'efs/i_file_system.rb', line 92

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_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:



109
110
111
112
 
# File 'efs/i_file_system.rb', line 109

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 network connections associated with this resource.

Returns:



42
43
44
 
# File 'efs/i_file_system.rb', line 42

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:



28
29
30
 
# File 'efs/i_file_system.rb', line 28

def env()
  jsii_get_property("env")
end

#file_system_arn ⇒ String

The ARN of the file system.

Returns:

  • (String) 


56
57
58
 
# File 'efs/i_file_system.rb', line 56

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) 


63
64
65
 
# File 'efs/i_file_system.rb', line 63

def file_system_id()
  jsii_get_property("fileSystemId")
end

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

A reference to a FileSystem resource.

Returns:



35
36
37
 
# File 'efs/i_file_system.rb', line 35

def file_system_ref()
  jsii_get_property("fileSystemRef")
end

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

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

Parameters:

Returns:



119
120
121
122
123
124
125
 
# File 'efs/i_file_system.rb', line 119

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.

Parameters:

Returns:



131
132
133
134
 
# File 'efs/i_file_system.rb', line 131

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.

Parameters:

Returns:



140
141
142
143
 
# File 'efs/i_file_system.rb', line 140

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.

Parameters:

Returns:



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

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) 


70
71
72
 
# File 'efs/i_file_system.rb', line 70

def mount_targets_available()
  jsii_get_property("mountTargetsAvailable")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


13
14
15
 
# File 'efs/i_file_system.rb', line 13

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



49
50
51
 
# File 'efs/i_file_system.rb', line 49

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



81
82
83
84
85
86
 
# File 'efs/i_file_system.rb', line 81

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