types

package
v1.17.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 4 Imported by: 21

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPointAlreadyExists 

type AccessPointAlreadyExists struct {
	Message *string

	ErrorCode_    *string
	AccessPointId *string
	// contains filtered or unexported fields
}

Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.

func (*AccessPointAlreadyExists) Error 

func (e *AccessPointAlreadyExists) Error() string

func (*AccessPointAlreadyExists) ErrorCode 

func (e *AccessPointAlreadyExists) ErrorCode() string

func (*AccessPointAlreadyExists) ErrorFault 

func (e *AccessPointAlreadyExists) ErrorFault() smithy.ErrorFault

func (*AccessPointAlreadyExists) ErrorMessage 

func (e *AccessPointAlreadyExists) ErrorMessage() string

type AccessPointDescription 

type AccessPointDescription struct {

	// The unique Amazon Resource Name (ARN) associated with the access point.
	AccessPointArn *string

	// The ID of the access point, assigned by Amazon EFS.
	AccessPointId *string

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string

	// The ID of the EFS file system that the access point applies to.
	FileSystemId *string

	// Identifies the lifecycle phase of the access point.
	LifeCycleState LifeCycleState

	// The name of the access point. This is the value of the Name tag.
	Name *string

	// Identified the Amazon Web Services account that owns the access point resource.
	OwnerId *string

	// The full POSIX identity, including the user ID, group ID, and secondary group
	// IDs on the access point that is used for all file operations by NFS clients
	// using the access point.
	PosixUser *PosixUser

	// The directory on the Amazon EFS file system that the access point exposes as the
	// root directory to NFS clients using the access point.
	RootDirectory *RootDirectory

	// The tags associated with the access point, presented as an array of Tag objects.
	Tags []Tag
	// contains filtered or unexported fields
}

Provides a description of an EFS file system access point.

type AccessPointLimitExceeded 

type AccessPointLimitExceeded struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).

func (*AccessPointLimitExceeded) Error 

func (e *AccessPointLimitExceeded) Error() string

func (*AccessPointLimitExceeded) ErrorCode 

func (e *AccessPointLimitExceeded) ErrorCode() string

func (*AccessPointLimitExceeded) ErrorFault 

func (e *AccessPointLimitExceeded) ErrorFault() smithy.ErrorFault

func (*AccessPointLimitExceeded) ErrorMessage 

func (e *AccessPointLimitExceeded) ErrorMessage() string

type AccessPointNotFound 

type AccessPointNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

func (*AccessPointNotFound) Error 

func (e *AccessPointNotFound) Error() string

func (*AccessPointNotFound) ErrorCode 

func (e *AccessPointNotFound) ErrorCode() string

func (*AccessPointNotFound) ErrorFault 

func (e *AccessPointNotFound) ErrorFault() smithy.ErrorFault

func (*AccessPointNotFound) ErrorMessage 

func (e *AccessPointNotFound) ErrorMessage() string

type AvailabilityZonesMismatch added in v1.2.0 

type AvailabilityZonesMismatch struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html).

func (*AvailabilityZonesMismatch) Error added in v1.2.0 

func (e *AvailabilityZonesMismatch) Error() string

func (*AvailabilityZonesMismatch) ErrorCode added in v1.2.0 

func (e *AvailabilityZonesMismatch) ErrorCode() string

func (*AvailabilityZonesMismatch) ErrorFault added in v1.2.0 

func (e *AvailabilityZonesMismatch) ErrorFault() smithy.ErrorFault

func (*AvailabilityZonesMismatch) ErrorMessage added in v1.2.0 

func (e *AvailabilityZonesMismatch) ErrorMessage() string

type BackupPolicy 

type BackupPolicy struct {

	// Describes the status of the file system's backup policy.
	//
	// * ENABLED - EFS is
	// automatically backing up the file system.
	//
	// * ENABLING - EFS is turning on
	// automatic backups for the file system.
	//
	// * DISABLED - Automatic back ups are
	// turned off for the file system.
	//
	// * DISABLING - EFS is turning off automatic
	// backups for the file system.
	//
	// This member is required.
	Status Status
	// contains filtered or unexported fields
}

