CreateFileSystemRequest (AWS Java SDK :: Services :: Amazon Elastic File System 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.efs.model.EfsRequest
    - - software.amazon.awssdk.services.efs.model.CreateFileSystemRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFileSystemRequest
extends EfsRequest
implements ToCopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFileSystemRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFileSystemRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZoneName()` Used to create a file system that uses One Zone storage classes.
`Boolean`	`backup()` Specifies whether automatic backups are enabled on the file system that you are creating.
`static CreateFileSystemRequest.Builder`	`builder()`
`String`	`creationToken()` A string of up to 64 ASCII characters.
`Boolean`	`encrypted()` A Boolean value that, if true, creates an encrypted file system.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` The ID of the AWS KMS CMK that you want to use to protect the encrypted file system.
`PerformanceMode`	`performanceMode()` The performance mode of the file system.
`String`	`performanceModeAsString()` The performance mode of the file system.
`Double`	`provisionedThroughputInMibps()` The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFileSystemRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` A value that specifies to create one or more tags associated with the file system.
`ThroughputMode`	`throughputMode()` Specifies the throughput mode for the file system, either `bursting` or `provisioned`.
`String`	`throughputModeAsString()` Specifies the throughput mode for the file system, either `bursting` or `provisioned`.
`CreateFileSystemRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - creationToken
```
public final String 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
```
public final PerformanceMode performanceMode()
```
    The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO 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.
    
    The maxIO mode is not supported on file systems using One Zone storage classes.
    
    If the service returns an enum value that is not available in the current SDK version, performanceMode will return PerformanceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceModeAsString().
    
    Returns:
    
    The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO 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.
    
    The maxIO mode is not supported on file systems using One Zone storage classes.
    
    See Also:
    
    PerformanceMode
  - performanceModeAsString
```
public final String performanceModeAsString()
```
    The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO 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.
    
    The maxIO mode is not supported on file systems using One Zone storage classes.
    
    If the service returns an enum value that is not available in the current SDK version, performanceMode will return PerformanceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceModeAsString().
    
    Returns:
    
    The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO 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.
    
    The maxIO mode is not supported on file systems using One Zone storage classes.
    
    See Also:
    
    PerformanceMode
  - encrypted
```
public final Boolean encrypted()
```
    A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK 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 CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the AWS KMS CMK that you want to use to protect the encrypted file system. This parameter is only required if you want to use a non-default KMS key. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of 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 KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.
    
    EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with EFS file systems.
    Returns:
    The ID of the AWS KMS CMK that you want to use to protect the encrypted file system. This parameter is only required if you want to use a non-default KMS key. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of 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 KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.
    
    EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with EFS file systems.
  - throughputMode
```
public final ThroughputMode throughputMode()
```
    Specifies the throughput mode for the file system, either bursting or provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. 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 return ThroughputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from throughputModeAsString().
    
    Returns:
    
    Specifies the throughput mode for the file system, either bursting or provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.
    
    Default is bursting.
    
    See Also:
    
    ThroughputMode
  - throughputModeAsString
```
public final String throughputModeAsString()
```
    Specifies the throughput mode for the file system, either bursting or provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. 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 return ThroughputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from throughputModeAsString().
    
    Returns:
    
    Specifies the throughput mode for the file system, either bursting or provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.
    
    Default is bursting.
    
    See Also:
    
    ThroughputMode
  - provisionedThroughputInMibps
```
public final Double provisionedThroughputInMibps()
```
    The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    
    Returns:
    
    The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
  - availabilityZoneName
```
public final String availabilityZoneName()
```
    Used to create a file system that uses One Zone storage classes. It specifies the AWS 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 storage classes, see Using EFS storage classes in the Amazon EFS User Guide.
    
    One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.
    
    Returns:
    
    Used to create a file system that uses One Zone storage classes. It specifies the AWS 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 storage classes, see Using EFS storage classes in the Amazon EFS User Guide.
    
    One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.
  - backup
```
public final Boolean 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 file system that uses One Zone storage classes, 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 an AvailabilityZoneName, the default is true.
    
    AWS Backup is not available in all AWS 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 file system that uses One Zone storage classes, 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 an AvailabilityZoneName, the default is true.
    
    AWS Backup is not available in all AWS Regions where Amazon EFS is available.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    A value that specifies 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A value that specifies 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.
  - toBuilder
```
public CreateFileSystemRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>
    
    Specified by:
    
    toBuilder in class EfsRequest
  - builder
```
public static CreateFileSystemRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFileSystemRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFileSystemRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

creationToken

performanceMode

performanceModeAsString

encrypted

kmsKeyId

throughputMode

throughputModeAsString

provisionedThroughputInMibps

availabilityZoneName

backup

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields