Class: AWSCDK::EFS::CfnFileSystemProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
efs/cfn_file_system_props.rb

Overview

Properties for defining a CfnFileSystem.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zone_name: nil, backup_policy: nil, bypass_policy_lockout_safety_check: nil, encrypted: nil, file_system_policy: nil, file_system_protection: nil, file_system_tags: nil, kms_key_id: nil, lifecycle_policies: nil, performance_mode: nil, provisioned_throughput_in_mibps: nil, replication_configuration: nil, throughput_mode: nil) ⇒ CfnFileSystemProps

Returns a new instance of CfnFileSystemProps.

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'efs/cfn_file_system_props.rb', line 22

def initialize(availability_zone_name: nil, backup_policy: nil, bypass_policy_lockout_safety_check: nil, encrypted: nil, file_system_policy: nil, file_system_protection: nil, file_system_tags: nil, kms_key_id: nil, lifecycle_policies: nil, performance_mode: nil, provisioned_throughput_in_mibps: nil, replication_configuration: nil, throughput_mode: nil)
  @availability_zone_name = availability_zone_name
  Jsii::Type.check_type(@availability_zone_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZoneName") unless @availability_zone_name.nil?
  @backup_policy = backup_policy.is_a?(Hash) ? ::AWSCDK::EFS::CfnFileSystem::BackupPolicyProperty.new(**backup_policy.transform_keys(&:to_sym)) : backup_policy
  Jsii::Type.check_type(@backup_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuRmlsZVN5c3RlbS5CYWNrdXBQb2xpY3lQcm9wZXJ0eSJ9XX19")), "backupPolicy") unless @backup_policy.nil?
  @bypass_policy_lockout_safety_check = bypass_policy_lockout_safety_check
  Jsii::Type.check_type(@bypass_policy_lockout_safety_check, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "bypassPolicyLockoutSafetyCheck") unless @bypass_policy_lockout_safety_check.nil?
  @encrypted = encrypted
  Jsii::Type.check_type(@encrypted, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "encrypted") unless @encrypted.nil?
  @file_system_policy = file_system_policy
  Jsii::Type.check_type(@file_system_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "fileSystemPolicy") unless @file_system_policy.nil?
  @file_system_protection = file_system_protection.is_a?(Hash) ? ::AWSCDK::EFS::CfnFileSystem::FileSystemProtectionProperty.new(**file_system_protection.transform_keys(&:to_sym)) : file_system_protection
  Jsii::Type.check_type(@file_system_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuRmlsZVN5c3RlbS5GaWxlU3lzdGVtUHJvdGVjdGlvblByb3BlcnR5In1dfX0=")), "fileSystemProtection") unless @file_system_protection.nil?
  @file_system_tags = file_system_tags.is_a?(Array) ? file_system_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EFS::CfnFileSystem::ElasticFileSystemTagProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : file_system_tags
  Jsii::Type.check_type(@file_system_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuRmlsZVN5c3RlbS5FbGFzdGljRmlsZVN5c3RlbVRhZ1Byb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "fileSystemTags") unless @file_system_tags.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "kmsKeyId") unless @kms_key_id.nil?
  @lifecycle_policies = lifecycle_policies
  Jsii::Type.check_type(@lifecycle_policies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWZzLkNmbkZpbGVTeXN0ZW0uTGlmZWN5Y2xlUG9saWN5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "lifecyclePolicies") unless @lifecycle_policies.nil?
  @performance_mode = performance_mode
  Jsii::Type.check_type(@performance_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "performanceMode") unless @performance_mode.nil?
  @provisioned_throughput_in_mibps = provisioned_throughput_in_mibps
  Jsii::Type.check_type(@provisioned_throughput_in_mibps, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "provisionedThroughputInMibps") unless @provisioned_throughput_in_mibps.nil?
  @replication_configuration = replication_configuration.is_a?(Hash) ? ::AWSCDK::EFS::CfnFileSystem::ReplicationConfigurationProperty.new(**replication_configuration.transform_keys(&:to_sym)) : replication_configuration
  Jsii::Type.check_type(@replication_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuRmlsZVN5c3RlbS5SZXBsaWNhdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "replicationConfiguration") unless @replication_configuration.nil?
  @throughput_mode = throughput_mode
  Jsii::Type.check_type(@throughput_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "throughputMode") unless @throughput_mode.nil?
end

Instance Attribute Details

#availability_zone_name ⇒ String? (readonly)

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide .

One Zone file systems are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

Returns:

  • (String, nil)

See Also:



59
60
61
 
# File 'efs/cfn_file_system_props.rb', line 59

def availability_zone_name
  @availability_zone_name
end

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

Use the BackupPolicy to turn automatic backups on or off for the file system.

Returns:

See Also:



64
65
66
 
# File 'efs/cfn_file_system_props.rb', line 64

def backup_policy
  @backup_policy
end

#bypass_policy_lockout_safety_check ⇒ Boolean, ... (readonly)

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

Returns:

See Also:



71
72
73
 
# File 'efs/cfn_file_system_props.rb', line 71

def bypass_policy_lockout_safety_check
  @bypass_policy_lockout_safety_check
end

#encrypted ⇒ Boolean, ... (readonly)

A Boolean value that, if true, creates an encrypted file system.

When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

Returns:

See Also:



78
79
80
 
# File 'efs/cfn_file_system_props.rb', line 78

def encrypted
  @encrypted
end

#file_system_policy ⇒ Object? (readonly)

The FileSystemPolicy for the EFS file system.

A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

Returns:

  • (Object, nil)

See Also:



85
86
87
 
# File 'efs/cfn_file_system_props.rb', line 85

def file_system_policy
  @file_system_policy
end

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

Describes the protection on the file system.

Returns:

See Also:



90
91
92
 
# File 'efs/cfn_file_system_props.rb', line 90

def file_system_protection
  @file_system_protection
end

#file_system_tags ⇒ Array<AWSCDK::EFS::CfnFileSystem::ElasticFileSystemTagProperty>? (readonly)

Use to create one or more tags associated with the file system.

Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .

Returns:

See Also:



97
98
99
 
# File 'efs/cfn_file_system_props.rb', line 97

def file_system_tags
  @file_system_tags
end

#kms_key_id ⇒ String, ... (readonly)

The ID of the AWS KMS key to be used to protect the encrypted file system.

This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

  • Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
  • ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
  • Key alias - A previously created display name for a key, for example alias/projectKey1 .
  • Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

If KmsKeyId is specified, the Encrypted parameter must be set to true.

Returns:

See Also:



111
112
113
 
# File 'efs/cfn_file_system_props.rb', line 111

def kms_key_id
  @kms_key_id
end

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

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

A LifecycleConfiguration object informs Lifecycle management of the following:

  • When to move files in the file system from primary storage to IA storage.
  • When to move files in the file system from primary storage or IA storage to Archive storage.
  • When to move files that are in IA or Archive storage to primary storage.

Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToArchive TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

Returns:

See Also:



124
125
126
 
# File 'efs/cfn_file_system_props.rb', line 124

def lifecycle_policies
  @lifecycle_policies
end

#performance_mode ⇒ String? (readonly)

The performance mode of the file system.

We recommend general_purpose performance mode for all file systems. File systems using the max_io performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The max_io mode is not supported on One Zone file systems.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

Default is general_purpose .

Returns:

  • (String, nil)

See Also:



135
136
137
 
# File 'efs/cfn_file_system_props.rb', line 135

def performance_mode
  @performance_mode
end

#provisioned_throughput_in_mibps ⇒ Numeric? (readonly)

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

Required if ThroughputMode is set to provisioned . Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

Returns:

  • (Numeric, nil)

See Also:



142
143
144
 
# File 'efs/cfn_file_system_props.rb', line 142

def provisioned_throughput_in_mibps
  @provisioned_throughput_in_mibps
end

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

Describes the replication configuration for a specific file system.

Returns:

See Also:



147
148
149
 
# File 'efs/cfn_file_system_props.rb', line 147

def replication_configuration
  @replication_configuration
end

#throughput_mode ⇒ String? (readonly)

Specifies the throughput mode for the file system.

The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .

Returns:

  • (String, nil)

See Also:



156
157
158
 
# File 'efs/cfn_file_system_props.rb', line 156

def throughput_mode
  @throughput_mode
end

Class Method Details

.jsii_properties ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'efs/cfn_file_system_props.rb', line 158

def self.jsii_properties
  {
    :availability_zone_name => "availabilityZoneName",
    :backup_policy => "backupPolicy",
    :bypass_policy_lockout_safety_check => "bypassPolicyLockoutSafetyCheck",
    :encrypted => "encrypted",
    :file_system_policy => "fileSystemPolicy",
    :file_system_protection => "fileSystemProtection",
    :file_system_tags => "fileSystemTags",
    :kms_key_id => "kmsKeyId",
    :lifecycle_policies => "lifecyclePolicies",
    :performance_mode => "performanceMode",
    :provisioned_throughput_in_mibps => "provisionedThroughputInMibps",
    :replication_configuration => "replicationConfiguration",
    :throughput_mode => "throughputMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'efs/cfn_file_system_props.rb', line 176

def to_jsii
  result = {}
  result.merge!({
    "availabilityZoneName" => @availability_zone_name,
    "backupPolicy" => @backup_policy,
    "bypassPolicyLockoutSafetyCheck" => @bypass_policy_lockout_safety_check,
    "encrypted" => @encrypted,
    "fileSystemPolicy" => @file_system_policy,
    "fileSystemProtection" => @file_system_protection,
    "fileSystemTags" => @file_system_tags,
    "kmsKeyId" => @kms_key_id,
    "lifecyclePolicies" => @lifecycle_policies,
    "performanceMode" => @performance_mode,
    "provisionedThroughputInMibps" => @provisioned_throughput_in_mibps,
    "replicationConfiguration" => @replication_configuration,
    "throughputMode" => @throughput_mode,
  })
  result.compact
end