The backup policy for the file system used to create automatic daily backups. If status has a value of ENABLED, the file system is being automatically backed up. For more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups).

type BadRequest 

type BadRequest struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

func (*BadRequest) Error 

func (e *BadRequest) Error() string

func (*BadRequest) ErrorCode 

func (e *BadRequest) ErrorCode() string

func (*BadRequest) ErrorFault 

func (e *BadRequest) ErrorFault() smithy.ErrorFault

func (*BadRequest) ErrorMessage 

func (e *BadRequest) ErrorMessage() string

type CreationInfo 

type CreationInfo struct {

	// Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from
	// 0 to 2^32 (4294967295).
	//
	// This member is required.
	OwnerGid *int64

	// Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0
	// to 2^32 (4294967295).
	//
	// This member is required.
	OwnerUid *int64

	// Specifies the POSIX permissions to apply to the RootDirectory, in the format of
	// an octal number representing the file's mode bits.
	//
	// This member is required.
	Permissions *string
	// contains filtered or unexported fields
}

Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo, you must include values for all properties. Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail. If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.

type DependencyTimeout 

type DependencyTimeout struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The service timed out trying to fulfill the request, and the client should try the call again.

func (*DependencyTimeout) Error 

func (e *DependencyTimeout) Error() string

func (*DependencyTimeout) ErrorCode 

func (e *DependencyTimeout) ErrorCode() string

func (*DependencyTimeout) ErrorFault 

func (e *DependencyTimeout) ErrorFault() smithy.ErrorFault

func (*DependencyTimeout) ErrorMessage 

func (e *DependencyTimeout) ErrorMessage() string

type Destination added in v1.14.0 

type Destination struct {

	// The ID of the destination Amazon EFS file system.
	//
	// This member is required.
	FileSystemId *string

	// The Amazon Web Services Region in which the destination file system is located.
	//
	// This member is required.
	Region *string

	// Describes the status of the destination Amazon EFS file system. If the status is
	// ERROR, the destination file system in the replication configuration is in a
	// failed state and is unrecoverable. To access the file system data, restore a
	// backup of the failed file system to a new file system.
	//
	// This member is required.
	Status ReplicationStatus

	// The time when the most recent sync was successfully completed on the destination
	// file system. Any changes to data on the source file system that occurred before
	// this time have been successfully replicated to the destination file system. Any
	// changes that occurred after this time might not be fully replicated.
	LastReplicatedTimestamp *time.Time
	// contains filtered or unexported fields
}

Describes the destination file system in the replication configuration.

type DestinationToCreate added in v1.14.0 

type DestinationToCreate struct {

	// To create a file system that uses EFS One Zone storage, specify the name of the
	// Availability Zone in which to create the destination file system.
	AvailabilityZoneName *string

	// Specifies the Key Management Service (KMS) key that you want to use to encrypt
	// the destination file system. If you do not specify a KMS key, Amazon EFS uses
	// your default KMS key for Amazon EFS, /aws/elasticfilesystem. This ID can be in
	// one of the following formats:
	//
	// * Key ID - The unique identifier of the key, for
	// example 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// * ARN - The 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 - The ARN for a key alias, for example
	// arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
	KmsKeyId *string

	// To create a file system that uses Regional storage, specify the Amazon Web
	// Services Region in which to create the destination file system.
	Region *string
	// contains filtered or unexported fields
}

Describes the destination file system to create in the replication configuration.

type FileSystemAlreadyExists 

type FileSystemAlreadyExists struct {
	Message *string

	ErrorCode_   *string
	FileSystemId *string
	// contains filtered or unexported fields
}

Returned if the file system you are trying to create already exists, with the creation token you provided.

func (*FileSystemAlreadyExists) Error 

func (e *FileSystemAlreadyExists) Error() string

func (*FileSystemAlreadyExists) ErrorCode 

func (e *FileSystemAlreadyExists) ErrorCode() string

func (*FileSystemAlreadyExists) ErrorFault 

func (e *FileSystemAlreadyExists) ErrorFault() smithy.ErrorFault

func (*FileSystemAlreadyExists) ErrorMessage 

func (e *FileSystemAlreadyExists) ErrorMessage() string

