Skip to content

Efs Classes

AccessPointDescription

ClientToken

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]]

AccessPointId

  • Type: typing.Optional[str]

AccessPointArn

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

PosixUser

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PosixUserOutput]

RootDirectory

  • Type:

OwnerId

  • Type: typing.Optional[str]

LifeCycleState

  • Type: typing.Optional[typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']]

AccessPointDescriptionResponse

ClientToken

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

AccessPointId

  • Type:
  • Required: Yes

AccessPointArn

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

PosixUser

  • Type:
  • Required: Yes

RootDirectory

  • Type:
  • Required: Yes

OwnerId

  • Type:
  • Required: Yes

LifeCycleState

  • Type: typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BackupPolicy

Status

  • Type: typing.Literal['DISABLED', 'DISABLING', 'ENABLED', 'ENABLING']
  • Required: Yes

BackupPolicyDescription

BackupPolicy

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreateAccessPointRequest

ClientToken

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]]

PosixUser

  • Type: typing.Union[aws_resource_validator.pydantic_models.efs.efs_classes.PosixUser, aws_resource_validator.pydantic_models.efs.efs_classes.PosixUserOutput, NoneType]

RootDirectory

  • Type:

CreateFileSystemRequest

CreationToken

  • Type:
  • Required: Yes

PerformanceMode

  • Type: typing.Optional[typing.Literal['generalPurpose', 'maxIO']]

Encrypted

  • Type: typing.Optional[bool]

KmsKeyId

  • Type: typing.Optional[str]

ThroughputMode

  • Type: typing.Optional[typing.Literal['bursting', 'elastic', 'provisioned']]

ProvisionedThroughputInMibps

  • Type: typing.Optional[float]

AvailabilityZoneName

  • Type: typing.Optional[str]

Backup

  • Type: typing.Optional[bool]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]]

CreateMountTargetRequest

FileSystemId

  • Type:
  • Required: Yes

SubnetId

  • Type:
  • Required: Yes

IpAddress

  • Type: typing.Optional[str]

SecurityGroups

  • Type: typing.Optional[typing.List[str]]

CreateReplicationConfigurationRequest

SourceFileSystemId

  • Type:
  • Required: Yes

Destinations

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.DestinationToCreate]
  • Required: Yes

CreateTagsRequest

FileSystemId

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

CreationInfo

OwnerUid

  • Type:
  • Required: Yes

OwnerGid

  • Type:
  • Required: Yes

Permissions

  • Type:
  • Required: Yes

DeleteAccessPointRequest

AccessPointId

  • Type:
  • Required: Yes

DeleteFileSystemPolicyRequest

FileSystemId

  • Type:
  • Required: Yes

DeleteFileSystemRequest

FileSystemId

  • Type:
  • Required: Yes

DeleteMountTargetRequest

MountTargetId

  • Type:
  • Required: Yes

DeleteReplicationConfigurationRequest

SourceFileSystemId

  • Type:
  • Required: Yes

DeletionMode

  • Type: typing.Optional[typing.Literal['ALL_CONFIGURATIONS', 'LOCAL_CONFIGURATION_ONLY']]

DeleteTagsRequest

FileSystemId

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

DescribeAccessPointsRequest

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

AccessPointId

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

DescribeAccessPointsRequestPaginate

AccessPointId

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PaginatorConfig]

DescribeAccessPointsResponse

AccessPoints

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.AccessPointDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

DescribeAccountPreferencesRequest

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

DescribeAccountPreferencesResponse

ResourceIdPreference

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

DescribeBackupPolicyRequest

FileSystemId

  • Type:
  • Required: Yes

DescribeFileSystemPolicyRequest

FileSystemId

  • Type:
  • Required: Yes

DescribeFileSystemsRequest

MaxItems

  • Type: typing.Optional[int]

Marker

  • Type: typing.Optional[str]

CreationToken

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

DescribeFileSystemsRequestPaginate

CreationToken

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PaginatorConfig]

DescribeFileSystemsResponse

Marker

  • Type:
  • Required: Yes

FileSystems

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.FileSystemDescription]
  • Required: Yes

NextMarker

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeLifecycleConfigurationRequest

FileSystemId

  • Type:
  • Required: Yes

DescribeMountTargetSecurityGroupsRequest

MountTargetId

  • Type:
  • Required: Yes

DescribeMountTargetSecurityGroupsResponse

SecurityGroups

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeMountTargetsRequest

MaxItems

  • Type: typing.Optional[int]

Marker

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

MountTargetId

  • Type: typing.Optional[str]

AccessPointId

  • Type: typing.Optional[str]

DescribeMountTargetsRequestPaginate

