com.amazonaws.services.fsx.model

Class DataRepositoryConfiguration

java.lang.Object

com.amazonaws.services.fsx.model.DataRepositoryConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DataRepositoryConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataRepositoryConfiguration()

Method Summary

Modifier and Type	Method and Description
DataRepositoryConfiguration	clone()
boolean	equals(Object obj)
String	getAutoImportPolicy() Describes the file system's linked S3 data repository's AutoImportPolicy.
String	getExportPath() The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
DataRepositoryFailureDetails	getFailureDetails()
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	getImportPath() The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix.
String	getLifecycle() Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAutoImportPolicy(String autoImportPolicy) Describes the file system's linked S3 data repository's AutoImportPolicy.
void	setExportPath(String exportPath) The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
void	setFailureDetails(DataRepositoryFailureDetails failureDetails)
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	setImportPath(String importPath) The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix.
void	setLifecycle(String lifecycle) Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository.
String	toString() Returns a string representation of this object.
DataRepositoryConfiguration	withAutoImportPolicy(AutoImportPolicyType autoImportPolicy) Describes the file system's linked S3 data repository's AutoImportPolicy.
DataRepositoryConfiguration	withAutoImportPolicy(String autoImportPolicy) Describes the file system's linked S3 data repository's AutoImportPolicy.
DataRepositoryConfiguration	withExportPath(String exportPath) The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
DataRepositoryConfiguration	withFailureDetails(DataRepositoryFailureDetails failureDetails)
DataRepositoryConfiguration	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.
DataRepositoryConfiguration	withImportPath(String importPath) The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix.
DataRepositoryConfiguration	withLifecycle(DataRepositoryLifecycle lifecycle) Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository.
DataRepositoryConfiguration	withLifecycle(String lifecycle) Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataRepositoryConfiguration

public DataRepositoryConfiguration()

Method Detail

setLifecycle

public void setLifecycle(String lifecycle)

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Parameters:

lifecycle - Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

See Also:

DataRepositoryLifecycle

getLifecycle

public String getLifecycle()

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Returns:

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

See Also:

DataRepositoryLifecycle

withLifecycle

public DataRepositoryConfiguration withLifecycle(String lifecycle)

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Parameters:

lifecycle - Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Returns:

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

See Also:

DataRepositoryLifecycle

withLifecycle

public DataRepositoryConfiguration withLifecycle(DataRepositoryLifecycle lifecycle)

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Parameters:

lifecycle - Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

• CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

• AVAILABLE - The data repository is available for use.

• MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

• UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

Returns:

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

See Also:

DataRepositoryLifecycle

setImportPath

public void setImportPath(String importPath)

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

Parameters:

importPath - The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

getImportPath

public String getImportPath()

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

Returns:

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

withImportPath

public DataRepositoryConfiguration withImportPath(String importPath)

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

Parameters:

importPath - The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

Returns:

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

setExportPath

public void setExportPath(String exportPath)

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

Parameters:

exportPath - The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

getExportPath

public String getExportPath()

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

Returns:

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

withExportPath

public DataRepositoryConfiguration withExportPath(String exportPath)

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

Parameters:

exportPath - The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

Returns:

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

setImportedFileChunkSize

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.

Parameters:

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.

getImportedFileChunkSize

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.

Returns:

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.

withImportedFileChunkSize

public DataRepositoryConfiguration 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.

Parameters:

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.

Returns:

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

setAutoImportPolicy

public void setAutoImportPolicy(String autoImportPolicy)

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Parameters:

autoImportPolicy - Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

See Also:

AutoImportPolicyType

getAutoImportPolicy

public String getAutoImportPolicy()

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Returns:

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

See Also:

AutoImportPolicyType

withAutoImportPolicy

public DataRepositoryConfiguration withAutoImportPolicy(String autoImportPolicy)

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Parameters:

autoImportPolicy - Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Returns:

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

See Also:

AutoImportPolicyType

withAutoImportPolicy

public DataRepositoryConfiguration withAutoImportPolicy(AutoImportPolicyType autoImportPolicy)

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Parameters:

autoImportPolicy - Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx for Lustre file system automatically updates its contents with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Changes in the linked data repository are not reflected on the FSx file system.

• NEW - AutoImport is on. New files in the linked data repository that do not currently exist in the FSx file system are automatically imported. Updates to existing FSx files are not imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

• NEW_CHANGED - AutoImport is on. New files in the linked S3 data repository that do not currently exist in the FSx file system are automatically imported. Changes to existing FSx files in the linked repository are also automatically imported to the FSx file system. Files deleted from the linked data repository are not deleted from the FSx file system.

For more information, see Automatically import updates from your S3 bucket.

Returns:

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

See Also:

AutoImportPolicyType

setFailureDetails

public void setFailureDetails(DataRepositoryFailureDetails failureDetails)

Parameters:

failureDetails -

getFailureDetails

public DataRepositoryFailureDetails getFailureDetails()

Returns:

withFailureDetails

public DataRepositoryConfiguration withFailureDetails(DataRepositoryFailureDetails failureDetails)

Parameters:

failureDetails -

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DataRepositoryConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.