type FileSystemDescription 

type FileSystemDescription struct {

	// The time that the file system was created, in seconds (since
	// 1970-01-01T00:00:00Z).
	//
	// This member is required.
	CreationTime *time.Time

	// The opaque string specified in the request.
	//
	// This member is required.
	CreationToken *string

	// The ID of the file system, assigned by Amazon EFS.
	//
	// This member is required.
	FileSystemId *string

	// The lifecycle phase of the file system.
	//
	// This member is required.
	LifeCycleState LifeCycleState

	// The current number of mount targets that the file system has. For more
	// information, see CreateMountTarget.
	//
	// This member is required.
	NumberOfMountTargets int32

	// The Amazon Web Services account that created the file system. If the file system
	// was created by an IAM user, the parent account to which the user belongs is the
	// owner.
	//
	// This member is required.
	OwnerId *string

	// The performance mode of the file system.
	//
	// This member is required.
	PerformanceMode PerformanceMode

	// The latest known metered size (in bytes) of data stored in the file system, in
	// its Value field, and the time at which that size was determined in its Timestamp
	// field. The Timestamp value is the integer number of seconds since
	// 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a
	// consistent snapshot of the file system, but it is eventually consistent when
	// there are no writes to the file system. That is, SizeInBytes represents actual
	// size only if the file system is not modified for a period longer than a couple
	// of hours. Otherwise, the value is not the exact size that the file system was at
	// any point in time.
	//
	// This member is required.
	SizeInBytes *FileSystemSize

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// This member is required.
	Tags []Tag

	// The unique and consistent identifier of the Availability Zone in which the file
	// system's One Zone storage classes exist. For example, use1-az1 is an
	// Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has
	// the same location in every Amazon Web Services account.
	AvailabilityZoneId *string

	// Describes the Amazon Web Services Availability Zone in which the file system is
	// located, and is valid only for file systems using One Zone storage classes. For
	// more information, see Using EFS storage classes
	// (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon
	// EFS User Guide.
	AvailabilityZoneName *string

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool

	// The Amazon Resource Name (ARN) for the EFS file system, in the format
	// arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example
	// with sample data:
	// arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
	FileSystemArn *string

	// The ID of an KMS key used to protect the encrypted file system.
	KmsKeyId *string

	// You can add tags to a file system, including a Name tag. For more information,
	// see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the
	// value in this field.
	Name *string

	// The amount of provisioned throughput, measured in MiB/s, for the file system.
	// Valid for file systems using ThroughputMode set to provisioned.
	ProvisionedThroughputInMibps *float64

	// Displays the file system's throughput mode. For more information, see Throughput
	// modes
	// (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) in
	// the Amazon EFS User Guide.
	ThroughputMode ThroughputMode
	// contains filtered or unexported fields
}

A description of the file system.

type FileSystemInUse 

type FileSystemInUse struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if a file system has mount targets.

func (*FileSystemInUse) Error 

func (e *FileSystemInUse) Error() string

func (*FileSystemInUse) ErrorCode 

func (e *FileSystemInUse) ErrorCode() string

func (*FileSystemInUse) ErrorFault 

func (e *FileSystemInUse) ErrorFault() smithy.ErrorFault

func (*FileSystemInUse) ErrorMessage 

func (e *FileSystemInUse) ErrorMessage() string

type FileSystemLimitExceeded 

type FileSystemLimitExceeded struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

func (*FileSystemLimitExceeded) Error 

func (e *FileSystemLimitExceeded) Error() string

func (*FileSystemLimitExceeded) ErrorCode 

func (e *FileSystemLimitExceeded) ErrorCode() string

func (*FileSystemLimitExceeded) ErrorFault 

func (e *FileSystemLimitExceeded) ErrorFault() smithy.ErrorFault

func (*FileSystemLimitExceeded) ErrorMessage 

func (e *FileSystemLimitExceeded) ErrorMessage() string

type FileSystemNotFound 

type FileSystemNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

func (*FileSystemNotFound) Error 

func (e *FileSystemNotFound) Error() string

func (*FileSystemNotFound) ErrorCode 

func (e *FileSystemNotFound) ErrorCode() string

