Interface DestinationToCreate.Builder

  • Method Details

    • region

      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 in the Amazon Web Services General Reference Reference Guide.

      Parameters:
      region - 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 in the Amazon Web Services General Reference Reference Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availabilityZoneName

      DestinationToCreate.Builder availabilityZoneName(String availabilityZoneName)

      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.

      Parameters:
      availabilityZoneName - 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:
      Returns a reference to this object so that method calls can be chained together.
    • kmsKeyId

      DestinationToCreate.Builder kmsKeyId(String kmsKeyId)

      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.

      Parameters:
      kmsKeyId - 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:
      Returns a reference to this object so that method calls can be chained together.
    • fileSystemId

      DestinationToCreate.Builder fileSystemId(String fileSystemId)

      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.

      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 https://docs.aws. amazon.com/efs/latest/ug/create-replication.html.

      Parameters:
      fileSystemId - 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.

      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 https://docs.aws.amazon.com/efs/latest/ug/create-replication.html.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • roleArn

      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.

      Parameters:
      roleArn - 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:
      Returns a reference to this object so that method calls can be chained together.