AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | List of all members
Aws::EFS::Model::CreateFileSystemRequest Class Reference

#include <CreateFileSystemRequest.h>

+ Inheritance diagram for Aws::EFS::Model::CreateFileSystemRequest:

Public Member Functions

 CreateFileSystemRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCreationToken () const
 
bool CreationTokenHasBeenSet () const
 
void SetCreationToken (const Aws::String &value)
 
void SetCreationToken (Aws::String &&value)
 
void SetCreationToken (const char *value)
 
CreateFileSystemRequestWithCreationToken (const Aws::String &value)
 
CreateFileSystemRequestWithCreationToken (Aws::String &&value)
 
CreateFileSystemRequestWithCreationToken (const char *value)
 
const PerformanceModeGetPerformanceMode () const
 
bool PerformanceModeHasBeenSet () const
 
void SetPerformanceMode (const PerformanceMode &value)
 
void SetPerformanceMode (PerformanceMode &&value)
 
CreateFileSystemRequestWithPerformanceMode (const PerformanceMode &value)
 
CreateFileSystemRequestWithPerformanceMode (PerformanceMode &&value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
CreateFileSystemRequestWithEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateFileSystemRequestWithKmsKeyId (const Aws::String &value)
 
CreateFileSystemRequestWithKmsKeyId (Aws::String &&value)
 
CreateFileSystemRequestWithKmsKeyId (const char *value)
 
const ThroughputModeGetThroughputMode () const
 
bool ThroughputModeHasBeenSet () const
 
void SetThroughputMode (const ThroughputMode &value)
 
void SetThroughputMode (ThroughputMode &&value)
 
CreateFileSystemRequestWithThroughputMode (const ThroughputMode &value)
 
CreateFileSystemRequestWithThroughputMode (ThroughputMode &&value)
 
double GetProvisionedThroughputInMibps () const
 
bool ProvisionedThroughputInMibpsHasBeenSet () const
 
void SetProvisionedThroughputInMibps (double value)
 
CreateFileSystemRequestWithProvisionedThroughputInMibps (double value)
 
const Aws::StringGetAvailabilityZoneName () const
 
bool AvailabilityZoneNameHasBeenSet () const
 
void SetAvailabilityZoneName (const Aws::String &value)
 
void SetAvailabilityZoneName (Aws::String &&value)
 
void SetAvailabilityZoneName (const char *value)
 
CreateFileSystemRequestWithAvailabilityZoneName (const Aws::String &value)
 
CreateFileSystemRequestWithAvailabilityZoneName (Aws::String &&value)
 
CreateFileSystemRequestWithAvailabilityZoneName (const char *value)
 
bool GetBackup () const
 
bool BackupHasBeenSet () const
 
void SetBackup (bool value)
 
CreateFileSystemRequestWithBackup (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateFileSystemRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateFileSystemRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateFileSystemRequestAddTags (const Tag &value)
 
CreateFileSystemRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::EFS::EFSRequest
virtual ~EFSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::EFS::EFSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file CreateFileSystemRequest.h.

Constructor & Destructor Documentation

◆ CreateFileSystemRequest()

Aws::EFS::Model::CreateFileSystemRequest::CreateFileSystemRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::AddTags ( const Tag value)
inline

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.

Definition at line 729 of file CreateFileSystemRequest.h.

◆ AddTags() [2/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 740 of file CreateFileSystemRequest.h.

◆ AvailabilityZoneNameHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::AvailabilityZoneNameHasBeenSet ( ) const
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 522 of file CreateFileSystemRequest.h.

◆ BackupHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::BackupHasBeenSet ( ) const
inline

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.

Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.

Definition at line 623 of file CreateFileSystemRequest.h.

◆ CreationTokenHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::CreationTokenHasBeenSet ( ) const
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 50 of file CreateFileSystemRequest.h.

◆ EncryptedHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::EncryptedHasBeenSet ( ) const
inline

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 Key Management Service (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.

Definition at line 180 of file CreateFileSystemRequest.h.

◆ GetAvailabilityZoneName()

const Aws::String& Aws::EFS::Model::CreateFileSystemRequest::GetAvailabilityZoneName ( ) const
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 510 of file CreateFileSystemRequest.h.

◆ GetBackup()

bool Aws::EFS::Model::CreateFileSystemRequest::GetBackup ( ) const
inline

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.

Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.

Definition at line 609 of file CreateFileSystemRequest.h.

◆ GetCreationToken()

const Aws::String& Aws::EFS::Model::CreateFileSystemRequest::GetCreationToken ( ) const
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 44 of file CreateFileSystemRequest.h.

◆ GetEncrypted()

bool Aws::EFS::Model::CreateFileSystemRequest::GetEncrypted ( ) const
inline

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 Key Management Service (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.

Definition at line 170 of file CreateFileSystemRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::EFS::Model::CreateFileSystemRequest::GetKmsKeyId ( ) const
inline

The ID of the 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.

Definition at line 221 of file CreateFileSystemRequest.h.

◆ GetPerformanceMode()

const PerformanceMode& Aws::EFS::Model::CreateFileSystemRequest::GetPerformanceMode ( ) const
inline

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.

Definition at line 99 of file CreateFileSystemRequest.h.

◆ GetProvisionedThroughputInMibps()

double Aws::EFS::Model::CreateFileSystemRequest::GetProvisionedThroughputInMibps ( ) const
inline

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 Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Definition at line 464 of file CreateFileSystemRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EFS::Model::CreateFileSystemRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateFileSystemRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EFS::Model::CreateFileSystemRequest::GetTags ( ) const
inline

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.

Definition at line 663 of file CreateFileSystemRequest.h.

◆ GetThroughputMode()

const ThroughputMode& Aws::EFS::Model::CreateFileSystemRequest::GetThroughputMode ( ) const
inline

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.

Definition at line 377 of file CreateFileSystemRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::KmsKeyIdHasBeenSet ( ) const
inline

The ID of the 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.

Definition at line 241 of file CreateFileSystemRequest.h.

◆ PerformanceModeHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::PerformanceModeHasBeenSet ( ) const
inline

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.

Definition at line 111 of file CreateFileSystemRequest.h.

◆ ProvisionedThroughputInMibpsHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::ProvisionedThroughputInMibpsHasBeenSet ( ) const
inline

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 Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Definition at line 475 of file CreateFileSystemRequest.h.

◆ SerializePayload()

Aws::String Aws::EFS::Model::CreateFileSystemRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZoneName() [1/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetAvailabilityZoneName ( Aws::String &&  value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 546 of file CreateFileSystemRequest.h.

◆ SetAvailabilityZoneName() [2/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetAvailabilityZoneName ( const Aws::String value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 534 of file CreateFileSystemRequest.h.

◆ SetAvailabilityZoneName() [3/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetAvailabilityZoneName ( const char *  value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 558 of file CreateFileSystemRequest.h.

◆ SetBackup()

void Aws::EFS::Model::CreateFileSystemRequest::SetBackup ( bool  value)
inline

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.

Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.

Definition at line 637 of file CreateFileSystemRequest.h.

◆ SetCreationToken() [1/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetCreationToken ( Aws::String &&  value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 62 of file CreateFileSystemRequest.h.

◆ SetCreationToken() [2/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetCreationToken ( const Aws::String value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 56 of file CreateFileSystemRequest.h.

◆ SetCreationToken() [3/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetCreationToken ( const char *  value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 68 of file CreateFileSystemRequest.h.

◆ SetEncrypted()

void Aws::EFS::Model::CreateFileSystemRequest::SetEncrypted ( bool  value)
inline

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 Key Management Service (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.

Definition at line 190 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The ID of the 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.

Definition at line 281 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetKmsKeyId ( const Aws::String value)
inline

The ID of the 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.

Definition at line 261 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::EFS::Model::CreateFileSystemRequest::SetKmsKeyId ( const char *  value)
inline

The ID of the 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.

Definition at line 301 of file CreateFileSystemRequest.h.

◆ SetPerformanceMode() [1/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetPerformanceMode ( const PerformanceMode value)
inline

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.

Definition at line 123 of file CreateFileSystemRequest.h.

◆ SetPerformanceMode() [2/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetPerformanceMode ( PerformanceMode &&  value)
inline

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.

Definition at line 135 of file CreateFileSystemRequest.h.

◆ SetProvisionedThroughputInMibps()

void Aws::EFS::Model::CreateFileSystemRequest::SetProvisionedThroughputInMibps ( double  value)
inline

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 Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Definition at line 486 of file CreateFileSystemRequest.h.

◆ SetTags() [1/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 696 of file CreateFileSystemRequest.h.

◆ SetTags() [2/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 685 of file CreateFileSystemRequest.h.

◆ SetThroughputMode() [1/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetThroughputMode ( const ThroughputMode value)
inline

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.

Definition at line 407 of file CreateFileSystemRequest.h.

◆ SetThroughputMode() [2/2]

void Aws::EFS::Model::CreateFileSystemRequest::SetThroughputMode ( ThroughputMode &&  value)
inline

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.

Definition at line 422 of file CreateFileSystemRequest.h.

◆ TagsHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 674 of file CreateFileSystemRequest.h.

◆ ThroughputModeHasBeenSet()

bool Aws::EFS::Model::CreateFileSystemRequest::ThroughputModeHasBeenSet ( ) const
inline

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.

Definition at line 392 of file CreateFileSystemRequest.h.

◆ WithAvailabilityZoneName() [1/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithAvailabilityZoneName ( Aws::String &&  value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 582 of file CreateFileSystemRequest.h.

◆ WithAvailabilityZoneName() [2/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithAvailabilityZoneName ( const Aws::String value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 570 of file CreateFileSystemRequest.h.

◆ WithAvailabilityZoneName() [3/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithAvailabilityZoneName ( const char *  value)
inline

Used to create a file system that uses One Zone storage classes. 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 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 Amazon Web Services Regions where Amazon EFS is available.

Definition at line 594 of file CreateFileSystemRequest.h.

◆ WithBackup()

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithBackup ( bool  value)
inline

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.

Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.

Definition at line 651 of file CreateFileSystemRequest.h.

◆ WithCreationToken() [1/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithCreationToken ( Aws::String &&  value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 80 of file CreateFileSystemRequest.h.

◆ WithCreationToken() [2/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithCreationToken ( const Aws::String value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 74 of file CreateFileSystemRequest.h.

◆ WithCreationToken() [3/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithCreationToken ( const char *  value)
inline

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Definition at line 86 of file CreateFileSystemRequest.h.

◆ WithEncrypted()

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithEncrypted ( bool  value)
inline

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 Key Management Service (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.

Definition at line 200 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [1/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The ID of the 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.

Definition at line 341 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [2/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithKmsKeyId ( const Aws::String value)
inline

The ID of the 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.

Definition at line 321 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [3/3]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithKmsKeyId ( const char *  value)
inline

The ID of the 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.

Definition at line 361 of file CreateFileSystemRequest.h.

◆ WithPerformanceMode() [1/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithPerformanceMode ( const PerformanceMode value)
inline

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.

Definition at line 147 of file CreateFileSystemRequest.h.

◆ WithPerformanceMode() [2/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithPerformanceMode ( PerformanceMode &&  value)
inline

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.

Definition at line 159 of file CreateFileSystemRequest.h.

◆ WithProvisionedThroughputInMibps()

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithProvisionedThroughputInMibps ( double  value)
inline

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 Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Definition at line 497 of file CreateFileSystemRequest.h.

◆ WithTags() [1/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 718 of file CreateFileSystemRequest.h.

◆ WithTags() [2/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 707 of file CreateFileSystemRequest.h.

◆ WithThroughputMode() [1/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithThroughputMode ( const ThroughputMode value)
inline

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.

Definition at line 437 of file CreateFileSystemRequest.h.

◆ WithThroughputMode() [2/2]

CreateFileSystemRequest& Aws::EFS::Model::CreateFileSystemRequest::WithThroughputMode ( ThroughputMode &&  value)
inline

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.

Definition at line 452 of file CreateFileSystemRequest.h.


The documentation for this class was generated from the following file: