Class CreateFileCacheRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFileCacheRequest.Builder,
CreateFileCacheRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
An idempotency token for resource creation, in a string of up to 63 ASCII characters.final Boolean
A boolean flag indicating whether tags for the cache should be copied to data repository associations.A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FileCacheType
The type of cache that you're creating, which must beLUSTRE
.final String
The type of cache that you're creating, which must beLUSTRE
.final String
Sets the Lustre version for the cache that you're creating, which must be2.12
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DataRepositoryAssociations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.The configuration for the Amazon File Cache resource being created.A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.static Class
<? extends CreateFileCacheRequest.Builder> final Integer
The storage capacity of the cache in gibibytes (GiB).Returns the value of the SubnetIds property for this object.tags()
Returns the value of the Tags property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.- Returns:
- 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.
-
fileCacheType
The type of cache that you're creating, which must be
LUSTRE
.If the service returns an enum value that is not available in the current SDK version,
fileCacheType
will returnFileCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileCacheTypeAsString()
.- Returns:
- The type of cache that you're creating, which must be
LUSTRE
. - See Also:
-
fileCacheTypeAsString
The type of cache that you're creating, which must be
LUSTRE
.If the service returns an enum value that is not available in the current SDK version,
fileCacheType
will returnFileCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileCacheTypeAsString()
.- Returns:
- The type of cache that you're creating, which must be
LUSTRE
. - See Also:
-
fileCacheTypeVersion
Sets the Lustre version for the cache that you're creating, which must be
2.12
.- Returns:
- Sets the Lustre version for the cache that you're creating, which must be
2.12
.
-
storageCapacity
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
- Returns:
- The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
-
hasSubnetIds
public final boolean hasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds 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. -
subnetIds
Returns the value of the SubnetIds 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
hasSubnetIds()
method.- Returns:
- The value of the SubnetIds property for this object.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds 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. -
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.
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
hasSecurityGroupIds()
method.- Returns:
- 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.
-
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
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.
-
copyTagsToDataRepositoryAssociations
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- Returns:
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
-
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:
- 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.
-
lustreConfiguration
The configuration for the Amazon File Cache resource being created.
- Returns:
- The configuration for the Amazon File Cache resource being created.
-
hasDataRepositoryAssociations
public final boolean hasDataRepositoryAssociations()For responses, this returns true if the service returned a value for the DataRepositoryAssociations 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. -
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.
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
hasDataRepositoryAssociations()
method.- Returns:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFileCacheRequest.Builder,
CreateFileCacheRequest> - Specified by:
toBuilder
in classFSxRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-