software.amazon.awssdk.services.fsx.model

Interface DataRepositoryConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DataRepositoryConfiguration.Builder,DataRepositoryConfiguration>, SdkBuilder<DataRepositoryConfiguration.Builder,DataRepositoryConfiguration>, SdkPojo

Enclosing class:

DataRepositoryConfiguration

public static interface DataRepositoryConfiguration.Builder
extends SdkPojo, CopyableBuilder<DataRepositoryConfiguration.Builder,DataRepositoryConfiguration>

Method Summary

Modifier and Type	Method and Description
DataRepositoryConfiguration.Builder	autoImportPolicy(AutoImportPolicyType autoImportPolicy) Describes the file system's linked S3 data repository's AutoImportPolicy.
DataRepositoryConfiguration.Builder	autoImportPolicy(String autoImportPolicy) Describes the file system's linked S3 data repository's AutoImportPolicy.
DataRepositoryConfiguration.Builder	exportPath(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.
default DataRepositoryConfiguration.Builder	failureDetails(Consumer<DataRepositoryFailureDetails.Builder> failureDetails) Sets the value of the FailureDetails property for this object.
DataRepositoryConfiguration.Builder	failureDetails(DataRepositoryFailureDetails failureDetails) Sets the value of the FailureDetails property for this object.
DataRepositoryConfiguration.Builder	importedFileChunkSize(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.Builder	importPath(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.Builder	lifecycle(DataRepositoryLifecycle lifecycle) Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository.
DataRepositoryConfiguration.Builder	lifecycle(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 interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

lifecycle

DataRepositoryConfiguration.Builder lifecycle(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.

• FAILED - The data repository is in a terminal state that cannot be recovered.

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.

• FAILED - The data repository is in a terminal state that cannot be recovered.

Returns:

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

See Also:

DataRepositoryLifecycle, DataRepositoryLifecycle

lifecycle

DataRepositoryConfiguration.Builder lifecycle(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.

• FAILED - The data repository is in a terminal state that cannot be recovered.

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.

• FAILED - The data repository is in a terminal state that cannot be recovered.

Returns:

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

See Also:

DataRepositoryLifecycle, DataRepositoryLifecycle

importPath

DataRepositoryConfiguration.Builder importPath(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.

exportPath

DataRepositoryConfiguration.Builder exportPath(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.

importedFileChunkSize

DataRepositoryConfiguration.Builder importedFileChunkSize(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.

autoImportPolicy

DataRepositoryConfiguration.Builder autoImportPolicy(String autoImportPolicy)

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

• NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

• NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

• NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

Parameters:

autoImportPolicy - Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

• NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

• NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

• NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

Returns:

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

See Also:

AutoImportPolicyType, AutoImportPolicyType

autoImportPolicy

DataRepositoryConfiguration.Builder autoImportPolicy(AutoImportPolicyType autoImportPolicy)

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

• NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

• NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

• NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

Parameters:

autoImportPolicy - Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

• NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

• NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

• NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

• NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

Returns:

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

See Also:

AutoImportPolicyType, AutoImportPolicyType

failureDetails

DataRepositoryConfiguration.Builder failureDetails(DataRepositoryFailureDetails failureDetails)

Sets the value of the FailureDetails property for this object.

Parameters:

failureDetails - The new value for the FailureDetails property for this object.

Returns:

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

failureDetails

default DataRepositoryConfiguration.Builder failureDetails(Consumer<DataRepositoryFailureDetails.Builder> failureDetails)

Sets the value of the FailureDetails property for this object. This is a convenience method that creates an instance of the DataRepositoryFailureDetails.Builder avoiding the need to create one manually via DataRepositoryFailureDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(DataRepositoryFailureDetails).

Parameters:

failureDetails - a consumer that will call methods on DataRepositoryFailureDetails.Builder

Returns:

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

See Also:

failureDetails(DataRepositoryFailureDetails)