func (*FileSystemNotFound) ErrorFault 

func (e *FileSystemNotFound) ErrorFault() smithy.ErrorFault

func (*FileSystemNotFound) ErrorMessage 

func (e *FileSystemNotFound) ErrorMessage() string

type FileSystemSize 

type FileSystemSize struct {

	// The latest known metered size (in bytes) of data stored in the file system.
	//
	// This member is required.
	Value int64

	// The time at which the size of data, returned in the Value field, was determined.
	// The value is the integer number of seconds since 1970-01-01T00:00:00Z.
	Timestamp *time.Time

	// The latest known metered size (in bytes) of data stored in the Infrequent Access
	// storage class.
	ValueInIA *int64

	// The latest known metered size (in bytes) of data stored in the Standard storage
	// class.
	ValueInStandard *int64
	// contains filtered or unexported fields
}

The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

type IncorrectFileSystemLifeCycleState 

type IncorrectFileSystemLifeCycleState struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the file system's lifecycle state is not "available".

func (*IncorrectFileSystemLifeCycleState) Error 

func (e *IncorrectFileSystemLifeCycleState) Error() string

func (*IncorrectFileSystemLifeCycleState) ErrorCode 

func (e *IncorrectFileSystemLifeCycleState) ErrorCode() string

func (*IncorrectFileSystemLifeCycleState) ErrorFault 

func (e *IncorrectFileSystemLifeCycleState) ErrorFault() smithy.ErrorFault

func (*IncorrectFileSystemLifeCycleState) ErrorMessage 

func (e *IncorrectFileSystemLifeCycleState) ErrorMessage() string

type IncorrectMountTargetState 

type IncorrectMountTargetState struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the mount target is not in the correct state for the operation.

func (*IncorrectMountTargetState) Error 

func (e *IncorrectMountTargetState) Error() string

func (*IncorrectMountTargetState) ErrorCode 

func (e *IncorrectMountTargetState) ErrorCode() string

func (*IncorrectMountTargetState) ErrorFault 

func (e *IncorrectMountTargetState) ErrorFault() smithy.ErrorFault

func (*IncorrectMountTargetState) ErrorMessage 

func (e *IncorrectMountTargetState) ErrorMessage() string

type InsufficientThroughputCapacity 

type InsufficientThroughputCapacity struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

func (*InsufficientThroughputCapacity) Error 

func (e *InsufficientThroughputCapacity) Error() string

func (*InsufficientThroughputCapacity) ErrorCode 

func (e *InsufficientThroughputCapacity) ErrorCode() string

func (*InsufficientThroughputCapacity) ErrorFault 

func (e *InsufficientThroughputCapacity) ErrorFault() smithy.ErrorFault

func (*InsufficientThroughputCapacity) ErrorMessage 

func (e *InsufficientThroughputCapacity) ErrorMessage() string

type InternalServerError 

type InternalServerError struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if an error occurred on the server side.

func (*InternalServerError) Error 

func (e *InternalServerError) Error() string

func (*InternalServerError) ErrorCode 

func (e *InternalServerError) ErrorCode() string

func (*InternalServerError) ErrorFault 

func (e *InternalServerError) ErrorFault() smithy.ErrorFault

func (*InternalServerError) ErrorMessage 

func (e *InternalServerError) ErrorMessage() string

type InvalidPolicyException 

type InvalidPolicyException struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.

func (*InvalidPolicyException) Error 

func (e *InvalidPolicyException) Error() string

func (*InvalidPolicyException) ErrorCode 

func (e *InvalidPolicyException) ErrorCode() string

func (*InvalidPolicyException) ErrorFault 

func (e *InvalidPolicyException) ErrorFault() smithy.ErrorFault

func (*InvalidPolicyException) ErrorMessage 

func (e *InvalidPolicyException) ErrorMessage() string

type IpAddressInUse 

type IpAddressInUse struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the request specified an IpAddress that is already in use in the subnet.

func (*IpAddressInUse) Error 

func (e *IpAddressInUse) Error() string

func (*IpAddressInUse) ErrorCode 

func (e *IpAddressInUse) ErrorCode() string

func (*IpAddressInUse) ErrorFault 

