software.amazon.awssdk.services.fsx.model

Interface FileCacheCreating.Builder

All Superinterfaces:

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

Enclosing class:

FileCacheCreating

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

Method Summary

Modifier and Type	Method and Description
FileCacheCreating.Builder	copyTagsToDataRepositoryAssociations(Boolean copyTagsToDataRepositoryAssociations) A boolean flag indicating whether tags for the cache should be copied to data repository associations.
FileCacheCreating.Builder	creationTime(Instant creationTime) Sets the value of the CreationTime property for this object.
FileCacheCreating.Builder	dataRepositoryAssociationIds(Collection<String> dataRepositoryAssociationIds) A list of IDs of data repository associations that are associated with this cache.
FileCacheCreating.Builder	dataRepositoryAssociationIds(String... dataRepositoryAssociationIds) A list of IDs of data repository associations that are associated with this cache.
FileCacheCreating.Builder	dnsName(String dnsName) The Domain Name System (DNS) name for the cache.
default FileCacheCreating.Builder	failureDetails(Consumer<FileCacheFailureDetails.Builder> failureDetails) A structure providing details of any failures that occurred.
FileCacheCreating.Builder	failureDetails(FileCacheFailureDetails failureDetails) A structure providing details of any failures that occurred.
FileCacheCreating.Builder	fileCacheId(String fileCacheId) The system-generated, unique ID of the cache.
FileCacheCreating.Builder	fileCacheType(FileCacheType fileCacheType) The type of cache, which must be LUSTRE.
FileCacheCreating.Builder	fileCacheType(String fileCacheType) The type of cache, which must be LUSTRE.
FileCacheCreating.Builder	fileCacheTypeVersion(String fileCacheTypeVersion) The Lustre version of the cache, which must be 2.12.
FileCacheCreating.Builder	kmsKeyId(String kmsKeyId) Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.
FileCacheCreating.Builder	lifecycle(FileCacheLifecycle lifecycle) The lifecycle status of the cache.
FileCacheCreating.Builder	lifecycle(String lifecycle) The lifecycle status of the cache.
default FileCacheCreating.Builder	lustreConfiguration(Consumer<FileCacheLustreConfiguration.Builder> lustreConfiguration) The configuration for the Amazon File Cache resource.
FileCacheCreating.Builder	lustreConfiguration(FileCacheLustreConfiguration lustreConfiguration) The configuration for the Amazon File Cache resource.
FileCacheCreating.Builder	networkInterfaceIds(Collection<String> networkInterfaceIds) Sets the value of the NetworkInterfaceIds property for this object.
FileCacheCreating.Builder	networkInterfaceIds(String... networkInterfaceIds) Sets the value of the NetworkInterfaceIds property for this object.
FileCacheCreating.Builder	ownerId(String ownerId) Sets the value of the OwnerId property for this object.
FileCacheCreating.Builder	resourceARN(String resourceARN) Sets the value of the ResourceARN property for this object.
FileCacheCreating.Builder	storageCapacity(Integer storageCapacity) The storage capacity of the cache in gibibytes (GiB).
FileCacheCreating.Builder	subnetIds(Collection<String> subnetIds) Sets the value of the SubnetIds property for this object.
FileCacheCreating.Builder	subnetIds(String... subnetIds) Sets the value of the SubnetIds property for this object.
FileCacheCreating.Builder	tags(Collection<Tag> tags) Sets the value of the Tags property for this object.
FileCacheCreating.Builder	tags(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.
FileCacheCreating.Builder	tags(Tag... tags) Sets the value of the Tags property for this object.
FileCacheCreating.Builder	vpcId(String vpcId) Sets the value of the VpcId property for this object.

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

ownerId

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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, FileCacheType

fileCacheType

FileCacheCreating.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:

FileCacheType, FileCacheType

fileCacheTypeVersion

FileCacheCreating.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

FileCacheCreating.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:

FileCacheLifecycle, FileCacheLifecycle

lifecycle

FileCacheCreating.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:

FileCacheLifecycle, FileCacheLifecycle

failureDetails

FileCacheCreating.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 FileCacheCreating.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:

failureDetails(FileCacheFailureDetails)

storageCapacity

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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

FileCacheCreating.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.

tags

FileCacheCreating.Builder tags(Collection<Tag> 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

FileCacheCreating.Builder tags(Tag... 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

FileCacheCreating.Builder tags(Consumer<Tag.Builder>... tags)

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

copyTagsToDataRepositoryAssociations

FileCacheCreating.Builder copyTagsToDataRepositoryAssociations(Boolean copyTagsToDataRepositoryAssociations)

A boolean flag indicating whether tags for the cache should be copied to data repository associations.

Parameters:

copyTagsToDataRepositoryAssociations - A boolean flag indicating whether tags for the cache should be copied to data repository associations.

Returns:

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

lustreConfiguration

FileCacheCreating.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 FileCacheCreating.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:

lustreConfiguration(FileCacheLustreConfiguration)

dataRepositoryAssociationIds

FileCacheCreating.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

FileCacheCreating.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.