You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateFileSystemRequest data as a hash:

{
  creation_token: "CreationToken", # required
  performance_mode: "generalPurpose", # accepts generalPurpose, maxIO
  encrypted: false,
  kms_key_id: "KmsKeyId",
  throughput_mode: "bursting", # accepts bursting, provisioned
  provisioned_throughput_in_mibps: 1.0,
}

Instance Attribute Summary collapse

Instance Attribute Details

#creation_tokenString

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

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#encryptedBoolean

A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a 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.

Returns:

  • (Boolean)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#kms_key_idString

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 non-default 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.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#performance_modeString

The PerformanceMode 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. This can't be changed after the file system has been created.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#provisioned_throughput_in_mibpsFloat

The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Returns:

  • (Float)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#throughput_modeString

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

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 93

class CreateFileSystemRequest < Struct.new(
  :creation_token,
  :performance_mode,
  :encrypted,
  :kms_key_id,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end