func (e *IpAddressInUse) ErrorFault() smithy.ErrorFault

func (*IpAddressInUse) ErrorMessage 

func (e *IpAddressInUse) ErrorMessage() string

type LifeCycleState 

type LifeCycleState string
const (
	LifeCycleStateCreating  LifeCycleState = "creating"
	LifeCycleStateAvailable LifeCycleState = "available"
	LifeCycleStateUpdating  LifeCycleState = "updating"
	LifeCycleStateDeleting  LifeCycleState = "deleting"
	LifeCycleStateDeleted   LifeCycleState = "deleted"
	LifeCycleStateError     LifeCycleState = "error"
)

Enum values for LifeCycleState

func (LifeCycleState) Values added in v0.29.0 

func (LifeCycleState) Values() []LifeCycleState

Values returns all known values for LifeCycleState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LifecyclePolicy 

type LifecyclePolicy struct {

	// Describes the period of time that a file is not accessed, after which it
	// transitions to IA storage. Metadata operations such as listing the contents of a
	// directory don't count as file access events.
	TransitionToIA TransitionToIARules

	// Describes when to transition a file from IA storage to primary storage. Metadata
	// operations such as listing the contents of a directory don't count as file
	// access events.
	TransitionToPrimaryStorageClass TransitionToPrimaryStorageClassRules
	// contains filtered or unexported fields
}

Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html). When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. For more information, see the request examples in PutLifecycleConfiguration.

type MountTargetConflict 

type MountTargetConflict struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

func (*MountTargetConflict) Error 

func (e *MountTargetConflict) Error() string

func (*MountTargetConflict) ErrorCode 

func (e *MountTargetConflict) ErrorCode() string

func (*MountTargetConflict) ErrorFault 

func (e *MountTargetConflict) ErrorFault() smithy.ErrorFault

func (*MountTargetConflict) ErrorMessage 

func (e *MountTargetConflict) ErrorMessage() string

type MountTargetDescription 

type MountTargetDescription struct {

	// The ID of the file system for which the mount target is intended.
	//
	// This member is required.
	FileSystemId *string

	// Lifecycle state of the mount target.
	//
	// This member is required.
	LifeCycleState LifeCycleState

	// System-assigned mount target ID.
	//
	// This member is required.
	MountTargetId *string

	// The ID of the mount target's subnet.
	//
	// This member is required.
	SubnetId *string

	// The unique and consistent identifier of the Availability Zone that the mount
	// target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region
	// and it has the same location in every Amazon Web Services account.
	AvailabilityZoneId *string

	// The name of the Availability Zone in which the mount target is located.
	// Availability Zones are independently mapped to names for each Amazon Web
	// Services account. For example, the Availability Zone us-east-1a for your Amazon
	// Web Services account might not be the same location as us-east-1a for another
	// Amazon Web Services account.
	AvailabilityZoneName *string

	// Address at which the file system can be mounted by using the mount target.
	IpAddress *string

	// The ID of the network interface that Amazon EFS created when it created the
	// mount target.
	NetworkInterfaceId *string

	// Amazon Web Services account ID that owns the resource.
	OwnerId *string

	// The virtual private cloud (VPC) ID that the mount target is configured in.
	VpcId *string
	// contains filtered or unexported fields
}

Provides a description of a mount target.

type MountTargetNotFound 

type MountTargetNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.

func (*MountTargetNotFound) Error 

func (e *MountTargetNotFound) Error() string

func (*MountTargetNotFound) ErrorCode 

func (e *MountTargetNotFound) ErrorCode() string

func (*MountTargetNotFound) ErrorFault 

func (e *MountTargetNotFound) ErrorFault() smithy.ErrorFault

func (*MountTargetNotFound) ErrorMessage 

func (e *MountTargetNotFound) ErrorMessage() string

type NetworkInterfaceLimitExceeded 

type NetworkInterfaceLimitExceeded struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).

func (*NetworkInterfaceLimitExceeded) Error 

func (e *NetworkInterfaceLimitExceeded) Error() string

func (*NetworkInterfaceLimitExceeded) ErrorCode 

func (e *NetworkInterfaceLimitExceeded) ErrorCode() string

