Class: AWSCDK::EFS::ReplicationConfigurationProps

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

Overview

Properties for the ReplicationConfiguration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zone: nil, destination_file_system: nil, kms_key: nil, region: nil) ⇒ ReplicationConfigurationProps

Returns a new instance of ReplicationConfigurationProps.

Parameters:

  • availability_zone (String, nil) (defaults to: nil) —

    The availability zone name of the destination file system.

  • destination_file_system (AWSCDK::Interfaces::AWSEFS::IFileSystemRef, nil) (defaults to: nil) —

    The existing destination file system for the replication.

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

    AWS KMS key used to protect the encrypted file system.

  • region (String, nil) (defaults to: nil) —

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



11
12
13
14
15
16
17
18
19
20
 
# File 'efs/replication_configuration_props.rb', line 11

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

Instance Attribute Details

#availability_zone ⇒ String? (readonly)

Note:

Default: - no availability zone is set

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, nil) 


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

def availability_zone
  @availability_zone
end

#destination_file_system ⇒ AWSCDK::Interfaces::AWSEFS::IFileSystemRef? (readonly)

Note:

Default: - None

The existing destination file system for the replication.

Returns:



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

def destination_file_system
  @destination_file_system
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:



38
39
40
 
# File 'efs/replication_configuration_props.rb', line 38

def kms_key
  @kms_key
end

#region ⇒ String? (readonly)

Note:

Default: - the region of the stack

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

Returns:

  • (String, nil) 


43
44
45
 
# File 'efs/replication_configuration_props.rb', line 43

def region
  @region
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'efs/replication_configuration_props.rb', line 45

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

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'efs/replication_configuration_props.rb', line 54

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