amazonka-efs-2.0: Amazon Elastic File System SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EFS.CreateReplicationConfiguration

Description

Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:

  • Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.

  • Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties:

    • Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions that Amazon EFS is available in, except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe (Milan), and Middle East (Bahrain).
    • Availability Zone - If you want the destination file system to use EFS One Zone availability and durability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide.

    • Encryption - All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used.

      After the file system is created, you cannot change the KMS key.

The following properties are set by default:

  • Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed.
  • Throughput mode - The destination file system uses the Bursting Throughput mode by default. After the file system is created, you can modify the throughput mode.

The following properties are turned off by default:

  • Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering are not enabled on the destination file system. After the destination file system is created, you can enable EFS lifecycle management and EFS Intelligent-Tiering.
  • Automatic backups - Automatic daily backups not enabled on the destination file system. After the file system is created, you can change this setting.

For more information, see Amazon EFS replication in the Amazon EFS User Guide.

Synopsis

Creating a Request

data CreateReplicationConfiguration Source #

See: newCreateReplicationConfiguration smart constructor.

Constructors

CreateReplicationConfiguration' 

Fields

  • sourceFileSystemId :: Text

    Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.

  • destinations :: [DestinationToCreate]

    An array of destination configuration objects. Only one destination configuration object is supported.

Instances

Instances details
ToJSON CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

toJSON :: CreateReplicationConfiguration -> Value #

toEncoding :: CreateReplicationConfiguration -> Encoding #

toJSONList :: [CreateReplicationConfiguration] -> Value #

toEncodingList :: [CreateReplicationConfiguration] -> Encoding #

ToHeaders CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

toHeaders :: CreateReplicationConfiguration -> [Header] #

ToPath CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

toPath :: CreateReplicationConfiguration -> ByteString #

ToQuery CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

toQuery :: CreateReplicationConfiguration -> QueryString #

AWSRequest CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Associated Types

type AWSResponse CreateReplicationConfiguration #

Methods

request :: (Service -> Service) -> CreateReplicationConfiguration -> Request CreateReplicationConfiguration #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateReplicationConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateReplicationConfiguration))) #

Generic CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Associated Types

type Rep CreateReplicationConfiguration :: Type -> Type #

Methods

from :: CreateReplicationConfiguration -> Rep CreateReplicationConfiguration x #

to :: Rep CreateReplicationConfiguration x -> CreateReplicationConfiguration #

Read CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

readsPrec :: Int -> ReadS CreateReplicationConfiguration #

readList :: ReadS [CreateReplicationConfiguration] #

readPrec :: ReadPrec CreateReplicationConfiguration #

readListPrec :: ReadPrec [CreateReplicationConfiguration] #

Show CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

showsPrec :: Int -> CreateReplicationConfiguration -> ShowS #

show :: CreateReplicationConfiguration -> String #

showList :: [CreateReplicationConfiguration] -> ShowS #

NFData CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

rnf :: CreateReplicationConfiguration -> () #

Eq CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

(==) :: CreateReplicationConfiguration -> CreateReplicationConfiguration -> Bool #

(/=) :: CreateReplicationConfiguration -> CreateReplicationConfiguration -> Bool #

Hashable CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

Methods

hashWithSalt :: Int -> CreateReplicationConfiguration -> Int #

hash :: CreateReplicationConfiguration -> Int #

type AWSResponse CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

type AWSResponse CreateReplicationConfiguration = ReplicationConfigurationDescription
type Rep CreateReplicationConfiguration Source # 
Instance details

Defined in Amazonka.EFS.CreateReplicationConfiguration