func (*NetworkInterfaceLimitExceeded) ErrorFault 

func (e *NetworkInterfaceLimitExceeded) ErrorFault() smithy.ErrorFault

func (*NetworkInterfaceLimitExceeded) ErrorMessage 

func (e *NetworkInterfaceLimitExceeded) ErrorMessage() string

type NoFreeAddressesInSubnet 

type NoFreeAddressesInSubnet struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

func (*NoFreeAddressesInSubnet) Error 

func (e *NoFreeAddressesInSubnet) Error() string

func (*NoFreeAddressesInSubnet) ErrorCode 

func (e *NoFreeAddressesInSubnet) ErrorCode() string

func (*NoFreeAddressesInSubnet) ErrorFault 

func (e *NoFreeAddressesInSubnet) ErrorFault() smithy.ErrorFault

func (*NoFreeAddressesInSubnet) ErrorMessage 

func (e *NoFreeAddressesInSubnet) ErrorMessage() string

type PerformanceMode 

type PerformanceMode string
const (
	PerformanceModeGeneralPurpose PerformanceMode = "generalPurpose"
	PerformanceModeMaxIo          PerformanceMode = "maxIO"
)

Enum values for PerformanceMode

func (PerformanceMode) Values added in v0.29.0 

func (PerformanceMode) Values() []PerformanceMode

Values returns all known values for PerformanceMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PolicyNotFound 

type PolicyNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the default file system policy is in effect for the EFS file system specified.

func (*PolicyNotFound) Error 

func (e *PolicyNotFound) Error() string

func (*PolicyNotFound) ErrorCode 

func (e *PolicyNotFound) ErrorCode() string

func (*PolicyNotFound) ErrorFault 

func (e *PolicyNotFound) ErrorFault() smithy.ErrorFault

func (*PolicyNotFound) ErrorMessage 

func (e *PolicyNotFound) ErrorMessage() string

type PosixUser 

type PosixUser struct {

	// The POSIX group ID used for all file system operations using this access point.
	//
	// This member is required.
	Gid *int64

	// The POSIX user ID used for all file system operations using this access point.
	//
	// This member is required.
	Uid *int64

	// Secondary POSIX group IDs used for all file system operations using this access
	// point.
	SecondaryGids []int64
	// contains filtered or unexported fields
}

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

type ReplicationConfigurationDescription added in v1.14.0 

type ReplicationConfigurationDescription struct {

	// Describes when the replication configuration was created.
	//
	// This member is required.
	CreationTime *time.Time

	// An array of destination objects. Only one destination object is supported.
	//
	// This member is required.
	Destinations []Destination

	// The Amazon Resource Name (ARN) of the original source Amazon EFS file system in
	// the replication configuration.
	//
	// This member is required.
	OriginalSourceFileSystemArn *string

	// The Amazon Resource Name (ARN) of the current source file system in the
	// replication configuration.
	//
	// This member is required.
	SourceFileSystemArn *string

	// The ID of the source Amazon EFS file system that is being replicated.
	//
	// This member is required.
	SourceFileSystemId *string

	// The Amazon Web Services Region in which the source Amazon EFS file system is
	// located.
	//
	// This member is required.
	SourceFileSystemRegion *string
	// contains filtered or unexported fields
}

type ReplicationNotFound added in v1.14.0 

type ReplicationNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the specified file system does not have a replication configuration.

func (*ReplicationNotFound) Error added in v1.14.0 

func (e *ReplicationNotFound) Error() string

func (*ReplicationNotFound) ErrorCode added in v1.14.0 

func (e *ReplicationNotFound) ErrorCode() string

func (*ReplicationNotFound) ErrorFault added in v1.14.0 

func (e *ReplicationNotFound) ErrorFault() smithy.ErrorFault

func (*ReplicationNotFound) ErrorMessage added in v1.14.0 

func (e *ReplicationNotFound) ErrorMessage() string

type ReplicationStatus added in v1.14.0 

type ReplicationStatus string
const (
	ReplicationStatusEnabled  ReplicationStatus = "ENABLED"
	ReplicationStatusEnabling ReplicationStatus = "ENABLING"
	ReplicationStatusDeleting ReplicationStatus = "DELETING"
	ReplicationStatusError    ReplicationStatus = "ERROR"
)

