Interface CreateFileCacheRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateFileCacheRequest.Builder,
,CreateFileCacheRequest> FSxRequest.Builder
,SdkBuilder<CreateFileCacheRequest.Builder,
,CreateFileCacheRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateFileCacheRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) An idempotency token for resource creation, in a string of up to 63 ASCII characters.copyTagsToDataRepositoryAssociations
(Boolean copyTagsToDataRepositoryAssociations) A boolean flag indicating whether tags for the cache should be copied to data repository associations.dataRepositoryAssociations
(Collection<FileCacheDataRepositoryAssociation> dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation.dataRepositoryAssociations
(Consumer<FileCacheDataRepositoryAssociation.Builder>... dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation.dataRepositoryAssociations
(FileCacheDataRepositoryAssociation... dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation.fileCacheType
(String fileCacheType) The type of cache that you're creating, which must beLUSTRE
.fileCacheType
(FileCacheType fileCacheType) The type of cache that you're creating, which must beLUSTRE
.fileCacheTypeVersion
(String fileCacheTypeVersion) Sets the Lustre version for the cache that you're creating, which must be2.12
.Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.default CreateFileCacheRequest.Builder
lustreConfiguration
(Consumer<CreateFileCacheLustreConfiguration.Builder> lustreConfiguration) The configuration for the Amazon File Cache resource being created.lustreConfiguration
(CreateFileCacheLustreConfiguration lustreConfiguration) The configuration for the Amazon File Cache resource being created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.securityGroupIds
(String... securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.securityGroupIds
(Collection<String> securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.storageCapacity
(Integer storageCapacity) The storage capacity of the cache in gibibytes (GiB).Sets the value of the SubnetIds property for this object.subnetIds
(Collection<String> subnetIds) Sets the value of the SubnetIds property for this object.tags
(Collection<Tag> tags) Sets the value of the Tags property for this object.tags
(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.Sets the value of the Tags property for this object.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
clientRequestToken
An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a
CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.- Parameters:
clientRequestToken
- An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.By using the idempotent operation, you can retry a
CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileCacheType
The type of cache that you're creating, which must be
LUSTRE
.- Parameters:
fileCacheType
- The type of cache that you're creating, which must beLUSTRE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileCacheType
The type of cache that you're creating, which must be
LUSTRE
.- Parameters:
fileCacheType
- The type of cache that you're creating, which must beLUSTRE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileCacheTypeVersion
Sets the Lustre version for the cache that you're creating, which must be
2.12
.- Parameters:
fileCacheTypeVersion
- Sets the Lustre version for the cache that you're creating, which must be2.12
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageCapacity
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
- Parameters:
storageCapacity
- The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
Sets the value of the SubnetIds property for this object.- Parameters:
subnetIds
- The new value for the SubnetIds property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
Sets the value of the SubnetIds property for this object.- Parameters:
subnetIds
- The new value for the SubnetIds property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
- Parameters:
securityGroupIds
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
- Parameters:
securityGroupIds
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object. This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
copyTagsToDataRepositoryAssociations
CreateFileCacheRequest.Builder copyTagsToDataRepositoryAssociations(Boolean copyTagsToDataRepositoryAssociations) A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- Parameters:
copyTagsToDataRepositoryAssociations
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.- Parameters:
kmsKeyId
- Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If aKmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lustreConfiguration
CreateFileCacheRequest.Builder lustreConfiguration(CreateFileCacheLustreConfiguration lustreConfiguration) The configuration for the Amazon File Cache resource being created.
- Parameters:
lustreConfiguration
- The configuration for the Amazon File Cache resource being created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lustreConfiguration
default CreateFileCacheRequest.Builder lustreConfiguration(Consumer<CreateFileCacheLustreConfiguration.Builder> lustreConfiguration) The configuration for the Amazon File Cache resource being created.
This is a convenience method that creates an instance of theCreateFileCacheLustreConfiguration.Builder
avoiding the need to create one manually viaCreateFileCacheLustreConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolustreConfiguration(CreateFileCacheLustreConfiguration)
.- Parameters:
lustreConfiguration
- a consumer that will call methods onCreateFileCacheLustreConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataRepositoryAssociations
CreateFileCacheRequest.Builder dataRepositoryAssociations(Collection<FileCacheDataRepositoryAssociation> dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
- Parameters:
dataRepositoryAssociations
- A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dataRepositoryAssociations
CreateFileCacheRequest.Builder dataRepositoryAssociations(FileCacheDataRepositoryAssociation... dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
- Parameters:
dataRepositoryAssociations
- A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dataRepositoryAssociations
CreateFileCacheRequest.Builder dataRepositoryAssociations(Consumer<FileCacheDataRepositoryAssociation.Builder>... dataRepositoryAssociations) A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
This is a convenience method that creates an instance of theFileCacheDataRepositoryAssociation.Builder
avoiding the need to create one manually viaFileCacheDataRepositoryAssociation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataRepositoryAssociations(List<FileCacheDataRepositoryAssociation>)
.- Parameters:
dataRepositoryAssociations
- a consumer that will call methods onFileCacheDataRepositoryAssociation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
CreateFileCacheRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateFileCacheRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-