type Rep CreateReplicationConfiguration = D1 ('MetaData "CreateReplicationConfiguration" "Amazonka.EFS.CreateReplicationConfiguration" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "CreateReplicationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceFileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DestinationToCreate])))

newCreateReplicationConfiguration Source #

Arguments

:: Text

CreateReplicationConfiguration

-> CreateReplicationConfiguration 

Create a value of CreateReplicationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateReplicationConfiguration, createReplicationConfiguration_sourceFileSystemId - Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.

CreateReplicationConfiguration, createReplicationConfiguration_destinations - An array of destination configuration objects. Only one destination configuration object is supported.

Request Lenses

createReplicationConfiguration_sourceFileSystemId :: Lens' CreateReplicationConfiguration Text Source #

Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.

createReplicationConfiguration_destinations :: Lens' CreateReplicationConfiguration [DestinationToCreate] Source #

An array of destination configuration objects. Only one destination configuration object is supported.

Destructuring the Response

data ReplicationConfigurationDescription Source #

See: newReplicationConfigurationDescription smart constructor.

Constructors

ReplicationConfigurationDescription' 

Fields

Instances

Instances details
FromJSON ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

parseJSON :: Value -> Parser ReplicationConfigurationDescription #

parseJSONList :: Value -> Parser [ReplicationConfigurationDescription] #

Generic ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Associated Types

type Rep ReplicationConfigurationDescription :: Type -> Type #

Methods

from :: ReplicationConfigurationDescription -> Rep ReplicationConfigurationDescription x #

to :: Rep ReplicationConfigurationDescription x -> ReplicationConfigurationDescription #

Read ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

readsPrec :: Int -> ReadS ReplicationConfigurationDescription #

readList :: ReadS [ReplicationConfigurationDescription] #

readPrec :: ReadPrec ReplicationConfigurationDescription #

readListPrec :: ReadPrec [ReplicationConfigurationDescription] #

Show ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

showsPrec :: Int -> ReplicationConfigurationDescription -> ShowS #

show :: ReplicationConfigurationDescription -> String #

showList :: [ReplicationConfigurationDescription] -> ShowS #

NFData ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

rnf :: ReplicationConfigurationDescription -> () #

Eq ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

(==) :: ReplicationConfigurationDescription -> ReplicationConfigurationDescription -> Bool #

(/=) :: ReplicationConfigurationDescription -> ReplicationConfigurationDescription -> Bool #

Hashable ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

Methods

hashWithSalt :: Int -> ReplicationConfigurationDescription -> Int #

hash :: ReplicationConfigurationDescription -> Int #

type Rep ReplicationConfigurationDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.ReplicationConfigurationDescription

type Rep ReplicationConfigurationDescription = D1 ('MetaData "ReplicationConfigurationDescription" "Amazonka.EFS.Types.ReplicationConfigurationDescription" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "ReplicationConfigurationDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceFileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceFileSystemRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceFileSystemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "originalSourceFileSystemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Destination])))))

newReplicationConfigurationDescription Source #

Arguments

:: Text

$sel:sourceFileSystemId:ReplicationConfigurationDescription'

-> Text

$sel:sourceFileSystemRegion:ReplicationConfigurationDescription'

-> Text

$sel:sourceFileSystemArn:ReplicationConfigurationDescription'

-> Text

$sel:originalSourceFileSystemArn:ReplicationConfigurationDescription'

-> UTCTime

$sel:creationTime:ReplicationConfigurationDescription'

-> ReplicationConfigurationDescription 

Create a value of ReplicationConfigurationDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceFileSystemId:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemId - The ID of the source Amazon EFS file system that is being replicated.

$sel:sourceFileSystemRegion:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemRegion - The Amazon Web Services Region in which the source Amazon EFS file system is located.

$sel:sourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemArn - The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

$sel:originalSourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_originalSourceFileSystemArn - The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.

$sel:creationTime:ReplicationConfigurationDescription', replicationConfigurationDescription_creationTime - Describes when the replication configuration was created.

$sel:destinations:ReplicationConfigurationDescription', replicationConfigurationDescription_destinations - An array of destination objects. Only one destination object is supported.

Response Lenses

replicationConfigurationDescription_sourceFileSystemId :: Lens' ReplicationConfigurationDescription Text Source #

The ID of the source Amazon EFS file system that is being replicated.

replicationConfigurationDescription_sourceFileSystemRegion :: Lens' ReplicationConfigurationDescription Text Source #

The Amazon Web Services Region in which the source Amazon EFS file system is located.

replicationConfigurationDescription_sourceFileSystemArn :: Lens' ReplicationConfigurationDescription Text Source #

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

replicationConfigurationDescription_originalSourceFileSystemArn :: Lens' ReplicationConfigurationDescription Text Source #

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

replicationConfigurationDescription_creationTime :: Lens' ReplicationConfigurationDescription UTCTime Source #

Describes when the replication configuration was created.

replicationConfigurationDescription_destinations :: Lens' ReplicationConfigurationDescription [Destination] Source #

An array of destination objects. Only one destination object is supported.