AWS SDK for C++  1.8.100
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::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

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.

Definition at line 536 of file CreateFileSystemRequest.h.

◆ AddTags() [2/2]

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

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.

Definition at line 544 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 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.

Definition at line 168 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 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.

Definition at line 158 of file CreateFileSystemRequest.h.

◆ GetKmsKeyId()

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 209 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.

Definition at line 97 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. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Definition at line 446 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

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.

Definition at line 488 of file CreateFileSystemRequest.h.

◆ GetThroughputMode()

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 364 of file CreateFileSystemRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 229 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.

Definition at line 107 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. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Definition at line 457 of file CreateFileSystemRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCreationToken() [1/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() [2/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() [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 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.

Definition at line 178 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [1/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 249 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [2/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 269 of file CreateFileSystemRequest.h.

◆ SetKmsKeyId() [3/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 289 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.

Definition at line 117 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.

Definition at line 127 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. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Definition at line 468 of file CreateFileSystemRequest.h.

◆ SetTags() [1/2]

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

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.

Definition at line 504 of file CreateFileSystemRequest.h.

◆ SetTags() [2/2]

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

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.

Definition at line 512 of file CreateFileSystemRequest.h.

◆ SetThroughputMode() [1/2]

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 392 of file CreateFileSystemRequest.h.

◆ SetThroughputMode() [2/2]

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 406 of file CreateFileSystemRequest.h.

◆ TagsHasBeenSet()

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

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.

Definition at line 496 of file CreateFileSystemRequest.h.

◆ ThroughputModeHasBeenSet()

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 378 of file CreateFileSystemRequest.h.

◆ WithCreationToken() [1/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() [2/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() [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 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.

Definition at line 188 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [1/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 309 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [2/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 329 of file CreateFileSystemRequest.h.

◆ WithKmsKeyId() [3/3]

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

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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 CMKs. You cannot use asymmetric CMKs with EFS file systems.

Definition at line 349 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.

Definition at line 137 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.

Definition at line 147 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. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Definition at line 479 of file CreateFileSystemRequest.h.

◆ WithTags() [1/2]

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

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.

Definition at line 520 of file CreateFileSystemRequest.h.

◆ WithTags() [2/2]

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

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.

Definition at line 528 of file CreateFileSystemRequest.h.

◆ WithThroughputMode() [1/2]

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 420 of file CreateFileSystemRequest.h.

◆ WithThroughputMode() [2/2]

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

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

Definition at line 434 of file CreateFileSystemRequest.h.


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