com.amazonaws.services.elasticfilesystem.model.CreateFileSystemRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticfilesystem.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFileSystemRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*
*/
private String creationToken;
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*/
private String performanceMode;
/**
*
* 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.
*
*/
private Boolean encrypted;
/**
*
* 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.
*
*
*/
private String kmsKeyId;
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*/
private String throughputMode;
/**
*
* 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 to provisioned. 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.
*
*/
private Double provisionedThroughputInMibps;
/**
*
* 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.
*
*
*/
private String availabilityZoneName;
/**
*
* 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 an AvailabilityZoneName, the default is
* true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*
*/
private Boolean backup;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*
*
* @param creationToken
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*/
public void setCreationToken(String creationToken) {
this.creationToken = creationToken;
}
/**
*
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*
*
* @return A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*/
public String getCreationToken() {
return this.creationToken;
}
/**
*
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
*
*
* @param creationToken
* A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withCreationToken(String creationToken) {
setCreationToken(creationToken);
return this;
}
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*
* @param performanceMode
* The Performance mode of the file system. We recommend generalPurpose performance mode for all
* 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 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 PerformanceMode
*/
public void setPerformanceMode(String performanceMode) {
this.performanceMode = performanceMode;
}
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*
* @return The Performance mode of the file system. We recommend generalPurpose performance mode for
* all 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 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 PerformanceMode
*/
public String getPerformanceMode() {
return this.performanceMode;
}
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*
* @param performanceMode
* The Performance mode of the file system. We recommend generalPurpose performance mode for all
* 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PerformanceMode
*/
public CreateFileSystemRequest withPerformanceMode(String performanceMode) {
setPerformanceMode(performanceMode);
return this;
}
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*
* @param performanceMode
* The Performance mode of the file system. We recommend generalPurpose performance mode for all
* 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 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 PerformanceMode
*/
public void setPerformanceMode(PerformanceMode performanceMode) {
withPerformanceMode(performanceMode);
}
/**
*
* The Performance mode of the file system. We recommend generalPurpose performance mode for all 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 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.
*
*
* @param performanceMode
* The Performance mode of the file system. We recommend generalPurpose performance mode for all
* 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PerformanceMode
*/
public CreateFileSystemRequest withPerformanceMode(PerformanceMode performanceMode) {
this.performanceMode = performanceMode.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = 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.
*
*
* @return 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.
*/
public Boolean getEncrypted() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isEncrypted() {
return this.encrypted;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = 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.
*
*
*
* @return 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.
*
*/
public String getKmsKeyId() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*
* @param throughputMode
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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 ThroughputMode
*/
public void setThroughputMode(String throughputMode) {
this.throughputMode = throughputMode;
}
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*
* @return Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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 ThroughputMode
*/
public String getThroughputMode() {
return this.throughputMode;
}
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*
* @param throughputMode
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ThroughputMode
*/
public CreateFileSystemRequest withThroughputMode(String throughputMode) {
setThroughputMode(throughputMode);
return this;
}
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*
* @param throughputMode
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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 ThroughputMode
*/
public void setThroughputMode(ThroughputMode throughputMode) {
withThroughputMode(throughputMode);
}
/**
*
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
*
*
* @param throughputMode
* Specifies the throughput mode for the file system. The mode can be bursting,
* provisioned, or elastic. 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ThroughputMode
*/
public CreateFileSystemRequest withThroughputMode(ThroughputMode throughputMode) {
this.throughputMode = throughputMode.toString();
return this;
}
/**
*
* 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 to provisioned. 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.
*
*
* @param 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 to provisioned. 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.
*/
public void setProvisionedThroughputInMibps(Double provisionedThroughputInMibps) {
this.provisionedThroughputInMibps = 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 to provisioned. 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.
*
*
* @return 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 to provisioned. 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.
*/
public Double getProvisionedThroughputInMibps() {
return this.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 to provisioned. 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.
*
*
* @param 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 to provisioned. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withProvisionedThroughputInMibps(Double provisionedThroughputInMibps) {
setProvisionedThroughputInMibps(provisionedThroughputInMibps);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setAvailabilityZoneName(String availabilityZoneName) {
this.availabilityZoneName = 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.
*
*
*
* @return 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.
*
*/
public String getAvailabilityZoneName() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withAvailabilityZoneName(String availabilityZoneName) {
setAvailabilityZoneName(availabilityZoneName);
return this;
}
/**
*
* 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 an AvailabilityZoneName, the default is
* true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*
*
* @param 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 an AvailabilityZoneName, the default
* is true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*/
public void setBackup(Boolean backup) {
this.backup = 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 an AvailabilityZoneName, the default is
* true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*
*
* @return 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 an AvailabilityZoneName, the default
* is true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*/
public Boolean getBackup() {
return this.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 an AvailabilityZoneName, the default is
* true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*
*
* @param 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 an AvailabilityZoneName, the default
* is true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withBackup(Boolean backup) {
setBackup(backup);
return this;
}
/**
*
* 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 an AvailabilityZoneName, the default is
* true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*
*
* @return 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 an AvailabilityZoneName, the default
* is true.
*
*
*
* Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
*
*/
public Boolean isBackup() {
return this.backup;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFileSystemRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCreationToken() != null)
sb.append("CreationToken: ").append(getCreationToken()).append(",");
if (getPerformanceMode() != null)
sb.append("PerformanceMode: ").append(getPerformanceMode()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getThroughputMode() != null)
sb.append("ThroughputMode: ").append(getThroughputMode()).append(",");
if (getProvisionedThroughputInMibps() != null)
sb.append("ProvisionedThroughputInMibps: ").append(getProvisionedThroughputInMibps()).append(",");
if (getAvailabilityZoneName() != null)
sb.append("AvailabilityZoneName: ").append(getAvailabilityZoneName()).append(",");
if (getBackup() != null)
sb.append("Backup: ").append(getBackup()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateFileSystemRequest == false)
return false;
CreateFileSystemRequest other = (CreateFileSystemRequest) obj;
if (other.getCreationToken() == null ^ this.getCreationToken() == null)
return false;
if (other.getCreationToken() != null && other.getCreationToken().equals(this.getCreationToken()) == false)
return false;
if (other.getPerformanceMode() == null ^ this.getPerformanceMode() == null)
return false;
if (other.getPerformanceMode() != null && other.getPerformanceMode().equals(this.getPerformanceMode()) == false)
return false;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getThroughputMode() == null ^ this.getThroughputMode() == null)
return false;
if (other.getThroughputMode() != null && other.getThroughputMode().equals(this.getThroughputMode()) == false)
return false;
if (other.getProvisionedThroughputInMibps() == null ^ this.getProvisionedThroughputInMibps() == null)
return false;
if (other.getProvisionedThroughputInMibps() != null && other.getProvisionedThroughputInMibps().equals(this.getProvisionedThroughputInMibps()) == false)
return false;
if (other.getAvailabilityZoneName() == null ^ this.getAvailabilityZoneName() == null)
return false;
if (other.getAvailabilityZoneName() != null && other.getAvailabilityZoneName().equals(this.getAvailabilityZoneName()) == false)
return false;
if (other.getBackup() == null ^ this.getBackup() == null)
return false;
if (other.getBackup() != null && other.getBackup().equals(this.getBackup()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCreationToken() == null) ? 0 : getCreationToken().hashCode());
hashCode = prime * hashCode + ((getPerformanceMode() == null) ? 0 : getPerformanceMode().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getThroughputMode() == null) ? 0 : getThroughputMode().hashCode());
hashCode = prime * hashCode + ((getProvisionedThroughputInMibps() == null) ? 0 : getProvisionedThroughputInMibps().hashCode());
hashCode = prime * hashCode + ((getAvailabilityZoneName() == null) ? 0 : getAvailabilityZoneName().hashCode());
hashCode = prime * hashCode + ((getBackup() == null) ? 0 : getBackup().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateFileSystemRequest clone() {
return (CreateFileSystemRequest) super.clone();
}
}