Package software.amazon.awssdk.services.fsx.model

Interface FileCache.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FileCache.Builder,FileCache>, SdkBuilder<FileCache.Builder,FileCache>, SdkPojo
Enclosing class:
FileCache
public static interface FileCache.Builder extends SdkPojo, CopyableBuilder<FileCache.Builder,FileCache>

  • Method Details

    • ownerId

      FileCache.Builder ownerId(String ownerId)
      Sets the value of the OwnerId property for this object.
      Parameters:
      ownerId - The new value for the OwnerId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      FileCache.Builder creationTime(Instant creationTime)
      Sets the value of the CreationTime property for this object.
      Parameters:
      creationTime - The new value for the CreationTime property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileCacheId

      FileCache.Builder fileCacheId(String fileCacheId)

      The system-generated, unique ID of the cache.

      Parameters:
      fileCacheId - The system-generated, unique ID of the cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileCacheType

      FileCache.Builder fileCacheType(String fileCacheType)

      The type of cache, which must be LUSTRE.

      Parameters:
      fileCacheType - The type of cache, which must be LUSTRE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileCacheType

      FileCache.Builder fileCacheType(FileCacheType fileCacheType)

      The type of cache, which must be LUSTRE.

      Parameters:
      fileCacheType - The type of cache, which must be LUSTRE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileCacheTypeVersion

      FileCache.Builder fileCacheTypeVersion(String fileCacheTypeVersion)

      The Lustre version of the cache, which must be 2.12.

      Parameters:
      fileCacheTypeVersion - The Lustre version of the cache, which must be 2.12.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycle

      FileCache.Builder lifecycle(String lifecycle)

      The lifecycle status of the cache. The following are the possible values and what they mean:

      • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

      • CREATING - The new cache is being created.

      • DELETING - An existing cache is being deleted.

      • UPDATING - The cache is undergoing a customer-initiated update.

      • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

      Parameters:
      lifecycle - The lifecycle status of the cache. The following are the possible values and what they mean:

      • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

      • CREATING - The new cache is being created.

      • DELETING - An existing cache is being deleted.

      • UPDATING - The cache is undergoing a customer-initiated update.

      • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

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

    • lifecycle

      FileCache.Builder lifecycle(FileCacheLifecycle lifecycle)

      The lifecycle status of the cache. The following are the possible values and what they mean:

      • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

      • CREATING - The new cache is being created.

      • DELETING - An existing cache is being deleted.

      • UPDATING - The cache is undergoing a customer-initiated update.

      • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

      Parameters:
      lifecycle - The lifecycle status of the cache. The following are the possible values and what they mean:

      • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

      • CREATING - The new cache is being created.

      • DELETING - An existing cache is being deleted.

      • UPDATING - The cache is undergoing a customer-initiated update.

      • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

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

    • failureDetails

      FileCache.Builder failureDetails(FileCacheFailureDetails failureDetails)

      A structure providing details of any failures that occurred.

      Parameters:
      failureDetails - A structure providing details of any failures that occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureDetails

      default FileCache.Builder failureDetails(Consumer<FileCacheFailureDetails.Builder> failureDetails)

      A structure providing details of any failures that occurred.

      This is a convenience method that creates an instance of the FileCacheFailureDetails.Builder avoiding the need to create one manually via FileCacheFailureDetails.builder().

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

      Parameters:
      failureDetails - a consumer that will call methods on FileCacheFailureDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageCapacity

      FileCache.Builder storageCapacity(Integer storageCapacity)

      The storage capacity of the cache in gibibytes (GiB).

      Parameters:
      storageCapacity - The storage capacity of the cache in gibibytes (GiB).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      FileCache.Builder vpcId(String vpcId)
      Sets the value of the VpcId property for this object.
      Parameters:
      vpcId - The new value for the VpcId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      FileCache.Builder subnetIds(Collection<String> 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

      FileCache.Builder subnetIds(String... 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.

    • networkInterfaceIds

      FileCache.Builder networkInterfaceIds(Collection<String> networkInterfaceIds)
      Sets the value of the NetworkInterfaceIds property for this object.
      Parameters:
      networkInterfaceIds - The new value for the NetworkInterfaceIds property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkInterfaceIds

      FileCache.Builder networkInterfaceIds(String... networkInterfaceIds)
      Sets the value of the NetworkInterfaceIds property for this object.
      Parameters:
      networkInterfaceIds - The new value for the NetworkInterfaceIds property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsName

      FileCache.Builder dnsName(String dnsName)

      The Domain Name System (DNS) name for the cache.

      Parameters:
      dnsName - The Domain Name System (DNS) name for the cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      FileCache.Builder kmsKeyId(String 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceARN

      FileCache.Builder resourceARN(String resourceARN)
      Sets the value of the ResourceARN property for this object.
      Parameters:
      resourceARN - The new value for the ResourceARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lustreConfiguration

      FileCache.Builder lustreConfiguration(FileCacheLustreConfiguration lustreConfiguration)

      The configuration for the Amazon File Cache resource.

      Parameters:
      lustreConfiguration - The configuration for the Amazon File Cache resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lustreConfiguration

      default FileCache.Builder lustreConfiguration(Consumer<FileCacheLustreConfiguration.Builder> lustreConfiguration)

      The configuration for the Amazon File Cache resource.

      This is a convenience method that creates an instance of the FileCacheLustreConfiguration.Builder avoiding the need to create one manually via FileCacheLustreConfiguration.builder().

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

      Parameters:
      lustreConfiguration - a consumer that will call methods on FileCacheLustreConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataRepositoryAssociationIds

      FileCache.Builder dataRepositoryAssociationIds(Collection<String> dataRepositoryAssociationIds)

      A list of IDs of data repository associations that are associated with this cache.

      Parameters:
      dataRepositoryAssociationIds - A list of IDs of data repository associations that are associated with this cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataRepositoryAssociationIds

      FileCache.Builder dataRepositoryAssociationIds(String... dataRepositoryAssociationIds)

      A list of IDs of data repository associations that are associated with this cache.

      Parameters:
      dataRepositoryAssociationIds - A list of IDs of data repository associations that are associated with this cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.