Class CreateFileSystemRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFileSystemRequest.Builder,
CreateFileSystemRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Used to create a One Zone file system.final Boolean
backup()
Specifies whether automatic backups are enabled on the file system that you are creating.builder()
final String
A string of up to 64 ASCII characters.final Boolean
A Boolean value that, if true, creates an encrypted file system.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The ID of the KMS key that you want to use to protect the encrypted file system.final PerformanceMode
The Performance mode of the file system.final String
The Performance mode of the file system.final Double
The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.static Class
<? extends CreateFileSystemRequest.Builder> tags()
Use to create one or more tags associated with the file system.final ThroughputMode
Specifies the throughput mode for the file system.final String
Specifies the throughput mode for the file system.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
-
creationToken
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
- Returns:
- A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
-
performanceMode
The Performance mode of the file system. We recommend
generalPurpose
performance mode for all file systems. File systems using themaxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. ThemaxIO
mode is not supported on One Zone file systems.Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is
generalPurpose
.If the service returns an enum value that is not available in the current SDK version,
performanceMode
will returnPerformanceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperformanceModeAsString()
.- Returns:
- The Performance mode of the file system. We recommend
generalPurpose
performance mode for all file systems. File systems using themaxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. ThemaxIO
mode is not supported on One Zone file systems.Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is
generalPurpose
. - See Also:
-
performanceModeAsString
The Performance mode of the file system. We recommend
generalPurpose
performance mode for all file systems. File systems using themaxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. ThemaxIO
mode is not supported on One Zone file systems.Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is
generalPurpose
.If the service returns an enum value that is not available in the current SDK version,
performanceMode
will returnPerformanceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperformanceModeAsString()
.- Returns:
- The Performance mode of the file system. We recommend
generalPurpose
performance mode for all file systems. File systems using themaxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. ThemaxIO
mode is not supported on One Zone file systems.Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is
generalPurpose
. - See Also:
-
encrypted
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.- Returns:
- A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system,
you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify
a KMS key, then the default KMS key for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.
-
kmsKeyId
The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:
-
Key ID - A unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab
. -
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Key alias - A previously created display name for a key, for example
alias/projectKey1
. -
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If you use
KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted parameter to true.EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
- Returns:
- The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is
required only if you want to use a non-default KMS key. If this parameter is not specified, the default
KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:
-
Key ID - A unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab
. -
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Key alias - A previously created display name for a key, for example
alias/projectKey1
. -
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If you use
KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted parameter to true.EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
-
-
-
throughputMode
Specifies the throughput mode for the file system. The mode can be
bursting
,provisioned
, orelastic
. If you setThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.Default is
bursting
.If the service returns an enum value that is not available in the current SDK version,
throughputMode
will returnThroughputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthroughputModeAsString()
.- Returns:
- Specifies the throughput mode for the file system. The mode can be
bursting
,provisioned
, orelastic
. If you setThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.Default is
bursting
. - See Also:
-
throughputModeAsString
Specifies the throughput mode for the file system. The mode can be
bursting
,provisioned
, orelastic
. If you setThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.Default is
bursting
.If the service returns an enum value that is not available in the current SDK version,
throughputMode
will returnThroughputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthroughputModeAsString()
.- Returns:
- Specifies the throughput mode for the file system. The mode can be
bursting
,provisioned
, orelastic
. If you setThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.Default is
bursting
. - See Also:
-
provisionedThroughputInMibps
The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if
ThroughputMode
is set toprovisioned
. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.- Returns:
- The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system
that you're creating. Required if
ThroughputMode
is set toprovisioned
. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
-
availabilityZoneName
Used to create a One Zone file system. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format
us-east-1a
to specify the Availability Zone. For more information about One Zone file systems, see Using EFS storage classes in the Amazon EFS User Guide.One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
- Returns:
- Used to create a One Zone file system. It specifies the Amazon Web Services Availability Zone in which to
create the file system. Use the format
us-east-1a
to specify the Availability Zone. For more information about One Zone file systems, see Using EFS storage classes in the Amazon EFS User Guide.One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
-
backup
Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to
true
to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide.Default is
false
. However, if you specify anAvailabilityZoneName
, the default istrue
.Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
- Returns:
- Specifies whether automatic backups are enabled on the file system that you are creating. Set the value
to
true
to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide.Default is
false
. However, if you specify anAvailabilityZoneName
, the default istrue
.Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
-
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
Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.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:
- Use to create one or more tags associated with the file system. Each tag is a user-defined key-value
pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
-
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<CreateFileSystemRequest.Builder,
CreateFileSystemRequest> - Specified by:
toBuilder
in classEfsRequest
- 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
-