AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::EFSVolumeConfiguration Class Reference

#include <EFSVolumeConfiguration.h>

Public Member Functions

 EFSVolumeConfiguration ()
 
 EFSVolumeConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
EFSVolumeConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetFileSystemId () const
 
bool FileSystemIdHasBeenSet () const
 
void SetFileSystemId (const Aws::String &value)
 
void SetFileSystemId (Aws::String &&value)
 
void SetFileSystemId (const char *value)
 
EFSVolumeConfigurationWithFileSystemId (const Aws::String &value)
 
EFSVolumeConfigurationWithFileSystemId (Aws::String &&value)
 
EFSVolumeConfigurationWithFileSystemId (const char *value)
 
const Aws::StringGetRootDirectory () const
 
bool RootDirectoryHasBeenSet () const
 
void SetRootDirectory (const Aws::String &value)
 
void SetRootDirectory (Aws::String &&value)
 
void SetRootDirectory (const char *value)
 
EFSVolumeConfigurationWithRootDirectory (const Aws::String &value)
 
EFSVolumeConfigurationWithRootDirectory (Aws::String &&value)
 
EFSVolumeConfigurationWithRootDirectory (const char *value)
 
const EFSTransitEncryptionGetTransitEncryption () const
 
bool TransitEncryptionHasBeenSet () const
 
void SetTransitEncryption (const EFSTransitEncryption &value)
 
void SetTransitEncryption (EFSTransitEncryption &&value)
 
EFSVolumeConfigurationWithTransitEncryption (const EFSTransitEncryption &value)
 
EFSVolumeConfigurationWithTransitEncryption (EFSTransitEncryption &&value)
 
int GetTransitEncryptionPort () const
 
bool TransitEncryptionPortHasBeenSet () const
 
void SetTransitEncryptionPort (int value)
 
EFSVolumeConfigurationWithTransitEncryptionPort (int value)
 
const EFSAuthorizationConfigGetAuthorizationConfig () const
 
bool AuthorizationConfigHasBeenSet () const
 
void SetAuthorizationConfig (const EFSAuthorizationConfig &value)
 
void SetAuthorizationConfig (EFSAuthorizationConfig &&value)
 
EFSVolumeConfigurationWithAuthorizationConfig (const EFSAuthorizationConfig &value)
 
EFSVolumeConfigurationWithAuthorizationConfig (EFSAuthorizationConfig &&value)
 

Detailed Description

This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.

See Also:

AWS API Reference

Definition at line 37 of file EFSVolumeConfiguration.h.

Constructor & Destructor Documentation

◆ EFSVolumeConfiguration() [1/2]

Aws::ECS::Model::EFSVolumeConfiguration::EFSVolumeConfiguration ( )

◆ EFSVolumeConfiguration() [2/2]

Aws::ECS::Model::EFSVolumeConfiguration::EFSVolumeConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AuthorizationConfigHasBeenSet()

bool Aws::ECS::Model::EFSVolumeConfiguration::AuthorizationConfigHasBeenSet ( ) const
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 286 of file EFSVolumeConfiguration.h.

◆ FileSystemIdHasBeenSet()

bool Aws::ECS::Model::EFSVolumeConfiguration::FileSystemIdHasBeenSet ( ) const
inline

The Amazon EFS file system ID to use.

Definition at line 54 of file EFSVolumeConfiguration.h.

◆ GetAuthorizationConfig()

const EFSAuthorizationConfig& Aws::ECS::Model::EFSVolumeConfiguration::GetAuthorizationConfig ( ) const
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 281 of file EFSVolumeConfiguration.h.

◆ GetFileSystemId()

const Aws::String& Aws::ECS::Model::EFSVolumeConfiguration::GetFileSystemId ( ) const
inline

The Amazon EFS file system ID to use.

Definition at line 49 of file EFSVolumeConfiguration.h.

◆ GetRootDirectory()

const Aws::String& Aws::ECS::Model::EFSVolumeConfiguration::GetRootDirectory ( ) const
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 96 of file EFSVolumeConfiguration.h.

◆ GetTransitEncryption()

const EFSTransitEncryption& Aws::ECS::Model::EFSVolumeConfiguration::GetTransitEncryption ( ) const
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 184 of file EFSVolumeConfiguration.h.

◆ GetTransitEncryptionPort()

int Aws::ECS::Model::EFSVolumeConfiguration::GetTransitEncryptionPort ( ) const
inline

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

Definition at line 245 of file EFSVolumeConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::EFSVolumeConfiguration::Jsonize ( ) const

◆ operator=()

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RootDirectoryHasBeenSet()

bool Aws::ECS::Model::EFSVolumeConfiguration::RootDirectoryHasBeenSet ( ) const
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 107 of file EFSVolumeConfiguration.h.

◆ SetAuthorizationConfig() [1/2]