Enum values for ReplicationStatus

func (ReplicationStatus) Values added in v1.14.0 

func (ReplicationStatus) Values() []ReplicationStatus

Values returns all known values for ReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Resource added in v1.4.0 

type Resource string
const (
	ResourceFileSystem  Resource = "FILE_SYSTEM"
	ResourceMountTarget Resource = "MOUNT_TARGET"
)

Enum values for Resource

func (Resource) Values added in v1.4.0 

func (Resource) Values() []Resource

Values returns all known values for Resource. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceIdPreference added in v1.4.0 

type ResourceIdPreference struct {

	// Identifies the EFS resource ID preference, either LONG_ID (17 characters) or
	// SHORT_ID (8 characters).
	ResourceIdType ResourceIdType

	// Identifies the Amazon EFS resources to which the ID preference setting applies,
	// FILE_SYSTEM and MOUNT_TARGET.
	Resources []Resource
	// contains filtered or unexported fields
}

Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.

type ResourceIdType added in v1.4.0 

type ResourceIdType string
const (
	ResourceIdTypeLongId  ResourceIdType = "LONG_ID"
	ResourceIdTypeShortId ResourceIdType = "SHORT_ID"
)

Enum values for ResourceIdType

func (ResourceIdType) Values added in v1.4.0 

func (ResourceIdType) Values() []ResourceIdType

Values returns all known values for ResourceIdType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RootDirectory 

type RootDirectory struct {

	// (Optional) Specifies the POSIX IDs and permissions to apply to the access
	// point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS
	// creates the root directory using the CreationInfo settings when a client
	// connects to an access point. When specifying the CreationInfo, you must provide
	// values for all properties. If you do not provide CreationInfo and the specified
	// RootDirectory > Path does not exist, attempts to mount the file system using the
	// access point will fail.
	CreationInfo *CreationInfo

	// Specifies the path on the EFS file system to expose as the root directory to NFS
	// clients using the access point to access the EFS file system. A path can have up
	// to four subdirectories. If the specified path does not exist, you are required
	// to provide the CreationInfo.
	Path *string
	// contains filtered or unexported fields
}

Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and it's subdirectories.

type SecurityGroupLimitExceeded 

type SecurityGroupLimitExceeded struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the size of SecurityGroups specified in the request is greater than five.

func (*SecurityGroupLimitExceeded) Error 

func (e *SecurityGroupLimitExceeded) Error() string

func (*SecurityGroupLimitExceeded) ErrorCode 

func (e *SecurityGroupLimitExceeded) ErrorCode() string

func (*SecurityGroupLimitExceeded) ErrorFault 

func (e *SecurityGroupLimitExceeded) ErrorFault() smithy.ErrorFault

func (*SecurityGroupLimitExceeded) ErrorMessage 

func (e *SecurityGroupLimitExceeded) ErrorMessage() string

type SecurityGroupNotFound 

type SecurityGroupNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).

func (*SecurityGroupNotFound) Error 

func (e *SecurityGroupNotFound) Error() string

func (*SecurityGroupNotFound) ErrorCode 

func (e *SecurityGroupNotFound) ErrorCode() string

func (*SecurityGroupNotFound) ErrorFault 

func (e *SecurityGroupNotFound) ErrorFault() smithy.ErrorFault

func (*SecurityGroupNotFound) ErrorMessage 

func (e *SecurityGroupNotFound) ErrorMessage() string

type Status 

type Status string
const (
	StatusEnabled   Status = "ENABLED"
	StatusEnabling  Status = "ENABLING"
	StatusDisabled  Status = "DISABLED"
	StatusDisabling Status = "DISABLING"
)

Enum values for Status

func (Status) Values added in v0.29.0 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SubnetNotFound 

type SubnetNotFound struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if there is no subnet with ID SubnetId provided in the request.

func (*SubnetNotFound) Error 

func (e *SubnetNotFound) Error() string

func (*SubnetNotFound) ErrorCode 

func (e *SubnetNotFound) ErrorCode() string

func (*SubnetNotFound) ErrorFault 