FileSystemId

  • Type: typing.Optional[str]

MountTargetId

  • Type: typing.Optional[str]

AccessPointId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PaginatorConfig]

DescribeMountTargetsResponse

Marker

  • Type:
  • Required: Yes

MountTargets

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.MountTargetDescription]
  • Required: Yes

NextMarker

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeReplicationConfigurationsRequest

FileSystemId

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

DescribeReplicationConfigurationsRequestPaginate

FileSystemId

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PaginatorConfig]

DescribeReplicationConfigurationsResponse

Replications

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.ReplicationConfigurationDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

DescribeTagsRequest

FileSystemId

  • Type:
  • Required: Yes

MaxItems

  • Type: typing.Optional[int]

Marker

  • Type: typing.Optional[str]

DescribeTagsRequestPaginate

FileSystemId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.PaginatorConfig]

DescribeTagsResponse

Marker

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

NextMarker

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Destination

Status

  • Type: typing.Literal['DELETING', 'ENABLED', 'ENABLING', 'ERROR', 'PAUSED', 'PAUSING']
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

Region

  • Type:
  • Required: Yes

LastReplicatedTimestamp

  • Type: typing.Optional[datetime.datetime]

OwnerId

  • Type: typing.Optional[str]

StatusMessage

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

DestinationToCreate

Region

  • Type: typing.Optional[str]

AvailabilityZoneName

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

FileSystemId

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

FileSystemDescription

OwnerId

  • Type:
  • Required: Yes

CreationToken

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LifeCycleState

  • Type: typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']
  • Required: Yes

NumberOfMountTargets

  • Type:
  • Required: Yes

SizeInBytes

  • Type:
  • Required: Yes

PerformanceMode

  • Type: typing.Literal['generalPurpose', 'maxIO']
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

FileSystemArn

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Encrypted

  • Type: typing.Optional[bool]

KmsKeyId

  • Type: typing.Optional[str]

ThroughputMode

  • Type: typing.Optional[typing.Literal['bursting', 'elastic', 'provisioned']]

ProvisionedThroughputInMibps

  • Type: typing.Optional[float]

AvailabilityZoneName

  • Type: typing.Optional[str]

AvailabilityZoneId

  • Type: typing.Optional[str]

FileSystemProtection

  • Type: typing.Optional[aws_resource_validator.pydantic_models.efs.efs_classes.FileSystemProtectionDescription]

FileSystemDescriptionResponse

OwnerId

  • Type:
  • Required: Yes

CreationToken

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

FileSystemArn

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LifeCycleState

  • Type: typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']
  • Required: Yes

Name

  • Type:
  • Required: Yes

NumberOfMountTargets

  • Type:
  • Required: Yes

SizeInBytes

  • Type:
  • Required: Yes

PerformanceMode

  • Type: typing.Literal['generalPurpose', 'maxIO']
  • Required: Yes

Encrypted

  • Type:
  • Required: Yes

KmsKeyId

  • Type:
  • Required: Yes

ThroughputMode

  • Type: typing.Literal['bursting', 'elastic', 'provisioned']
  • Required: Yes

ProvisionedThroughputInMibps

  • Type:
  • Required: Yes

AvailabilityZoneName

  • Type:
  • Required: Yes

AvailabilityZoneId

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

FileSystemProtection

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

FileSystemPolicyDescription

FileSystemId

  • Type:
  • Required: Yes

Policy

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

FileSystemProtectionDescription

ReplicationOverwriteProtection

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED', 'REPLICATING']]

FileSystemProtectionDescriptionResponse

ReplicationOverwriteProtection

  • Type: typing.Literal['DISABLED', 'ENABLED', 'REPLICATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

FileSystemSize

Value

  • Type:
  • Required: Yes

Timestamp

  • Type: typing.Optional[datetime.datetime]

ValueInIA

  • Type: typing.Optional[int]

ValueInStandard

  • Type: typing.Optional[int]

ValueInArchive

  • Type: typing.Optional[int]

LifecycleConfigurationDescription

LifecyclePolicies

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.LifecyclePolicy]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LifecyclePolicy

TransitionToIA

  • Type: typing.Optional[typing.Literal['AFTER_14_DAYS', 'AFTER_180_DAYS', 'AFTER_1_DAY', 'AFTER_270_DAYS', 'AFTER_30_DAYS', 'AFTER_365_DAYS', 'AFTER_60_DAYS', 'AFTER_7_DAYS', 'AFTER_90_DAYS']]

TransitionToPrimaryStorageClass

  • Type: typing.Optional[typing.Literal['AFTER_1_ACCESS']]

