Class: AWSCDK::EFS::OneZoneFileSystemProps

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

Overview

Properties for configuring ReplicationConfiguration to replicate to a new One Zone file system.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zone:, region:, kms_key: nil) ⇒ OneZoneFileSystemProps

Returns a new instance of OneZoneFileSystemProps.

Parameters:

  • availability_zone (String) —

    The availability zone name of the destination file system.

  • region (String) —

    The AWS Region in which the destination file system is located.

  • kms_key (AWSCDK::KMS::IKey, nil) (defaults to: nil) —

    AWS KMS key used to protect the encrypted file system.



10
11
12
13
14
15
16
17
 
# File 'efs/one_zone_file_system_props.rb', line 10

def initialize(availability_zone:, region:, kms_key: nil)
  @availability_zone = availability_zone
  Jsii::Type.check_type(@availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone")
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "kmsKey") unless @kms_key.nil?
end

Instance Attribute Details

#availability_zone ⇒ String (readonly)

The availability zone name of the destination file system.

One zone file system is used as the destination file system when this property is set.

Returns:

  • (String) 


24
25
26
 
# File 'efs/one_zone_file_system_props.rb', line 24

def availability_zone
  @availability_zone
end

#kms_key ⇒ AWSCDK::KMS::IKey? (readonly)

Note:

Default: - use service-managed KMS key for Amazon EFS

AWS KMS key used to protect the encrypted file system.

Returns:



33
34
35
 
# File 'efs/one_zone_file_system_props.rb', line 33

def kms_key
  @kms_key
end

#region ⇒ String (readonly)

The AWS Region in which the destination file system is located.

Returns:

  • (String) 


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

def region
  @region
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'efs/one_zone_file_system_props.rb', line 35

def self.jsii_properties
  {
    :availability_zone => "availabilityZone",
    :region => "region",
    :kms_key => "kmsKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'efs/one_zone_file_system_props.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "availabilityZone" => @availability_zone,
    "region" => @region,
    "kmsKey" => @kms_key,
  })
  result.compact
end