func (e *SubnetNotFound) ErrorFault() smithy.ErrorFault

func (*SubnetNotFound) ErrorMessage 

func (e *SubnetNotFound) ErrorMessage() string

type Tag 

type Tag struct {

	// The tag key (String). The key can't start with aws:.
	//
	// This member is required.
	Key *string

	// The value of the tag key.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /.

type ThrottlingException added in v1.17.0 

type ThrottlingException struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned when the CreateAccessPoint API action is called too quickly and the number of Access Points in the account is nearing the limit of 120.

func (*ThrottlingException) Error added in v1.17.0 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode added in v1.17.0 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault added in v1.17.0 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage added in v1.17.0 

func (e *ThrottlingException) ErrorMessage() string

type ThroughputLimitExceeded 

type ThroughputLimitExceeded struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

func (*ThroughputLimitExceeded) Error 

func (e *ThroughputLimitExceeded) Error() string

func (*ThroughputLimitExceeded) ErrorCode 

func (e *ThroughputLimitExceeded) ErrorCode() string

func (*ThroughputLimitExceeded) ErrorFault 

func (e *ThroughputLimitExceeded) ErrorFault() smithy.ErrorFault

func (*ThroughputLimitExceeded) ErrorMessage 

func (e *ThroughputLimitExceeded) ErrorMessage() string

type ThroughputMode 

type ThroughputMode string
const (
	ThroughputModeBursting    ThroughputMode = "bursting"
	ThroughputModeProvisioned ThroughputMode = "provisioned"
)

Enum values for ThroughputMode

func (ThroughputMode) Values added in v0.29.0 

func (ThroughputMode) Values() []ThroughputMode

Values returns all known values for ThroughputMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TooManyRequests 

type TooManyRequests struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.

func (*TooManyRequests) Error 

func (e *TooManyRequests) Error() string

func (*TooManyRequests) ErrorCode 

func (e *TooManyRequests) ErrorCode() string

func (*TooManyRequests) ErrorFault 

func (e *TooManyRequests) ErrorFault() smithy.ErrorFault

func (*TooManyRequests) ErrorMessage 

func (e *TooManyRequests) ErrorMessage() string

type TransitionToIARules 

type TransitionToIARules string
const (
	TransitionToIARulesAfter7Days  TransitionToIARules = "AFTER_7_DAYS"
	TransitionToIARulesAfter14Days TransitionToIARules = "AFTER_14_DAYS"
	TransitionToIARulesAfter30Days TransitionToIARules = "AFTER_30_DAYS"
	TransitionToIARulesAfter60Days TransitionToIARules = "AFTER_60_DAYS"
	TransitionToIARulesAfter90Days TransitionToIARules = "AFTER_90_DAYS"
)

Enum values for TransitionToIARules

func (TransitionToIARules) Values added in v0.29.0 

func (TransitionToIARules) Values() []TransitionToIARules

Values returns all known values for TransitionToIARules. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TransitionToPrimaryStorageClassRules added in v1.7.0 

type TransitionToPrimaryStorageClassRules string
const (
	TransitionToPrimaryStorageClassRulesAfter1Access TransitionToPrimaryStorageClassRules = "AFTER_1_ACCESS"
)

Enum values for TransitionToPrimaryStorageClassRules

func (TransitionToPrimaryStorageClassRules) Values added in v1.7.0 

func (TransitionToPrimaryStorageClassRules) Values() []TransitionToPrimaryStorageClassRules

Values returns all known values for TransitionToPrimaryStorageClassRules. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnsupportedAvailabilityZone 

type UnsupportedAvailabilityZone struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

func (*UnsupportedAvailabilityZone) Error 

func (e *UnsupportedAvailabilityZone) Error() string

func (*UnsupportedAvailabilityZone) ErrorCode 

func (e *UnsupportedAvailabilityZone) ErrorCode() string

func (*UnsupportedAvailabilityZone) ErrorFault 

func (e *UnsupportedAvailabilityZone) ErrorFault() smithy.ErrorFault

func (*UnsupportedAvailabilityZone) ErrorMessage 

func (e *UnsupportedAvailabilityZone) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.