Class: AWSCDK::EFS::ReplicationConfiguration

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

Overview

EFS Replication Configuration.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ReplicationConfiguration

Returns a new instance of ReplicationConfiguration.

Parameters:



9
10
11
12
13
 
# File 'efs/replication_configuration.rb', line 9

def initialize(options)
  options = options.is_a?(Hash) ? ::AWSCDK::EFS::ReplicationConfigurationProps.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWZzLlJlcGxpY2F0aW9uQ29uZmlndXJhdGlvblByb3BzIn0=")), "options")
  Jsii::Object.instance_method(:initialize).bind(self).call(options)
end

Class Method Details

.existing_file_system(destination_file_system) ⇒ AWSCDK::EFS::ReplicationConfiguration

Specify the existing destination file system for the replication.

Parameters:

Returns:

  • (AWSCDK::EFS::ReplicationConfiguration) 


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

def self.existing_file_system(destination_file_system)
  Jsii::Type.check_type(destination_file_system, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lZnMuSUZpbGVTeXN0ZW1SZWYifQ==")), "destinationFileSystem")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_efs.ReplicationConfiguration", "existingFileSystem", [destination_file_system])
end

.jsii_overridable_methods ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'efs/replication_configuration.rb', line 15

def self.jsii_overridable_methods
  {
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :destination_file_system => { kind: :property, name: "destinationFileSystem", is_optional: true },
    :kms_key => { kind: :property, name: "kmsKey", is_optional: true },
    :region => { kind: :property, name: "region", is_optional: true },
  }
end

.one_zone_file_system(region, availability_zone, kms_key = nil) ⇒ AWSCDK::EFS::ReplicationConfiguration

Create a new one zone destination file system for the replication.

Parameters:

  • region (String) —

    The AWS Region in which the specified availability zone belongs to.

  • availability_zone (String) —

    The availability zone name of the destination file system.

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

    AWS KMS key used to protect the encrypted file system.

Returns:

  • (AWSCDK::EFS::ReplicationConfiguration) 


39
40
41
42
43
44
 
# File 'efs/replication_configuration.rb', line 39

def self.one_zone_file_system(region, availability_zone, kms_key = nil)
  Jsii::Type.check_type(region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  Jsii::Type.check_type(availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone")
  Jsii::Type.check_type(kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "kmsKey") unless kms_key.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_efs.ReplicationConfiguration", "oneZoneFileSystem", [region, availability_zone, kms_key])
end

.regional_file_system(region = nil, kms_key = nil) ⇒ AWSCDK::EFS::ReplicationConfiguration

Create a new regional destination file system for the replication.

Parameters:

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

    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.

Returns:

  • (AWSCDK::EFS::ReplicationConfiguration) 


51
52
53
54
55
 
# File 'efs/replication_configuration.rb', line 51

def self.regional_file_system(region = nil, kms_key = nil)
  Jsii::Type.check_type(region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless region.nil?
  Jsii::Type.check_type(kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "kmsKey") unless kms_key.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_efs.ReplicationConfiguration", "regionalFileSystem", [region, kms_key])
end

Instance Method Details

#availability_zone ⇒ String?

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) 


62
63
64
 
# File 'efs/replication_configuration.rb', line 62

def availability_zone()
  jsii_get_property("availabilityZone")
end

#destination_file_system ⇒ AWSCDK::EFS::IFileSystem?

The existing destination file system for the replication.

Returns:



69
70
71
 
# File 'efs/replication_configuration.rb', line 69

def destination_file_system()
  jsii_get_property("destinationFileSystem")
end

#kms_key ⇒ AWSCDK::KMS::IKey?

AWS KMS key used to protect the encrypted file system.

Returns:



76
77
78
 
# File 'efs/replication_configuration.rb', line 76

def kms_key()
  jsii_get_property("kmsKey")
end

#region ⇒ String?

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

Returns:

  • (String, nil) 


83
84
85
 
# File 'efs/replication_configuration.rb', line 83

def region()
  jsii_get_property("region")
end