TransitionToArchive

  • Type: typing.Optional[typing.Literal['AFTER_14_DAYS', 'AFTER_180_DAYS', 'AFTER_1_DAY', 'AFTER_270_DAYS', 'AFTER_30_DAYS', 'AFTER_365_DAYS', 'AFTER_60_DAYS', 'AFTER_7_DAYS', 'AFTER_90_DAYS']]

ListTagsForResourceRequest

ResourceId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceResponse

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ModifyMountTargetSecurityGroupsRequest

MountTargetId

  • Type:
  • Required: Yes

SecurityGroups

  • Type: typing.Optional[typing.List[str]]

MountTargetDescription

MountTargetId

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

SubnetId

  • Type:
  • Required: Yes

LifeCycleState

  • Type: typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']
  • Required: Yes

OwnerId

  • Type: typing.Optional[str]

IpAddress

  • Type: typing.Optional[str]

NetworkInterfaceId

  • Type: typing.Optional[str]

AvailabilityZoneId

  • Type: typing.Optional[str]

AvailabilityZoneName

  • Type: typing.Optional[str]

VpcId

  • Type: typing.Optional[str]

MountTargetDescriptionResponse

OwnerId

  • Type:
  • Required: Yes

MountTargetId

  • Type:
  • Required: Yes

FileSystemId

  • Type:
  • Required: Yes

SubnetId

  • Type:
  • Required: Yes

LifeCycleState

  • Type: typing.Literal['available', 'creating', 'deleted', 'deleting', 'error', 'updating']
  • Required: Yes

IpAddress

  • Type:
  • Required: Yes

NetworkInterfaceId

  • Type:
  • Required: Yes

AvailabilityZoneId

  • Type:
  • Required: Yes

AvailabilityZoneName

  • Type:
  • Required: Yes

VpcId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PosixUser

Uid

  • Type:
  • Required: Yes

Gid

  • Type:
  • Required: Yes

SecondaryGids

  • Type: typing.Optional[typing.List[int]]

PosixUserOutput

Uid

  • Type:
  • Required: Yes

Gid

  • Type:
  • Required: Yes

SecondaryGids

  • Type: typing.Optional[typing.List[int]]

PutAccountPreferencesRequest

ResourceIdType

  • Type: typing.Literal['LONG_ID', 'SHORT_ID']
  • Required: Yes

PutAccountPreferencesResponse

ResourceIdPreference

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutBackupPolicyRequest

FileSystemId

  • Type:
  • Required: Yes

BackupPolicy

  • Type:
  • Required: Yes

PutFileSystemPolicyRequest

FileSystemId

  • Type:
  • Required: Yes

Policy

  • Type:
  • Required: Yes

BypassPolicyLockoutSafetyCheck

  • Type: typing.Optional[bool]

PutLifecycleConfigurationRequest

FileSystemId

  • Type:
  • Required: Yes

LifecyclePolicies

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.LifecyclePolicy]
  • Required: Yes

ReplicationConfigurationDescription

SourceFileSystemId

  • Type:
  • Required: Yes

SourceFileSystemRegion

  • Type:
  • Required: Yes

SourceFileSystemArn

  • Type:
  • Required: Yes

OriginalSourceFileSystemArn

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

Destinations

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Destination]
  • Required: Yes

SourceFileSystemOwnerId

  • Type: typing.Optional[str]

ReplicationConfigurationDescriptionResponse

SourceFileSystemId

  • Type:
  • Required: Yes

SourceFileSystemRegion

  • Type:
  • Required: Yes

SourceFileSystemArn

  • Type:
  • Required: Yes

OriginalSourceFileSystemArn

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

Destinations

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Destination]
  • Required: Yes

SourceFileSystemOwnerId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResourceIdPreference

ResourceIdType

  • Type: typing.Optional[typing.Literal['LONG_ID', 'SHORT_ID']]

Resources

  • Type: typing.Optional[typing.List[typing.Literal['FILE_SYSTEM', 'MOUNT_TARGET']]]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RootDirectory

Path

  • Type: typing.Optional[str]

CreationInfo

  • Type:

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TagResourceRequest

ResourceId

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.efs.efs_classes.Tag]
  • Required: Yes

UntagResourceRequest

ResourceId

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateFileSystemProtectionRequest

FileSystemId

  • Type:
  • Required: Yes

ReplicationOverwriteProtection

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED', 'REPLICATING']]

UpdateFileSystemRequest

FileSystemId

  • Type:
  • Required: Yes

ThroughputMode

  • Type: typing.Optional[typing.Literal['bursting', 'elastic', 'provisioned']]

ProvisionedThroughputInMibps

  • Type: typing.Optional[float]