Class: Aws::EFS::Types::CreateFileSystemRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-efs/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_name ⇒ String

For One Zone file systems, specify the Amazon Web Services Availability Zone in which to create the file system. Use the format ‘us-east-1a` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types] in the *Amazon EFS User Guide*.

<note markdown=“1”> One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.

</note>

[1]: docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#backup ⇒ Boolean

Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to ‘true` to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see [Automatic backups] in the *Amazon EFS User Guide*.

Default is ‘false`. However, if you specify an `AvailabilityZoneName`, the default is `true`.

<note markdown=“1”> Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.

</note>

[1]: docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups

Returns:

  • (Boolean) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don’t specify a KMS key, then the default KMS key for Amazon EFS, ‘/aws/elasticfilesystem`, is used to protect the encrypted file system.

Returns:

  • (Boolean) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:

  • Key ID - A unique identifier of the key, for example ‘1234abcd-12ab-34cd-56ef-1234567890ab`.

  • ARN - An Amazon Resource Name (ARN) for the key, for example ‘arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.

  • Key alias - A previously created display name for a key, for example ‘alias/projectKey1`.

  • Key alias ARN - An ARN for a key alias, for example ‘arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.

If you use ‘KmsKeyId`, you must set the CreateFileSystemRequest$Encrypted parameter to true.

EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#performance_mode ⇒ String

The performance mode of the file system. We recommend ‘generalPurpose` performance mode for all file systems. File systems using the `maxIO` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can’t be changed after the file system has been created. The ‘maxIO` mode is not supported on One Zone file systems.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

Default is ‘generalPurpose`.

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_in_mibps ⇒ Float

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you’re creating. Required if ‘ThroughputMode` is set to `provisioned`. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see [Amazon EFS quotas that you can increase] in the *Amazon EFS User Guide*.

[1]: docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits

Returns:

  • (Float) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_mode ⇒ String

Specifies the throughput mode for the file system. The mode can be ‘bursting`, `provisioned`, or `elastic`. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`. After you create the file system, you can decrease your file system’s Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode] in the *Amazon EFS User Guide*.

Default is ‘bursting`.

[1]: docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aws-sdk-efs/types.rb', line 508

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps,
  :availability_zone_name,
  :backup,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end