Class: Aws::EFS::Types::DestinationToCreate

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-efs/types.rb

Overview

Describes the new or existing destination file system for the replication configuration.

  • If you want to replicate to a new file system, do not specify the File System ID for the destination file system. Amazon EFS creates a new, empty file system. For One Zone storage, specify the Availability Zone to create the file system in. To use an Key Management Service key other than the default KMS key, then specify it. For more information, see [Configuring replication to new Amazon EFS file system] in the *Amazon EFS User Guide*.

    <note markdown=“1”> After the file system is created, you cannot change the KMS key or the performance mode.

    </note>

  • If you want to replicate to an existing file system that’s in the same account as the source file system, then you need to provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system’s replication overwrite protection must be disabled. For more information, see [Replicating to an existing file system] in the *Amazon EFS User Guide*.

  • If you are replicating the file system to a file system that’s in a different account than the source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform replication on the destination account. The file system’s replication overwrite protection must be disabled. For more information, see [Replicating across Amazon Web Services accounts] in the *Amazon EFS User Guide*.

[1]: docs.aws.amazon.com/efs/latest/ug/create-replication.html [2]: docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination [3]: docs.aws.amazon.com/efs/latest/ug/cross-account-replication.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_name ⇒ String

To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/aws-sdk-efs/types.rb', line 1360

class DestinationToCreate < Struct.new(
  :region,
  :availability_zone_name,
  :kms_key_id,
  :file_system_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

The ID or ARN of the file system to use for the destination. For cross-account replication, this must be an ARN. The file system’s replication overwrite replication must be disabled. If no ID or ARN is specified, then a new file system is created.

<note markdown=“1”> When you initially configure replication to an existing file system, Amazon EFS writes data to or removes existing data from the destination file system to match data in the source file system. If you don’t want to change data in the destination file system, then you should replicate to a new file system instead. For more information, see [docs.aws.amazon.com/efs/latest/ug/create-replication.html][1].

</note>

[1]: docs.aws.amazon.com/efs/latest/ug/create-replication.html

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/aws-sdk-efs/types.rb', line 1360

class DestinationToCreate < Struct.new(
  :region,
  :availability_zone_name,
  :kms_key_id,
  :file_system_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

Specify the Key Management Service (KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS, ‘/aws/elasticfilesystem`. This ID can be in one of the following formats:

  • Key ID - The unique identifier of the key, for example ‘1234abcd-12ab-34cd-56ef-1234567890ab`.

  • ARN - The 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 - The ARN for a key alias, for example ‘arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/aws-sdk-efs/types.rb', line 1360

class DestinationToCreate < Struct.new(
  :region,
  :availability_zone_name,
  :kms_key_id,
  :file_system_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system. The Region must be enabled for the Amazon Web Services account that owns the source file system. For more information, see

Managing Amazon Web Services Regions][1

in the *Amazon Web

Services General Reference Reference Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/aws-sdk-efs/types.rb', line 1360

class DestinationToCreate < Struct.new(
  :region,
  :availability_zone_name,
  :kms_key_id,
  :file_system_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/aws-sdk-efs/types.rb', line 1360

class DestinationToCreate < Struct.new(
  :region,
  :availability_zone_name,
  :kms_key_id,
  :file_system_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end