Class CreateDataRepositoryAssociationRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.fsx.model.FSxRequest
-
- software.amazon.awssdk.services.fsx.model.CreateDataRepositoryAssociationRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataRepositoryAssociationRequest extends FSxRequest implements ToCopyableBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateDataRepositoryAssociationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
batchImportMetaDataOnCreate()
Set totrue
to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created.static CreateDataRepositoryAssociationRequest.Builder
builder()
String
clientRequestToken()
Returns the value of the ClientRequestToken property for this object.String
dataRepositoryPath()
The path to the Amazon S3 data repository that will be linked to the file system.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
fileSystemId()
Returns the value of the FileSystemId property for this object.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 withDataRepositoryPath
.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.S3DataRepositoryConfiguration
s3()
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.List<SdkField<?>>
sdkFields()
static Class<? extends CreateDataRepositoryAssociationRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
Returns the value of the Tags property for this object.CreateDataRepositoryAssociationRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
fileSystemId
public final String fileSystemId()
Returns the value of the FileSystemId property for this object.- Returns:
- The value of the FileSystemId property for this object.
-
fileSystemPath
public final 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 withDataRepositoryPath
. 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 one 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.- Returns:
- 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 withDataRepositoryPath
. 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 one 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.
-
dataRepositoryPath
public final 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.- Returns:
- 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.
-
batchImportMetaDataOnCreate
public final Boolean batchImportMetaDataOnCreate()
Set to
true
to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default isfalse
.- Returns:
- Set to
true
to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default isfalse
.
-
importedFileChunkSize
public final 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.
- 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.
-
s3
public final 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.
- Returns:
- 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.
-
clientRequestToken
public final String clientRequestToken()
Returns the value of the ClientRequestToken property for this object.- Returns:
- The value of the ClientRequestToken property for this object.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
Returns the value of the Tags property for this object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The value of the Tags property for this object.
-
toBuilder
public CreateDataRepositoryAssociationRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>
- Specified by:
toBuilder
in classFSxRequest
-
builder
public static CreateDataRepositoryAssociationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDataRepositoryAssociationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-