@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DataRepositoryAssociation extends Object implements Serializable, Cloneable, StructuredPojo
The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket. The data repository association configuration object is returned in the response of the following operations:
CreateDataRepositoryAssociation
UpdateDataRepositoryAssociation
DescribeDataRepositoryAssociations
Data repository associations are supported only for file systems with the Persistent_2
deployment type.
Constructor and Description |
---|
DataRepositoryAssociation() |
Modifier and Type | Method and Description |
---|---|
DataRepositoryAssociation |
clone() |
boolean |
equals(Object obj) |
String |
getAssociationId()
The system-generated, unique ID of the data repository association.
|
Boolean |
getBatchImportMetaDataOnCreate()
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created.
|
Date |
getCreationTime() |
String |
getDataRepositoryPath()
The path to the Amazon S3 data repository that will be linked to the file system.
|
DataRepositoryFailureDetails |
getFailureDetails() |
String |
getFileSystemId() |
String |
getFileSystemPath()
A path on the file system that points to a high-level directory (such as
/ns1/ ) or subdirectory
(such as /ns1/subdir/ ) that will be mapped 1-1 with DataRepositoryPath . |
Integer |
getImportedFileChunkSize()
For files imported from a data repository, this value determines the stripe count and maximum amount of data per
file (in MiB) stored on a single physical disk.
|
String |
getLifecycle()
Describes the state of a data repository association.
|
String |
getResourceARN() |
S3DataRepositoryConfiguration |
getS3()
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data
repository association.
|
List<Tag> |
getTags() |
int |
hashCode() |
Boolean |
isBatchImportMetaDataOnCreate()
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAssociationId(String associationId)
The system-generated, unique ID of the data repository association.
|
void |
setBatchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created.
|
void |
setCreationTime(Date creationTime) |
void |
setDataRepositoryPath(String dataRepositoryPath)
The path to the Amazon S3 data repository that will be linked to the file system.
|
void |
setFailureDetails(DataRepositoryFailureDetails failureDetails) |
void |
setFileSystemId(String fileSystemId) |
void |
setFileSystemPath(String fileSystemPath)
A path on the file system that points to a high-level directory (such as
/ns1/ ) or subdirectory
(such as /ns1/subdir/ ) that will be mapped 1-1 with DataRepositoryPath . |
void |
setImportedFileChunkSize(Integer importedFileChunkSize)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per
file (in MiB) stored on a single physical disk.
|
void |
setLifecycle(String lifecycle)
Describes the state of a data repository association.
|
void |
setResourceARN(String resourceARN) |
void |
setS3(S3DataRepositoryConfiguration s3)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data
repository association.
|
void |
setTags(Collection<Tag> tags) |
String |
toString()
Returns a string representation of this object.
|
DataRepositoryAssociation |
withAssociationId(String associationId)
The system-generated, unique ID of the data repository association.
|
DataRepositoryAssociation |
withBatchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created.
|
DataRepositoryAssociation |
withCreationTime(Date creationTime) |
DataRepositoryAssociation |
withDataRepositoryPath(String dataRepositoryPath)
The path to the Amazon S3 data repository that will be linked to the file system.
|
DataRepositoryAssociation |
withFailureDetails(DataRepositoryFailureDetails failureDetails) |
DataRepositoryAssociation |
withFileSystemId(String fileSystemId) |
DataRepositoryAssociation |
withFileSystemPath(String fileSystemPath)
A path on the file system that points to a high-level directory (such as
/ns1/ ) or subdirectory
(such as /ns1/subdir/ ) that will be mapped 1-1 with DataRepositoryPath . |
DataRepositoryAssociation |
withImportedFileChunkSize(Integer importedFileChunkSize)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per
file (in MiB) stored on a single physical disk.
|
DataRepositoryAssociation |
withLifecycle(DataRepositoryLifecycle lifecycle)
Describes the state of a data repository association.
|
DataRepositoryAssociation |
withLifecycle(String lifecycle)
Describes the state of a data repository association.
|
DataRepositoryAssociation |
withResourceARN(String resourceARN) |
DataRepositoryAssociation |
withS3(S3DataRepositoryConfiguration s3)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data
repository association.
|
DataRepositoryAssociation |
withTags(Collection<Tag> tags) |
DataRepositoryAssociation |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
public void setAssociationId(String associationId)
The system-generated, unique ID of the data repository association.
associationId
- The system-generated, unique ID of the data repository association.public String getAssociationId()
The system-generated, unique ID of the data repository association.
public DataRepositoryAssociation withAssociationId(String associationId)
The system-generated, unique ID of the data repository association.
associationId
- The system-generated, unique ID of the data repository association.public void setResourceARN(String resourceARN)
resourceARN
- public String getResourceARN()
public DataRepositoryAssociation withResourceARN(String resourceARN)
resourceARN
- public void setFileSystemId(String fileSystemId)
fileSystemId
- public String getFileSystemId()
public DataRepositoryAssociation withFileSystemId(String fileSystemId)
fileSystemId
- public void setLifecycle(String lifecycle)
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data repository is
being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or automatically
export updates to the S3 bucket until the data repository association configuration is corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that might
affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
lifecycle
- Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data
repository is being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or
automatically export updates to the S3 bucket until the data repository association configuration is
corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that
might affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
DataRepositoryLifecycle
public String getLifecycle()
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data repository is
being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or automatically
export updates to the S3 bucket until the data repository association configuration is corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that might
affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
CREATING
- The data repository association between the FSx file system and the S3 data
repository is being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or
automatically export updates to the S3 bucket until the data repository association configuration is
corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that
might affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
DataRepositoryLifecycle
public DataRepositoryAssociation withLifecycle(String lifecycle)
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data repository is
being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or automatically
export updates to the S3 bucket until the data repository association configuration is corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that might
affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
lifecycle
- Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data
repository is being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or
automatically export updates to the S3 bucket until the data repository association configuration is
corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that
might affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
DataRepositoryLifecycle
public DataRepositoryAssociation withLifecycle(DataRepositoryLifecycle lifecycle)
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data repository is
being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or automatically
export updates to the S3 bucket until the data repository association configuration is corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that might
affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
lifecycle
- Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the FSx file system and the S3 data
repository is being created. The data repository is unavailable.
AVAILABLE
- The data repository association is available for use.
MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket or
automatically export updates to the S3 bucket until the data repository association configuration is
corrected.
UPDATING
- The data repository association is undergoing a customer initiated update that
might affect its availability.
DELETING
- The data repository association is undergoing a customer initiated deletion.
FAILED
- The data repository association is in a terminal state that cannot be recovered.
DataRepositoryLifecycle
public void setFailureDetails(DataRepositoryFailureDetails failureDetails)
failureDetails
- public DataRepositoryFailureDetails getFailureDetails()
public DataRepositoryAssociation withFailureDetails(DataRepositoryFailureDetails failureDetails)
failureDetails
- public void setFileSystemPath(String fileSystemPath)
A path on the file system that points to a high-level directory (such as /ns1/
) or subdirectory
(such as /ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
. The leading
forward slash in the name is required. Two data repository associations cannot have overlapping file system
paths. For example, if a data repository is associated with file system path /ns1/
, then you cannot
link another data repository with file system path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data repository
to the file system. You can only specify "/" as the file system path for the first data repository associated
with a file system.
fileSystemPath
- A path on the file system that points to a high-level directory (such as /ns1/
) or
subdirectory (such as /ns1/subdir/
) that will be mapped 1-1 with
DataRepositoryPath
. The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if a data repository is associated
with file system path /ns1/
, then you cannot link another data repository with file system
path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data
repository to the file system. You can only specify "/" as the file system path for the first data
repository associated with a file system.
public String getFileSystemPath()
A path on the file system that points to a high-level directory (such as /ns1/
) or subdirectory
(such as /ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
. The leading
forward slash in the name is required. Two data repository associations cannot have overlapping file system
paths. For example, if a data repository is associated with file system path /ns1/
, then you cannot
link another data repository with file system path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data repository
to the file system. You can only specify "/" as the file system path for the first data repository associated
with a file system.
/ns1/
) or
subdirectory (such as /ns1/subdir/
) that will be mapped 1-1 with
DataRepositoryPath
. The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if a data repository is associated
with file system path /ns1/
, then you cannot link another data repository with file system
path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data
repository to the file system. You can only specify "/" as the file system path for the first data
repository associated with a file system.
public DataRepositoryAssociation withFileSystemPath(String fileSystemPath)
A path on the file system that points to a high-level directory (such as /ns1/
) or subdirectory
(such as /ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
. The leading
forward slash in the name is required. Two data repository associations cannot have overlapping file system
paths. For example, if a data repository is associated with file system path /ns1/
, then you cannot
link another data repository with file system path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data repository
to the file system. You can only specify "/" as the file system path for the first data repository associated
with a file system.
fileSystemPath
- A path on the file system that points to a high-level directory (such as /ns1/
) or
subdirectory (such as /ns1/subdir/
) that will be mapped 1-1 with
DataRepositoryPath
. The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if a data repository is associated
with file system path /ns1/
, then you cannot link another data repository with file system
path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you can link only 1 data
repository to the file system. You can only specify "/" as the file system path for the first data
repository associated with a file system.
public void setDataRepositoryPath(String dataRepositoryPath)
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or
prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3 data repository
files will be imported from or exported to.
dataRepositoryPath
- The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3
bucket or prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3
data repository files will be imported from or exported to.public String getDataRepositoryPath()
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or
prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3 data repository
files will be imported from or exported to.
s3://myBucket/myPrefix/
. This path specifies where in the S3
data repository files will be imported from or exported to.public DataRepositoryAssociation withDataRepositoryPath(String dataRepositoryPath)
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or
prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3 data repository
files will be imported from or exported to.
dataRepositoryPath
- The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3
bucket or prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3
data repository files will be imported from or exported to.public void setBatchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created. The task runs if this flag is set to true
.
batchImportMetaDataOnCreate
- A boolean flag indicating whether an import data repository task to import metadata should run after the
data repository association is created. The task runs if this flag is set to true
.public Boolean getBatchImportMetaDataOnCreate()
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created. The task runs if this flag is set to true
.
true
.public DataRepositoryAssociation withBatchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created. The task runs if this flag is set to true
.
batchImportMetaDataOnCreate
- A boolean flag indicating whether an import data repository task to import metadata should run after the
data repository association is created. The task runs if this flag is set to true
.public Boolean isBatchImportMetaDataOnCreate()
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created. The task runs if this flag is set to true
.
true
.public void setImportedFileChunkSize(Integer importedFileChunkSize)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
importedFileChunkSize
- For files imported from a data repository, this value determines the stripe count and maximum amount of
data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file
can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
public Integer getImportedFileChunkSize()
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
public DataRepositoryAssociation withImportedFileChunkSize(Integer importedFileChunkSize)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
importedFileChunkSize
- For files imported from a data repository, this value determines the stripe count and maximum amount of
data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file
can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
public void setS3(S3DataRepositoryConfiguration s3)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
s3
- The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data
repository association. The configuration defines which file events (new, changed, or deleted files or
directories) are automatically imported from the linked data repository to the file system or
automatically exported from the file system to the data repository.public S3DataRepositoryConfiguration getS3()
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
public DataRepositoryAssociation withS3(S3DataRepositoryConfiguration s3)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
s3
- The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data
repository association. The configuration defines which file events (new, changed, or deleted files or
directories) are automatically imported from the linked data repository to the file system or
automatically exported from the file system to the data repository.public void setTags(Collection<Tag> tags)
tags
- public DataRepositoryAssociation withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public DataRepositoryAssociation withTags(Collection<Tag> tags)
tags
- public void setCreationTime(Date creationTime)
creationTime
- public Date getCreationTime()
public DataRepositoryAssociation withCreationTime(Date creationTime)
creationTime
- public String toString()
toString
in class Object
Object.toString()
public DataRepositoryAssociation clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.