Class: AWSCDK::EFS::CfnFileSystem::ReplicationDestinationProperty

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

Overview

Describes the destination file system in the replication configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zone_name: nil, file_system_id: nil, kms_key_id: nil, region: nil, role_arn: nil, status: nil, status_message: nil) ⇒ ReplicationDestinationProperty

Returns a new instance of ReplicationDestinationProperty.

Parameters:

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

    For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.

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

    The ID of the destination Amazon EFS file system.

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

    The ID of an 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.

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

    The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

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

    Describes the status of the replication configuration.

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

    Message that provides details about the PAUSED or ERRROR state of the replication destination configuration.



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'efs/cfn_file_system.rb', line 943

def initialize(availability_zone_name: nil, file_system_id: nil, kms_key_id: nil, region: nil, role_arn: nil, status: nil, status_message: 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?
  @file_system_id = file_system_id
  Jsii::Type.check_type(@file_system_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemId") unless @file_system_id.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
  @status_message = status_message
  Jsii::Type.check_type(@status_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statusMessage") unless @status_message.nil?
end

Instance Attribute Details

#availability_zone_name ⇒ String? (readonly)

For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.

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 system type is not available in all Availability Zones in AWS Regions where Amazon EFS is available.

Returns:

  • (String, nil)

See Also:



968
969
970
 
# File 'efs/cfn_file_system.rb', line 968

def availability_zone_name
  @availability_zone_name
end

#file_system_id ⇒ String? (readonly)

The ID of the destination Amazon EFS file system.

Returns:

  • (String, nil)

See Also:



973
974
975
 
# File 'efs/cfn_file_system.rb', line 973

def file_system_id
  @file_system_id
end

#kms_key_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



978
979
980
 
# File 'efs/cfn_file_system.rb', line 978

def kms_key_id
  @kms_key_id
end

#region ⇒ String? (readonly)

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

For One Zone file systems, the replication configuration must specify the AWS Region in which the destination file system is located.

Returns:

  • (String, nil)

See Also:



985
986
987
 
# File 'efs/cfn_file_system.rb', line 985

def region
  @region
end

#role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

Returns:

  • (String, nil)

See Also:



990
991
992
 
# File 'efs/cfn_file_system.rb', line 990

def role_arn
  @role_arn
end

#status ⇒ String? (readonly)

Describes the status of the replication configuration.

For more information about replication status, see Viewing replication details in the Amazon EFS User Guide .

Returns:

  • (String, nil)

See Also:



997
998
999
 
# File 'efs/cfn_file_system.rb', line 997

def status
  @status
end

#status_message ⇒ String? (readonly)

Message that provides details about the PAUSED or ERRROR state of the replication destination configuration.

For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide .

Returns:

  • (String, nil)

See Also:



1004
1005
1006
 
# File 'efs/cfn_file_system.rb', line 1004

def status_message
  @status_message
end

Class Method Details

.jsii_properties ⇒ Object 



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'efs/cfn_file_system.rb', line 1006

def self.jsii_properties
  {
    :availability_zone_name => "availabilityZoneName",
    :file_system_id => "fileSystemId",
    :kms_key_id => "kmsKeyId",
    :region => "region",
    :role_arn => "roleArn",
    :status => "status",
    :status_message => "statusMessage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'efs/cfn_file_system.rb', line 1018

def to_jsii
  result = {}
  result.merge!({
    "availabilityZoneName" => @availability_zone_name,
    "fileSystemId" => @file_system_id,
    "kmsKeyId" => @kms_key_id,
    "region" => @region,
    "roleArn" => @role_arn,
    "status" => @status,
    "statusMessage" => @status_message,
  })
  result.compact
end