void Aws::ECS::Model::EFSVolumeConfiguration::SetAuthorizationConfig ( const EFSAuthorizationConfig value)
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 291 of file EFSVolumeConfiguration.h.

◆ SetAuthorizationConfig() [2/2]

void Aws::ECS::Model::EFSVolumeConfiguration::SetAuthorizationConfig ( EFSAuthorizationConfig &&  value)
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 296 of file EFSVolumeConfiguration.h.

◆ SetFileSystemId() [1/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetFileSystemId ( const Aws::String value)
inline

The Amazon EFS file system ID to use.

Definition at line 59 of file EFSVolumeConfiguration.h.

◆ SetFileSystemId() [2/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetFileSystemId ( Aws::String &&  value)
inline

The Amazon EFS file system ID to use.

Definition at line 64 of file EFSVolumeConfiguration.h.

◆ SetFileSystemId() [3/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetFileSystemId ( const char *  value)
inline

The Amazon EFS file system ID to use.

Definition at line 69 of file EFSVolumeConfiguration.h.

◆ SetRootDirectory() [1/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetRootDirectory ( const Aws::String value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 118 of file EFSVolumeConfiguration.h.

◆ SetRootDirectory() [2/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetRootDirectory ( Aws::String &&  value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 129 of file EFSVolumeConfiguration.h.

◆ SetRootDirectory() [3/3]

void Aws::ECS::Model::EFSVolumeConfiguration::SetRootDirectory ( const char *  value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 140 of file EFSVolumeConfiguration.h.

◆ SetTransitEncryption() [1/2]

void Aws::ECS::Model::EFSVolumeConfiguration::SetTransitEncryption ( const EFSTransitEncryption value)
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 204 of file EFSVolumeConfiguration.h.

◆ SetTransitEncryption() [2/2]

void Aws::ECS::Model::EFSVolumeConfiguration::SetTransitEncryption ( EFSTransitEncryption &&  value)
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 214 of file EFSVolumeConfiguration.h.

◆ SetTransitEncryptionPort()

void Aws::ECS::Model::EFSVolumeConfiguration::SetTransitEncryptionPort ( int  value)
inline

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

Definition at line 265 of file EFSVolumeConfiguration.h.

◆ TransitEncryptionHasBeenSet()

bool Aws::ECS::Model::EFSVolumeConfiguration::TransitEncryptionHasBeenSet ( ) const
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 194 of file EFSVolumeConfiguration.h.

◆ TransitEncryptionPortHasBeenSet()

bool Aws::ECS::Model::EFSVolumeConfiguration::TransitEncryptionPortHasBeenSet ( ) const
inline

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

Definition at line 255 of file EFSVolumeConfiguration.h.

◆ WithAuthorizationConfig() [1/2]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithAuthorizationConfig ( const EFSAuthorizationConfig value)
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 301 of file EFSVolumeConfiguration.h.

◆ WithAuthorizationConfig() [2/2]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithAuthorizationConfig ( EFSAuthorizationConfig &&  value)
inline

The authorization configuration details for the Amazon EFS file system.

Definition at line 306 of file EFSVolumeConfiguration.h.

◆ WithFileSystemId() [1/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithFileSystemId ( const Aws::String value)
inline

The Amazon EFS file system ID to use.

Definition at line 74 of file EFSVolumeConfiguration.h.

◆ WithFileSystemId() [2/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithFileSystemId ( Aws::String &&  value)
inline

The Amazon EFS file system ID to use.

Definition at line 79 of file EFSVolumeConfiguration.h.

◆ WithFileSystemId() [3/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithFileSystemId ( const char *  value)
inline

The Amazon EFS file system ID to use.

Definition at line 84 of file EFSVolumeConfiguration.h.

◆ WithRootDirectory() [1/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithRootDirectory ( const Aws::String value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 151 of file EFSVolumeConfiguration.h.

◆ WithRootDirectory() [2/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithRootDirectory ( Aws::String &&  value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 162 of file EFSVolumeConfiguration.h.

◆ WithRootDirectory() [3/3]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithRootDirectory ( const char *  value)
inline

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Definition at line 173 of file EFSVolumeConfiguration.h.

◆ WithTransitEncryption() [1/2]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithTransitEncryption ( const EFSTransitEncryption value)
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 224 of file EFSVolumeConfiguration.h.

◆ WithTransitEncryption() [2/2]

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithTransitEncryption ( EFSTransitEncryption &&  value)
inline

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.

Definition at line 234 of file EFSVolumeConfiguration.h.

◆ WithTransitEncryptionPort()

EFSVolumeConfiguration& Aws::ECS::Model::EFSVolumeConfiguration::WithTransitEncryptionPort ( int  value)
inline

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

Definition at line 275 of file EFSVolumeConfiguration.h.


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