NAME
Paws::EFS::CreateFileSystem - Arguments for method CreateFileSystem on Paws::EFS
DESCRIPTION
This class represents the parameters used for calling the method CreateFileSystem on the Amazon Elastic File System service. Use the attributes of this class as arguments to method CreateFileSystem.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFileSystem.
SYNOPSIS
my $elasticfilesystem = Paws->service('EFS');
# To create a new file system
# This operation creates a new file system with the default generalpurpose
# performance mode.
my $FileSystemDescription = $elasticfilesystem->CreateFileSystem(
'CreationToken' => 'tokenstring',
'PerformanceMode' => 'generalPurpose',
'Tags' => [
{
'Key' => 'Name',
'Value' => 'MyFileSystem'
}
]
);
# Results:
my $CreationTime = $FileSystemDescription->CreationTime;
my $CreationToken = $FileSystemDescription->CreationToken;
my $FileSystemId = $FileSystemDescription->FileSystemId;
my $LifeCycleState = $FileSystemDescription->LifeCycleState;
my $NumberOfMountTargets = $FileSystemDescription->NumberOfMountTargets;
my $OwnerId = $FileSystemDescription->OwnerId;
my $PerformanceMode = $FileSystemDescription->PerformanceMode;
my $SizeInBytes = $FileSystemDescription->SizeInBytes;
my $Tags = $FileSystemDescription->Tags;
# Returns a L<Paws::EFS::FileSystemDescription> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem/CreateFileSystem
ATTRIBUTES
AvailabilityZoneName => Str
Used to create a file system that uses One Zone storage classes. It specifies the AWS 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 (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon EFS User Guide.
One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.
Backup => Bool
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 (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups) in the Amazon EFS User Guide.
Default is false. However, if you specify an AvailabilityZoneName, the default is true.
AWS Backup is not available in all AWS Regions where Amazon EFS is available.
REQUIRED CreationToken => Str
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
Encrypted => Bool
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.
KmsKeyId => Str
The ID of the AWS 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.
PerformanceMode => Str
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.
Valid values are: "generalPurpose", "maxIO"
ProvisionedThroughputInMibps => Num
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 AWS Support. For more information, see Amazon EFS quotas that you can increase (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the Amazon EFS User Guide.
Tags => ArrayRef[Paws::EFS::Tag]
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.
ThroughputMode => Str
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 (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the Amazon EFS User Guide.
Default is bursting.
Valid values are: "bursting", "provisioned"
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateFileSystem in Paws::EFS
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues