efs

package
v0.22.0 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 2020 License: Apache-2.0 Imports: 9 Imported by: 72

Documentation

Overview

Package efs provides the client and types for making API requests to EFS.

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide (https://docs.aws.amazon.com/efs/latest/ug/api-reference.html).

See https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01 for more information on this service.

See efs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/efs/

Using the Client

To use EFS with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the EFS client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/efs/#New

Index

Examples

Constants

View Source 
const (
	ServiceName = "EFS"               // Service's name
	ServiceID   = "EFS"               // Service's identifier
	EndpointsID = "elasticfilesystem" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessPointAlreadyExists for service response error code
	// "AccessPointAlreadyExists".
	//
	// Returned if the access point you are trying to create already exists, with
	// the creation token you provided in the request.
	ErrCodeAccessPointAlreadyExists = "AccessPointAlreadyExists"

	// ErrCodeAccessPointLimitExceeded for service response error code
	// "AccessPointLimitExceeded".
	//
	// Returned if the AWS account has already created the maximum number of access
	// points allowed per file system.
	ErrCodeAccessPointLimitExceeded = "AccessPointLimitExceeded"

	// ErrCodeAccessPointNotFound for service response error code
	// "AccessPointNotFound".
	//
	// Returned if the specified AccessPointId value doesn't exist in the requester's
	// AWS account.
	ErrCodeAccessPointNotFound = "AccessPointNotFound"

	// ErrCodeBadRequest for service response error code
	// "BadRequest".
	//
	// Returned if the request is malformed or contains an error such as an invalid
	// parameter value or a missing required parameter.
	ErrCodeBadRequest = "BadRequest"

	// ErrCodeDependencyTimeout for service response error code
	// "DependencyTimeout".
	//
	// The service timed out trying to fulfill the request, and the client should
	// try the call again.
	ErrCodeDependencyTimeout = "DependencyTimeout"

	// ErrCodeFileSystemAlreadyExists for service response error code
	// "FileSystemAlreadyExists".
	//
	// Returned if the file system you are trying to create already exists, with
	// the creation token you provided.
	ErrCodeFileSystemAlreadyExists = "FileSystemAlreadyExists"

	// ErrCodeFileSystemInUse for service response error code
	// "FileSystemInUse".
	//
	// Returned if a file system has mount targets.
	ErrCodeFileSystemInUse = "FileSystemInUse"

	// ErrCodeFileSystemLimitExceeded for service response error code
	// "FileSystemLimitExceeded".
	//
	// Returned if the AWS account has already created the maximum number of file
	// systems allowed per account.
	ErrCodeFileSystemLimitExceeded = "FileSystemLimitExceeded"

	// ErrCodeFileSystemNotFound for service response error code
	// "FileSystemNotFound".
	//
	// Returned if the specified FileSystemId value doesn't exist in the requester's
	// AWS account.
	ErrCodeFileSystemNotFound = "FileSystemNotFound"

	// ErrCodeIncorrectFileSystemLifeCycleState for service response error code
	// "IncorrectFileSystemLifeCycleState".
	//
	// Returned if the file system's lifecycle state is not "available".
	ErrCodeIncorrectFileSystemLifeCycleState = "IncorrectFileSystemLifeCycleState"

	// ErrCodeIncorrectMountTargetState for service response error code
	// "IncorrectMountTargetState".
	//
	// Returned if the mount target is not in the correct state for the operation.
	ErrCodeIncorrectMountTargetState = "IncorrectMountTargetState"

	// ErrCodeInsufficientThroughputCapacity for service response error code
	// "InsufficientThroughputCapacity".
	//
	// 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 to provisioned throughput mode.
	ErrCodeInsufficientThroughputCapacity = "InsufficientThroughputCapacity"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// Returned if an error occurred on the server side.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidPolicyException for service response error code
	// "InvalidPolicyException".
	//
	// Returned if the FileSystemPolicy is is malformed or contains an error such
	// as an invalid parameter value or a missing required parameter. Returned in
	// the case of a policy lockout safety check error.
	ErrCodeInvalidPolicyException = "InvalidPolicyException"

	// ErrCodeIpAddressInUse for service response error code
	// "IpAddressInUse".
	//
	// Returned if the request specified an IpAddress that is already in use in
	// the subnet.
	ErrCodeIpAddressInUse = "IpAddressInUse"

	// ErrCodeMountTargetConflict for service response error code
	// "MountTargetConflict".
	//
	// Returned if the mount target would violate one of the specified restrictions
	// based on the file system's existing mount targets.
	ErrCodeMountTargetConflict = "MountTargetConflict"

	// ErrCodeMountTargetNotFound for service response error code
	// "MountTargetNotFound".
	//
	// Returned if there is no mount target with the specified ID found in the caller's
	// account.
	ErrCodeMountTargetNotFound = "MountTargetNotFound"

	// ErrCodeNetworkInterfaceLimitExceeded for service response error code
	// "NetworkInterfaceLimitExceeded".
	//
	// The calling account has reached the limit for elastic network interfaces
	// for the specific AWS Region. The client should try to delete some elastic
	// network interfaces or get the account limit raised. For more information,
	// see Amazon VPC Limits (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html)
	// in the Amazon VPC User Guide (see the Network interfaces per VPC entry in
	// the table).
	ErrCodeNetworkInterfaceLimitExceeded = "NetworkInterfaceLimitExceeded"

	// ErrCodeNoFreeAddressesInSubnet for service response error code
	// "NoFreeAddressesInSubnet".
	//
	// Returned if IpAddress was not specified in the request and there are no free
	// IP addresses in the subnet.
	ErrCodeNoFreeAddressesInSubnet = "NoFreeAddressesInSubnet"

	// ErrCodePolicyNotFound for service response error code
	// "PolicyNotFound".
	//
	// Returned if the default file system policy is in effect for the EFS file
	// system specified.
	ErrCodePolicyNotFound = "PolicyNotFound"

	// ErrCodeSecurityGroupLimitExceeded for service response error code
	// "SecurityGroupLimitExceeded".
	//
	// Returned if the size of SecurityGroups specified in the request is greater
	// than five.
	ErrCodeSecurityGroupLimitExceeded = "SecurityGroupLimitExceeded"

	// ErrCodeSecurityGroupNotFound for service response error code
	// "SecurityGroupNotFound".
	//
	// Returned if one of the specified security groups doesn't exist in the subnet's
	// VPC.
	ErrCodeSecurityGroupNotFound = "SecurityGroupNotFound"

	// ErrCodeSubnetNotFound for service response error code
	// "SubnetNotFound".
	//
	// Returned if there is no subnet with ID SubnetId provided in the request.
	ErrCodeSubnetNotFound = "SubnetNotFound"

	// ErrCodeThroughputLimitExceeded for service response error code
	// "ThroughputLimitExceeded".
	//
	// 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.
	ErrCodeThroughputLimitExceeded = "ThroughputLimitExceeded"

	// ErrCodeTooManyRequests for service response error code
	// "TooManyRequests".
	//
	// Returned if you don’t wait at least 24 hours before changing the throughput
	// mode, or decreasing the Provisioned Throughput value.
	ErrCodeTooManyRequests = "TooManyRequests"

	// ErrCodeUnsupportedAvailabilityZone for service response error code
	// "UnsupportedAvailabilityZone".
	ErrCodeUnsupportedAvailabilityZone = "UnsupportedAvailabilityZone"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPointDescription added in v0.19.0 

type AccessPointDescription struct {

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

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

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string `min:"1" type:"string"`

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

	// Identifies the lifecycle phase of the access point.
	LifeCycleState LifeCycleState `type:"string" enum:"true"`

	// The name of the access point. This is the value of the Name tag.
	Name *string `type:"string"`

	// Identified the AWS account that owns the access point resource.
	OwnerId *string `type:"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 `type:"structure"`

	// 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 `type:"structure"`

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

Provides a description of an EFS file system access point.

func (AccessPointDescription) MarshalFields added in v0.19.0 

func (s AccessPointDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AccessPointDescription) String added in v0.19.0 

func (s AccessPointDescription) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to EFS. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := efs.New(myConfig)

func (*Client) CreateAccessPointRequest added in v0.19.0 

func (c *Client) CreateAccessPointRequest(input *CreateAccessPointInput) CreateAccessPointRequest

CreateAccessPointRequest returns a request value for making API operation for Amazon Elastic File System.

Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a File System Using EFS Access Points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action. 

// Example sending a request using CreateAccessPointRequest.
req := client.CreateAccessPointRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateAccessPoint

func (*Client) CreateFileSystemRequest added in v0.9.0 

func (c *Client) CreateFileSystemRequest(input *CreateFileSystemInput) CreateFileSystemRequest

CreateFileSystemRequest returns a request value for making API operation for Amazon Elastic File System.

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your 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. For more information, see Amazon EFS: Performance Modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

This operation requires permissions for the elasticfilesystem:CreateFileSystem action. 

// Example sending a request using CreateFileSystemRequest.
req := client.CreateFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem

Example (Shared00)

To create a new file system

This operation creates a new file system with the default generalpurpose performance mode. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.CreateFileSystemInput{
		CreationToken:   aws.String("tokenstring"),
		PerformanceMode: efs.PerformanceModeGeneralPurpose,
		Tags: []efs.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	req := svc.CreateFileSystemRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemAlreadyExists:
				fmt.Println(efs.ErrCodeFileSystemAlreadyExists, aerr.Error())
			case efs.ErrCodeFileSystemLimitExceeded:
				fmt.Println(efs.ErrCodeFileSystemLimitExceeded, aerr.Error())
			case efs.ErrCodeInsufficientThroughputCapacity:
				fmt.Println(efs.ErrCodeInsufficientThroughputCapacity, aerr.Error())
			case efs.ErrCodeThroughputLimitExceeded:
				fmt.Println(efs.ErrCodeThroughputLimitExceeded, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateMountTargetRequest added in v0.9.0 

func (c *Client) CreateMountTargetRequest(input *CreateMountTargetInput) CreateMountTargetRequest

CreateMountTargetRequest returns a request value for making API operation for Amazon Elastic File System.

Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS (http://aws.amazon.com/efs/). In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

    // Example sending a request using CreateMountTargetRequest. req := client.CreateMountTargetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTarget

Example (Shared00)

To create a new mount target

This operation creates a new mount target for an EFS file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.CreateMountTargetInput{
		FileSystemId: aws.String("fs-01234567"),
		SubnetId:     aws.String("subnet-1234abcd"),
	}

	req := svc.CreateMountTargetRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeIncorrectFileSystemLifeCycleState:
				fmt.Println(efs.ErrCodeIncorrectFileSystemLifeCycleState, aerr.Error())
			case efs.ErrCodeMountTargetConflict:
				fmt.Println(efs.ErrCodeMountTargetConflict, aerr.Error())
			case efs.ErrCodeSubnetNotFound:
				fmt.Println(efs.ErrCodeSubnetNotFound, aerr.Error())
			case efs.ErrCodeNoFreeAddressesInSubnet:
				fmt.Println(efs.ErrCodeNoFreeAddressesInSubnet, aerr.Error())
			case efs.ErrCodeIpAddressInUse:
				fmt.Println(efs.ErrCodeIpAddressInUse, aerr.Error())
			case efs.ErrCodeNetworkInterfaceLimitExceeded:
				fmt.Println(efs.ErrCodeNetworkInterfaceLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupLimitExceeded:
				fmt.Println(efs.ErrCodeSecurityGroupLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupNotFound:
				fmt.Println(efs.ErrCodeSecurityGroupNotFound, aerr.Error())
			case efs.ErrCodeUnsupportedAvailabilityZone:
				fmt.Println(efs.ErrCodeUnsupportedAvailabilityZone, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateTagsRequest added in v0.9.0 

func (c *Client) CreateTagsRequest(input *CreateTagsInput) CreateTagsRequest

CreateTagsRequest returns a request value for making API operation for Amazon Elastic File System.

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

This operation requires permission for the elasticfilesystem:CreateTags action. 

// Example sending a request using CreateTagsRequest.
req := client.CreateTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags

Example (Shared00)

To create a new tag

This operation creates a new tag for an EFS file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.CreateTagsInput{
		FileSystemId: aws.String("fs-01234567"),
		Tags: []efs.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	req := svc.CreateTagsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DeleteAccessPointRequest added in v0.19.0 

func (c *Client) DeleteAccessPointRequest(input *DeleteAccessPointInput) DeleteAccessPointRequest

DeleteAccessPointRequest returns a request value for making API operation for Amazon Elastic File System.

Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.

This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action. 

// Example sending a request using DeleteAccessPointRequest.
req := client.DeleteAccessPointRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteAccessPoint

func (*Client) DeleteFileSystemPolicyRequest added in v0.19.0 

func (c *Client) DeleteFileSystemPolicyRequest(input *DeleteFileSystemPolicyInput) DeleteFileSystemPolicyRequest

DeleteFileSystemPolicyRequest returns a request value for making API operation for Amazon Elastic File System.

Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS (https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html).

This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action. 

// Example sending a request using DeleteFileSystemPolicyRequest.
req := client.DeleteFileSystemPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy

func (*Client) DeleteFileSystemRequest added in v0.9.0 

func (c *Client) DeleteFileSystemRequest(input *DeleteFileSystemInput) DeleteFileSystemRequest

DeleteFileSystemRequest returns a request value for making API operation for Amazon Elastic File System.

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action. 

// Example sending a request using DeleteFileSystemRequest.
req := client.DeleteFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystem

Example (Shared00)

To delete a file system

This operation deletes an EFS file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DeleteFileSystemInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	req := svc.DeleteFileSystemRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeFileSystemInUse:
				fmt.Println(efs.ErrCodeFileSystemInUse, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DeleteMountTargetRequest added in v0.9.0 

func (c *Client) DeleteMountTargetRequest(input *DeleteMountTargetInput) DeleteMountTargetRequest

DeleteMountTargetRequest returns a request value for making API operation for Amazon Elastic File System.

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

    // Example sending a request using DeleteMountTargetRequest. req := client.DeleteMountTargetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTarget

Example (Shared00)

To delete a mount target

This operation deletes a mount target. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DeleteMountTargetInput{
		MountTargetId: aws.String("fsmt-12340abc"),
	}

	req := svc.DeleteMountTargetRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeDependencyTimeout:
				fmt.Println(efs.ErrCodeDependencyTimeout, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DeleteTagsRequest added in v0.9.0 

func (c *Client) DeleteTagsRequest(input *DeleteTagsInput) DeleteTagsRequest

DeleteTagsRequest returns a request value for making API operation for Amazon Elastic File System.

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action. 

// Example sending a request using DeleteTagsRequest.
req := client.DeleteTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTags

Example (Shared00)

To delete tags for an EFS file system

This operation deletes tags for an EFS file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DeleteTagsInput{
		FileSystemId: aws.String("fs-01234567"),
		TagKeys: []string{
			"Name",
		},
	}

	req := svc.DeleteTagsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeAccessPointsRequest added in v0.19.0 

func (c *Client) DescribeAccessPointsRequest(input *DescribeAccessPointsInput) DescribeAccessPointsRequest

DescribeAccessPointsRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action. 

// Example sending a request using DescribeAccessPointsRequest.
req := client.DescribeAccessPointsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeAccessPoints

func (*Client) DescribeFileSystemPolicyRequest added in v0.19.0 

func (c *Client) DescribeFileSystemPolicyRequest(input *DescribeFileSystemPolicyInput) DescribeFileSystemPolicyRequest

DescribeFileSystemPolicyRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action. 

// Example sending a request using DescribeFileSystemPolicyRequest.
req := client.DescribeFileSystemPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy

func (*Client) DescribeFileSystemsRequest added in v0.9.0 

func (c *Client) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) DescribeFileSystemsRequest

DescribeFileSystemsRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action. 

// Example sending a request using DescribeFileSystemsRequest.
req := client.DescribeFileSystemsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems

Example (Shared00)

To describe an EFS file system

This operation describes all of the EFS file systems in an account. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DescribeFileSystemsInput{}

	req := svc.DescribeFileSystemsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeLifecycleConfigurationRequest added in v0.9.0 

func (c *Client) DescribeLifecycleConfigurationRequest(input *DescribeLifecycleConfigurationInput) DescribeLifecycleConfigurationRequest

DescribeLifecycleConfigurationRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation. 

// Example sending a request using DescribeLifecycleConfigurationRequest.
req := client.DescribeLifecycleConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration

Example (Shared00)

To describe the lifecycle configuration for a file system

This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DescribeLifecycleConfigurationInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	req := svc.DescribeLifecycleConfigurationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeMountTargetSecurityGroupsRequest added in v0.9.0 

func (c *Client) DescribeMountTargetSecurityGroupsRequest(input *DescribeMountTargetSecurityGroupsInput) DescribeMountTargetSecurityGroupsRequest

DescribeMountTargetSecurityGroupsRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

This operation requires permissions for the following actions:

  • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

  • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

    // Example sending a request using DescribeMountTargetSecurityGroupsRequest. req := client.DescribeMountTargetSecurityGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups

Example (Shared00)

To describe the security groups for a mount target

This operation describes all of the security groups for a file system's mount target. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DescribeMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("fsmt-12340abc"),
	}

	req := svc.DescribeMountTargetSecurityGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			case efs.ErrCodeIncorrectMountTargetState:
				fmt.Println(efs.ErrCodeIncorrectMountTargetState, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeMountTargetsRequest added in v0.9.0 

func (c *Client) DescribeMountTargetsRequest(input *DescribeMountTargetsInput) DescribeMountTargetsRequest

DescribeMountTargetsRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId. 

// Example sending a request using DescribeMountTargetsRequest.
req := client.DescribeMountTargetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargets

Example (Shared00)

To describe the mount targets for a file system

This operation describes all of a file system's mount targets. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DescribeMountTargetsInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	req := svc.DescribeMountTargetsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			case efs.ErrCodeAccessPointNotFound:
				fmt.Println(efs.ErrCodeAccessPointNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeTagsRequest added in v0.9.0 

func (c *Client) DescribeTagsRequest(input *DescribeTagsInput) DescribeTagsRequest

DescribeTagsRequest returns a request value for making API operation for Amazon Elastic File System.

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action. 

// Example sending a request using DescribeTagsRequest.
req := client.DescribeTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTags

Example (Shared00)

To describe the tags for a file system

This operation describes all of a file system's tags. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.DescribeTagsInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	req := svc.DescribeTagsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) ListTagsForResourceRequest added in v0.19.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Elastic File System.

Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ListTagsForResource

func (*Client) ModifyMountTargetSecurityGroupsRequest added in v0.9.0 

func (c *Client) ModifyMountTargetSecurityGroupsRequest(input *ModifyMountTargetSecurityGroupsInput) ModifyMountTargetSecurityGroupsRequest

ModifyMountTargetSecurityGroupsRequest returns a request value for making API operation for Amazon Elastic File System.

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

The operation requires permissions for the following actions:

  • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

  • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

    // Example sending a request using ModifyMountTargetSecurityGroupsRequest. req := client.ModifyMountTargetSecurityGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups

Example (Shared00)

To modify the security groups associated with a mount target for a file system

This operation modifies the security groups associated with a mount target for a file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.ModifyMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("fsmt-12340abc"),
		SecurityGroups: []string{
			"sg-abcd1234",
		},
	}

	req := svc.ModifyMountTargetSecurityGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			case efs.ErrCodeIncorrectMountTargetState:
				fmt.Println(efs.ErrCodeIncorrectMountTargetState, aerr.Error())
			case efs.ErrCodeSecurityGroupLimitExceeded:
				fmt.Println(efs.ErrCodeSecurityGroupLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupNotFound:
				fmt.Println(efs.ErrCodeSecurityGroupNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) PutFileSystemPolicyRequest added in v0.19.0 

func (c *Client) PutFileSystemPolicyRequest(input *PutFileSystemPolicyInput) PutFileSystemPolicyRequest

PutFileSystemPolicyRequest returns a request value for making API operation for Amazon Elastic File System.

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy (https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy).

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action. 

// Example sending a request using PutFileSystemPolicyRequest.
req := client.PutFileSystemPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutFileSystemPolicy

func (*Client) PutLifecycleConfigurationRequest added in v0.9.0 

func (c *Client) PutLifecycleConfigurationRequest(input *PutLifecycleConfigurationInput) PutLifecycleConfigurationRequest

PutLifecycleConfigurationRequest returns a request value for making API operation for Amazon Elastic File System.

Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management.

In the request, specify the following:

  • The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.

  • A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one LifecyclePolicy item.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. 

// Example sending a request using PutLifecycleConfigurationRequest.
req := client.PutLifecycleConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutLifecycleConfiguration

Example (Shared00)

Creates a new lifecycleconfiguration object for a file system

This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/efs"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := efs.New(cfg)
	input := &efs.PutLifecycleConfigurationInput{
		FileSystemId: aws.String("fs-01234567"),
		LifecyclePolicies: []efs.LifecyclePolicy{
			{
				TransitionToIA: efs.TransitionToIARulesAfter30Days,
			},
		},
	}

	req := svc.PutLifecycleConfigurationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeIncorrectFileSystemLifeCycleState:
				fmt.Println(efs.ErrCodeIncorrectFileSystemLifeCycleState, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) TagResourceRequest added in v0.19.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Elastic File System.

Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:TagResource action. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/TagResource

func (*Client) UntagResourceRequest added in v0.19.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Elastic File System.

Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:UntagResource action. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UntagResource

func (*Client) UpdateFileSystemRequest added in v0.9.0 

func (c *Client) UpdateFileSystemRequest(input *UpdateFileSystemInput) UpdateFileSystemRequest

UpdateFileSystemRequest returns a request value for making API operation for Amazon Elastic File System.

Updates the throughput mode or the amount of provisioned throughput of an existing file system. 

// Example sending a request using UpdateFileSystemRequest.
req := client.UpdateFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystem

type CreateAccessPointInput added in v0.19.0 

type CreateAccessPointInput struct {

	// A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
	// creation.
	//
	// ClientToken is a required field
	ClientToken *string `min:"1" type:"string" required:"true" idempotencyToken:"true"`

	// The ID of the EFS file system that the access point provides access to.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The operating system user and group applied to all file system requests made
	// using the access point.
	PosixUser *PosixUser `type:"structure"`

	// Specifies the directory on the Amazon EFS file system that the access point
	// exposes as the root directory of your file system to NFS clients using the
	// access point. The clients using the access point can only access the root
	// directory and below. If the RootDirectory > Path specified does not exist,
	// EFS creates it and applies the CreationInfo settings when a client connects
	// to an access point. When specifying a RootDirectory, you need to provide
	// the Path, and the CreationInfo is optional.
	RootDirectory *RootDirectory `type:"structure"`

	// Creates tags associated with the access point. Each tag is a key-value pair.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateAccessPointInput) MarshalFields added in v0.19.0 

func (s CreateAccessPointInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAccessPointInput) String added in v0.19.0 

func (s CreateAccessPointInput) String() string

String returns the string representation

func (*CreateAccessPointInput) Validate added in v0.19.0 

func (s *CreateAccessPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessPointOutput added in v0.19.0 

type CreateAccessPointOutput struct {

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

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

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string `min:"1" type:"string"`

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

	// Identifies the lifecycle phase of the access point.
	LifeCycleState LifeCycleState `type:"string" enum:"true"`

	// The name of the access point. This is the value of the Name tag.
	Name *string `type:"string"`

	// Identified the AWS account that owns the access point resource.
	OwnerId *string `type:"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 `type:"structure"`

	// 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 `type:"structure"`

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

Provides a description of an EFS file system access point.

func (CreateAccessPointOutput) MarshalFields added in v0.19.0 

func (s CreateAccessPointOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAccessPointOutput) String added in v0.19.0 

func (s CreateAccessPointOutput) String() string

String returns the string representation

type CreateAccessPointRequest added in v0.19.0 

type CreateAccessPointRequest struct {
	*aws.Request
	Input *CreateAccessPointInput
	Copy  func(*CreateAccessPointInput) CreateAccessPointRequest
}

CreateAccessPointRequest is the request type for the CreateAccessPoint API operation.

func (CreateAccessPointRequest) Send added in v0.19.0 

func (r CreateAccessPointRequest) Send(ctx context.Context) (*CreateAccessPointResponse, error)

Send marshals and sends the CreateAccessPoint API request.

type CreateAccessPointResponse added in v0.19.0 

type CreateAccessPointResponse struct {
	*CreateAccessPointOutput
	// contains filtered or unexported fields
}

CreateAccessPointResponse is the response type for the CreateAccessPoint API operation.

func (*CreateAccessPointResponse) SDKResponseMetdata added in v0.19.0 

func (r *CreateAccessPointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAccessPoint request.

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
	// creation.
	//
	// CreationToken is a required field
	CreationToken *string `min:"1" type:"string" required:"true" idempotencyToken:"true"`

	// 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.
	Encrypted *bool `type:"boolean"`

	// 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 nondefault 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.
	//
	// EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS
	// file systems.
	KmsKeyId *string `min:"1" type:"string"`

	// 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.
	PerformanceMode PerformanceMode `type:"string" enum:"true"`

	// 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. You
	// can get this limit increased by contacting AWS Support. For more information,
	// see Amazon EFS Limits That You Can Increase (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// 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.
	Tags []Tag `type:"list"`

	// 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. If you
	// set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// 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, see
	// Specifying Throughput with Provisioned Mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)
	// in the Amazon EFS User Guide.
	ThroughputMode ThroughputMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateFileSystemInput) MarshalFields added in v0.3.0 

func (s CreateFileSystemInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFileSystemInput) String 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate 

func (s *CreateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFileSystemOutput 

type CreateFileSystemOutput struct {

	// The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The opaque string specified in the request.
	//
	// CreationToken is a required field
	CreationToken *string `min:"1" type:"string" required:"true"`

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool `type:"boolean"`

	// The ID of the file system, assigned by Amazon EFS.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK)
	// that was used to protect the encrypted file system.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle phase of the file system.
	//
	// LifeCycleState is a required field
	LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`

	// 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 `type:"string"`

	// The current number of mount targets that the file system has. For more information,
	// see CreateMountTarget.
	//
	// NumberOfMountTargets is a required field
	NumberOfMountTargets *int64 `type:"integer" required:"true"`

	// The AWS 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.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

	// The performance mode of the file system.
	//
	// PerformanceMode is a required field
	PerformanceMode PerformanceMode `type:"string" required:"true" enum:"true"`

	// The throughput, measured in MiB/s, that you want to provision for a file
	// system. Valid values are 1-1024. Required if ThroughputMode is set to provisioned.
	// 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 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// 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.
	//
	// SizeInBytes is a required field
	SizeInBytes *FileSystemSize `type:"structure" required:"true"`

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`

	// The throughput mode for a file system. There are two throughput modes to
	// choose from for your file system: bursting and provisioned. If you set ThroughputMode
	// to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// 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.
	ThroughputMode ThroughputMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A description of the file system.

func (CreateFileSystemOutput) MarshalFields added in v0.3.0 

func (s CreateFileSystemOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFileSystemOutput) String 

func (s CreateFileSystemOutput) String() string

String returns the string representation

type CreateFileSystemRequest 

type CreateFileSystemRequest struct {
	*aws.Request
	Input *CreateFileSystemInput
	Copy  func(*CreateFileSystemInput) CreateFileSystemRequest
}

CreateFileSystemRequest is the request type for the CreateFileSystem API operation.

func (CreateFileSystemRequest) Send 

func (r CreateFileSystemRequest) Send(ctx context.Context) (*CreateFileSystemResponse, error)

Send marshals and sends the CreateFileSystem API request.

type CreateFileSystemResponse added in v0.9.0 

type CreateFileSystemResponse struct {
	*CreateFileSystemOutput
	// contains filtered or unexported fields
}

CreateFileSystemResponse is the response type for the CreateFileSystem API operation.

func (*CreateFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFileSystem request.

type CreateMountTargetInput 

type CreateMountTargetInput struct {

	// The ID of the file system for which to create the mount target.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// Valid IPv4 address within the address range of the specified subnet.
	IpAddress *string `type:"string"`

	// Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be
	// for the same VPC as subnet specified.
	SecurityGroups []string `type:"list"`

	// The ID of the subnet to add the mount target in.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMountTargetInput) MarshalFields added in v0.3.0 

func (s CreateMountTargetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateMountTargetInput) String 

func (s CreateMountTargetInput) String() string

String returns the string representation

func (*CreateMountTargetInput) Validate 

func (s *CreateMountTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMountTargetOutput 

type CreateMountTargetOutput struct {

	// The unique and consistent identifier of the Availability Zone (AZ) 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 AWS account.
	AvailabilityZoneId *string `type:"string"`

	// The name of the Availability Zone (AZ) that the mount target resides in.
	// AZs are independently mapped to names for each AWS account. For example,
	// the Availability Zone us-east-1a for your AWS account might not be the same
	// location as us-east-1a for another AWS account.
	AvailabilityZoneName *string `type:"string"`

	// The ID of the file system for which the mount target is intended.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

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

	// Lifecycle state of the mount target.
	//
	// LifeCycleState is a required field
	LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`

	// System-assigned mount target ID.
	//
	// MountTargetId is a required field
	MountTargetId *string `type:"string" required:"true"`

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

	// AWS account ID that owns the resource.
	OwnerId *string `type:"string"`

	// The ID of the mount target's subnet.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides a description of a mount target.

func (CreateMountTargetOutput) MarshalFields added in v0.3.0 

func (s CreateMountTargetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateMountTargetOutput) String 

func (s CreateMountTargetOutput) String() string

String returns the string representation

type CreateMountTargetRequest 

type CreateMountTargetRequest struct {
	*aws.Request
	Input *CreateMountTargetInput
	Copy  func(*CreateMountTargetInput) CreateMountTargetRequest
}

CreateMountTargetRequest is the request type for the CreateMountTarget API operation.

func (CreateMountTargetRequest) Send 

func (r CreateMountTargetRequest) Send(ctx context.Context) (*CreateMountTargetResponse, error)

Send marshals and sends the CreateMountTarget API request.

type CreateMountTargetResponse added in v0.9.0 

type CreateMountTargetResponse struct {
	*CreateMountTargetOutput
	// contains filtered or unexported fields
}

CreateMountTargetResponse is the response type for the CreateMountTarget API operation.

func (*CreateMountTargetResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateMountTargetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateMountTarget request.

type CreateTagsInput 

type CreateTagsInput struct {

	// The ID of the file system whose tags you want to modify (String). This operation
	// modifies the tags only, not the file system.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// An array of Tag objects to add. Each Tag object is a key-value pair.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTagsInput) MarshalFields added in v0.3.0 

func (s CreateTagsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateTagsInput) String 

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate 

func (s *CreateTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTagsOutput 

type CreateTagsOutput struct {
	// contains filtered or unexported fields
}

func (CreateTagsOutput) MarshalFields added in v0.3.0 

func (s CreateTagsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateTagsOutput) String 

func (s CreateTagsOutput) String() string

String returns the string representation

type CreateTagsRequest 

type CreateTagsRequest struct {
	*aws.Request
	Input *CreateTagsInput
	Copy  func(*CreateTagsInput) CreateTagsRequest
}

CreateTagsRequest is the request type for the CreateTags API operation.

func (CreateTagsRequest) Send 

func (r CreateTagsRequest) Send(ctx context.Context) (*CreateTagsResponse, error)

Send marshals and sends the CreateTags API request.

type CreateTagsResponse added in v0.9.0 

type CreateTagsResponse struct {
	*CreateTagsOutput
	// contains filtered or unexported fields
}

CreateTagsResponse is the response type for the CreateTags API operation.

func (*CreateTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateTags request.

type CreationInfo added in v0.19.0 

type CreationInfo struct {

	// Specifies the POSIX group ID to apply to the RootDirectory. Accepts values
	// from 0 to 2^32 (4294967295).
	//
	// OwnerGid is a required field
	OwnerGid *int64 `type:"long" required:"true"`

	// Specifies the POSIX user ID to apply to the RootDirectory. Accepts values
	// from 0 to 2^32 (4294967295).
	//
	// OwnerUid is a required field
	OwnerUid *int64 `type:"long" required:"true"`

	// Specifies the POSIX permissions to apply to the RootDirectory, in the format
	// of an octal number representing the file's mode bits.
	//
	// Permissions is a required field
	Permissions *string `type:"string" required:"true"`
	// 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.

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.

func (CreationInfo) MarshalFields added in v0.19.0 

func (s CreationInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreationInfo) String added in v0.19.0 

func (s CreationInfo) String() string

String returns the string representation

func (*CreationInfo) Validate added in v0.19.0 

func (s *CreationInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessPointInput added in v0.19.0 

type DeleteAccessPointInput struct {

	// The ID of the access point that you want to delete.
	//
	// AccessPointId is a required field
	AccessPointId *string `location:"uri" locationName:"AccessPointId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessPointInput) MarshalFields added in v0.19.0 

func (s DeleteAccessPointInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAccessPointInput) String added in v0.19.0 

func (s DeleteAccessPointInput) String() string

String returns the string representation

func (*DeleteAccessPointInput) Validate added in v0.19.0 

func (s *DeleteAccessPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessPointOutput added in v0.19.0 

type DeleteAccessPointOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAccessPointOutput) MarshalFields added in v0.19.0 

func (s DeleteAccessPointOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAccessPointOutput) String added in v0.19.0 

func (s DeleteAccessPointOutput) String() string

String returns the string representation

type DeleteAccessPointRequest added in v0.19.0 

type DeleteAccessPointRequest struct {
	*aws.Request
	Input *DeleteAccessPointInput
	Copy  func(*DeleteAccessPointInput) DeleteAccessPointRequest
}

DeleteAccessPointRequest is the request type for the DeleteAccessPoint API operation.

func (DeleteAccessPointRequest) Send added in v0.19.0 

func (r DeleteAccessPointRequest) Send(ctx context.Context) (*DeleteAccessPointResponse, error)

Send marshals and sends the DeleteAccessPoint API request.

type DeleteAccessPointResponse added in v0.19.0 

type DeleteAccessPointResponse struct {
	*DeleteAccessPointOutput
	// contains filtered or unexported fields
}

DeleteAccessPointResponse is the response type for the DeleteAccessPoint API operation.

func (*DeleteAccessPointResponse) SDKResponseMetdata added in v0.19.0 

func (r *DeleteAccessPointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAccessPoint request.

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// The ID of the file system you want to delete.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFileSystemInput) MarshalFields added in v0.3.0 

func (s DeleteFileSystemInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFileSystemInput) String 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate 

func (s *DeleteFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemOutput 

type DeleteFileSystemOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFileSystemOutput) MarshalFields added in v0.3.0 

func (s DeleteFileSystemOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFileSystemOutput) String 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteFileSystemPolicyInput added in v0.19.0 

type DeleteFileSystemPolicyInput struct {

	// Specifies the EFS file system for which to delete the FileSystemPolicy.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFileSystemPolicyInput) MarshalFields added in v0.19.0 

func (s DeleteFileSystemPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFileSystemPolicyInput) String added in v0.19.0 

func (s DeleteFileSystemPolicyInput) String() string

String returns the string representation

func (*DeleteFileSystemPolicyInput) Validate added in v0.19.0 

func (s *DeleteFileSystemPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemPolicyOutput added in v0.19.0 

type DeleteFileSystemPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFileSystemPolicyOutput) MarshalFields added in v0.19.0 

func (s DeleteFileSystemPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFileSystemPolicyOutput) String added in v0.19.0 

func (s DeleteFileSystemPolicyOutput) String() string

String returns the string representation

type DeleteFileSystemPolicyRequest added in v0.19.0 

type DeleteFileSystemPolicyRequest struct {
	*aws.Request
	Input *DeleteFileSystemPolicyInput
	Copy  func(*DeleteFileSystemPolicyInput) DeleteFileSystemPolicyRequest
}

DeleteFileSystemPolicyRequest is the request type for the DeleteFileSystemPolicy API operation.

func (DeleteFileSystemPolicyRequest) Send added in v0.19.0 

func (r DeleteFileSystemPolicyRequest) Send(ctx context.Context) (*DeleteFileSystemPolicyResponse, error)

Send marshals and sends the DeleteFileSystemPolicy API request.

type DeleteFileSystemPolicyResponse added in v0.19.0 

type DeleteFileSystemPolicyResponse struct {
	*DeleteFileSystemPolicyOutput
	// contains filtered or unexported fields
}

DeleteFileSystemPolicyResponse is the response type for the DeleteFileSystemPolicy API operation.

func (*DeleteFileSystemPolicyResponse) SDKResponseMetdata added in v0.19.0 

func (r *DeleteFileSystemPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFileSystemPolicy request.

type DeleteFileSystemRequest 

type DeleteFileSystemRequest struct {
	*aws.Request
	Input *DeleteFileSystemInput
	Copy  func(*DeleteFileSystemInput) DeleteFileSystemRequest
}

DeleteFileSystemRequest is the request type for the DeleteFileSystem API operation.

func (DeleteFileSystemRequest) Send 

func (r DeleteFileSystemRequest) Send(ctx context.Context) (*DeleteFileSystemResponse, error)

Send marshals and sends the DeleteFileSystem API request.

type DeleteFileSystemResponse added in v0.9.0 

type DeleteFileSystemResponse struct {
	*DeleteFileSystemOutput
	// contains filtered or unexported fields
}

DeleteFileSystemResponse is the response type for the DeleteFileSystem API operation.

func (*DeleteFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFileSystem request.

type DeleteMountTargetInput 

type DeleteMountTargetInput struct {

	// The ID of the mount target to delete (String).
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMountTargetInput) MarshalFields added in v0.3.0 

func (s DeleteMountTargetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteMountTargetInput) String 

func (s DeleteMountTargetInput) String() string

String returns the string representation

func (*DeleteMountTargetInput) Validate 

func (s *DeleteMountTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMountTargetOutput 

type DeleteMountTargetOutput struct {
	// contains filtered or unexported fields
}

func (DeleteMountTargetOutput) MarshalFields added in v0.3.0 

func (s DeleteMountTargetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteMountTargetOutput) String 

func (s DeleteMountTargetOutput) String() string

String returns the string representation

type DeleteMountTargetRequest 

type DeleteMountTargetRequest struct {
	*aws.Request
	Input *DeleteMountTargetInput
	Copy  func(*DeleteMountTargetInput) DeleteMountTargetRequest
}

DeleteMountTargetRequest is the request type for the DeleteMountTarget API operation.

func (DeleteMountTargetRequest) Send 

func (r DeleteMountTargetRequest) Send(ctx context.Context) (*DeleteMountTargetResponse, error)

Send marshals and sends the DeleteMountTarget API request.

type DeleteMountTargetResponse added in v0.9.0 

type DeleteMountTargetResponse struct {
	*DeleteMountTargetOutput
	// contains filtered or unexported fields
}

DeleteMountTargetResponse is the response type for the DeleteMountTarget API operation.

func (*DeleteMountTargetResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteMountTargetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteMountTarget request.

type DeleteTagsInput 

type DeleteTagsInput struct {

	// The ID of the file system whose tags you want to delete (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// A list of tag keys to delete.
	//
	// TagKeys is a required field
	TagKeys []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTagsInput) MarshalFields added in v0.3.0 

func (s DeleteTagsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteTagsInput) String 

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate 

func (s *DeleteTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTagsOutput 

type DeleteTagsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTagsOutput) MarshalFields added in v0.3.0 

func (s DeleteTagsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteTagsOutput) String 

func (s DeleteTagsOutput) String() string

String returns the string representation

type DeleteTagsRequest 

type DeleteTagsRequest struct {
	*aws.Request
	Input *DeleteTagsInput
	Copy  func(*DeleteTagsInput) DeleteTagsRequest
}

DeleteTagsRequest is the request type for the DeleteTags API operation.

func (DeleteTagsRequest) Send 

func (r DeleteTagsRequest) Send(ctx context.Context) (*DeleteTagsResponse, error)

Send marshals and sends the DeleteTags API request.

type DeleteTagsResponse added in v0.9.0 

type DeleteTagsResponse struct {
	*DeleteTagsOutput
	// contains filtered or unexported fields
}

DeleteTagsResponse is the response type for the DeleteTags API operation.

func (*DeleteTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteTags request.

type DescribeAccessPointsInput added in v0.19.0 

type DescribeAccessPointsInput struct {

	// (Optional) Specifies an EFS access point to describe in the response; mutually
	// exclusive with FileSystemId.
	AccessPointId *string `location:"querystring" locationName:"AccessPointId" type:"string"`

	// (Optional) If you provide a FileSystemId, EFS returns all access points for
	// that file system; mutually exclusive with AccessPointId.
	FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`

	// (Optional) When retrieving all access points for a file system, you can optionally
	// specify the MaxItems parameter to limit the number of objects returned in
	// a response. The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// NextToken is present if the response is paginated. You can use NextMarker
	// in the subsequent request to fetch the next page of access point descriptions.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccessPointsInput) MarshalFields added in v0.19.0 

func (s DescribeAccessPointsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAccessPointsInput) String added in v0.19.0 

func (s DescribeAccessPointsInput) String() string

String returns the string representation

func (*DescribeAccessPointsInput) Validate added in v0.19.0 

func (s *DescribeAccessPointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccessPointsOutput added in v0.19.0 

type DescribeAccessPointsOutput struct {

	// An array of access point descriptions.
	AccessPoints []AccessPointDescription `type:"list"`

	// Present if there are more access points than returned in the response. You
	// can use the NextMarker in the subsequent request to fetch the additional
	// descriptions.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccessPointsOutput) MarshalFields added in v0.19.0 

func (s DescribeAccessPointsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAccessPointsOutput) String added in v0.19.0 

func (s DescribeAccessPointsOutput) String() string

String returns the string representation

type DescribeAccessPointsPaginator added in v0.19.0 

type DescribeAccessPointsPaginator struct {
	aws.Pager
}

DescribeAccessPointsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeAccessPointsPaginator added in v0.19.0 

func NewDescribeAccessPointsPaginator(req DescribeAccessPointsRequest) DescribeAccessPointsPaginator

NewDescribeAccessPointsRequestPaginator returns a paginator for DescribeAccessPoints. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeAccessPointsRequest(input)
p := efs.NewDescribeAccessPointsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeAccessPointsPaginator) CurrentPage added in v0.19.0 

func (p *DescribeAccessPointsPaginator) CurrentPage() *DescribeAccessPointsOutput

type DescribeAccessPointsRequest added in v0.19.0 

type DescribeAccessPointsRequest struct {
	*aws.Request
	Input *DescribeAccessPointsInput
	Copy  func(*DescribeAccessPointsInput) DescribeAccessPointsRequest
}

DescribeAccessPointsRequest is the request type for the DescribeAccessPoints API operation.

func (DescribeAccessPointsRequest) Send added in v0.19.0 

func (r DescribeAccessPointsRequest) Send(ctx context.Context) (*DescribeAccessPointsResponse, error)

Send marshals and sends the DescribeAccessPoints API request.

type DescribeAccessPointsResponse added in v0.19.0 

type DescribeAccessPointsResponse struct {
	*DescribeAccessPointsOutput
	// contains filtered or unexported fields
}

DescribeAccessPointsResponse is the response type for the DescribeAccessPoints API operation.

func (*DescribeAccessPointsResponse) SDKResponseMetdata added in v0.19.0 

func (r *DescribeAccessPointsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAccessPoints request.

type DescribeFileSystemPolicyInput added in v0.19.0 

type DescribeFileSystemPolicyInput struct {

	// Specifies which EFS file system to retrieve the FileSystemPolicy for.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemPolicyInput) MarshalFields added in v0.19.0 

func (s DescribeFileSystemPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFileSystemPolicyInput) String added in v0.19.0 

func (s DescribeFileSystemPolicyInput) String() string

String returns the string representation

func (*DescribeFileSystemPolicyInput) Validate added in v0.19.0 

func (s *DescribeFileSystemPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFileSystemPolicyOutput added in v0.19.0 

type DescribeFileSystemPolicyOutput struct {

	// Specifies the EFS file system to which the FileSystemPolicy applies.
	FileSystemId *string `type:"string"`

	// The JSON formatted FileSystemPolicy for the EFS file system.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemPolicyOutput) MarshalFields added in v0.19.0 

func (s DescribeFileSystemPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFileSystemPolicyOutput) String added in v0.19.0 

func (s DescribeFileSystemPolicyOutput) String() string

String returns the string representation

type DescribeFileSystemPolicyRequest added in v0.19.0 

type DescribeFileSystemPolicyRequest struct {
	*aws.Request
	Input *DescribeFileSystemPolicyInput
	Copy  func(*DescribeFileSystemPolicyInput) DescribeFileSystemPolicyRequest
}

DescribeFileSystemPolicyRequest is the request type for the DescribeFileSystemPolicy API operation.

func (DescribeFileSystemPolicyRequest) Send added in v0.19.0 

func (r DescribeFileSystemPolicyRequest) Send(ctx context.Context) (*DescribeFileSystemPolicyResponse, error)

Send marshals and sends the DescribeFileSystemPolicy API request.

type DescribeFileSystemPolicyResponse added in v0.19.0 

type DescribeFileSystemPolicyResponse struct {
	*DescribeFileSystemPolicyOutput
	// contains filtered or unexported fields
}

DescribeFileSystemPolicyResponse is the response type for the DescribeFileSystemPolicy API operation.

func (*DescribeFileSystemPolicyResponse) SDKResponseMetdata added in v0.19.0 

func (r *DescribeFileSystemPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFileSystemPolicy request.

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

	// (Optional) Restricts the list to the file system with this creation token
	// (String). You specify a creation token when you create an Amazon EFS file
	// system.
	CreationToken *string `location:"querystring" locationName:"CreationToken" min:"1" type:"string"`

	// (Optional) ID of the file system whose description you want to retrieve (String).
	FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`

	// (Optional) Opaque pagination token returned from a previous DescribeFileSystems
	// operation (String). If present, specifies to continue the list from where
	// the returning call had left off.
	Marker *string `location:"querystring" locationName:"Marker" type:"string"`

	// (Optional) Specifies the maximum number of file systems to return in the
	// response (integer). This number is automatically set to 100. The response
	// is paginated at 100 per page if you have more than 100 file systems.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsInput) MarshalFields added in v0.3.0 

func (s DescribeFileSystemsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFileSystemsInput) String 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate 

func (s *DescribeFileSystemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []FileSystemDescription `type:"list"`

	// Present if provided by caller in the request (String).
	Marker *string `type:"string"`

	// Present if there are more file systems than returned in the response (String).
	// You can use the NextMarker in the subsequent request to fetch the descriptions.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsOutput) MarshalFields added in v0.3.0 

func (s DescribeFileSystemsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFileSystemsOutput) String 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeFileSystemsPaginator added in v0.19.0 

type DescribeFileSystemsPaginator struct {
	aws.Pager
}

DescribeFileSystemsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeFileSystemsPaginator added in v0.19.0 

func NewDescribeFileSystemsPaginator(req DescribeFileSystemsRequest) DescribeFileSystemsPaginator

NewDescribeFileSystemsRequestPaginator returns a paginator for DescribeFileSystems. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeFileSystemsRequest(input)
p := efs.NewDescribeFileSystemsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeFileSystemsPaginator) CurrentPage added in v0.19.0 

func (p *DescribeFileSystemsPaginator) CurrentPage() *DescribeFileSystemsOutput

type DescribeFileSystemsRequest 

type DescribeFileSystemsRequest struct {
	*aws.Request
	Input *DescribeFileSystemsInput
	Copy  func(*DescribeFileSystemsInput) DescribeFileSystemsRequest
}

DescribeFileSystemsRequest is the request type for the DescribeFileSystems API operation.

func (DescribeFileSystemsRequest) Send 

func (r DescribeFileSystemsRequest) Send(ctx context.Context) (*DescribeFileSystemsResponse, error)

Send marshals and sends the DescribeFileSystems API request.

type DescribeFileSystemsResponse added in v0.9.0 

type DescribeFileSystemsResponse struct {
	*DescribeFileSystemsOutput
	// contains filtered or unexported fields
}

DescribeFileSystemsResponse is the response type for the DescribeFileSystems API operation.

func (*DescribeFileSystemsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeFileSystemsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFileSystems request.

type DescribeLifecycleConfigurationInput added in v0.8.0 

type DescribeLifecycleConfigurationInput struct {

	// The ID of the file system whose LifecycleConfiguration object you want to
	// retrieve (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleConfigurationInput) MarshalFields added in v0.8.0 

func (s DescribeLifecycleConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLifecycleConfigurationInput) String added in v0.8.0 

func (s DescribeLifecycleConfigurationInput) String() string

String returns the string representation

func (*DescribeLifecycleConfigurationInput) Validate added in v0.8.0 

func (s *DescribeLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLifecycleConfigurationOutput added in v0.9.0 

type DescribeLifecycleConfigurationOutput struct {

	// An array of lifecycle management policies. Currently, EFS supports a maximum
	// of one policy per file system.
	LifecyclePolicies []LifecyclePolicy `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleConfigurationOutput) MarshalFields added in v0.9.0 

func (s DescribeLifecycleConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLifecycleConfigurationOutput) String added in v0.9.0 

func (s DescribeLifecycleConfigurationOutput) String() string

String returns the string representation

type DescribeLifecycleConfigurationRequest added in v0.8.0 

type DescribeLifecycleConfigurationRequest struct {
	*aws.Request
	Input *DescribeLifecycleConfigurationInput
	Copy  func(*DescribeLifecycleConfigurationInput) DescribeLifecycleConfigurationRequest
}

DescribeLifecycleConfigurationRequest is the request type for the DescribeLifecycleConfiguration API operation.

func (DescribeLifecycleConfigurationRequest) Send added in v0.8.0 

func (r DescribeLifecycleConfigurationRequest) Send(ctx context.Context) (*DescribeLifecycleConfigurationResponse, error)

Send marshals and sends the DescribeLifecycleConfiguration API request.

type DescribeLifecycleConfigurationResponse added in v0.9.0 

type DescribeLifecycleConfigurationResponse struct {
	*DescribeLifecycleConfigurationOutput
	// contains filtered or unexported fields
}

DescribeLifecycleConfigurationResponse is the response type for the DescribeLifecycleConfiguration API operation.

func (*DescribeLifecycleConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeLifecycleConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLifecycleConfiguration request.

type DescribeMountTargetSecurityGroupsInput 

type DescribeMountTargetSecurityGroupsInput struct {

	// The ID of the mount target whose security groups you want to retrieve.
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetSecurityGroupsInput) MarshalFields added in v0.3.0 

func (s DescribeMountTargetSecurityGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeMountTargetSecurityGroupsInput) String 

func (s DescribeMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) Validate 

func (s *DescribeMountTargetSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMountTargetSecurityGroupsOutput 

type DescribeMountTargetSecurityGroupsOutput struct {

	// An array of security groups.
	//
	// SecurityGroups is a required field
	SecurityGroups []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetSecurityGroupsOutput) MarshalFields added in v0.3.0 

func (s DescribeMountTargetSecurityGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeMountTargetSecurityGroupsOutput) String 

func (s DescribeMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type DescribeMountTargetSecurityGroupsRequest 

type DescribeMountTargetSecurityGroupsRequest struct {
	*aws.Request
	Input *DescribeMountTargetSecurityGroupsInput
	Copy  func(*DescribeMountTargetSecurityGroupsInput) DescribeMountTargetSecurityGroupsRequest
}

DescribeMountTargetSecurityGroupsRequest is the request type for the DescribeMountTargetSecurityGroups API operation.

func (DescribeMountTargetSecurityGroupsRequest) Send 

func (r DescribeMountTargetSecurityGroupsRequest) Send(ctx context.Context) (*DescribeMountTargetSecurityGroupsResponse, error)

Send marshals and sends the DescribeMountTargetSecurityGroups API request.

type DescribeMountTargetSecurityGroupsResponse added in v0.9.0 

type DescribeMountTargetSecurityGroupsResponse struct {
	*DescribeMountTargetSecurityGroupsOutput
	// contains filtered or unexported fields
}

DescribeMountTargetSecurityGroupsResponse is the response type for the DescribeMountTargetSecurityGroups API operation.

func (*DescribeMountTargetSecurityGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeMountTargetSecurityGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeMountTargetSecurityGroups request.

type DescribeMountTargetsInput 

type DescribeMountTargetsInput struct {

	// (Optional) The ID of the access point whose mount targets that you want to
	// list. It must be included in your request if a FileSystemId or MountTargetId
	// is not included in your request. Accepts either an access point ID or ARN
	// as input.
	AccessPointId *string `location:"querystring" locationName:"AccessPointId" type:"string"`

	// (Optional) ID of the file system whose mount targets you want to list (String).
	// It must be included in your request if an AccessPointId or MountTargetId
	// is not included. Accepts either a file system ID or ARN as input.
	FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`

	// (Optional) Opaque pagination token returned from a previous DescribeMountTargets
	// operation (String). If present, it specifies to continue the list from where
	// the previous returning call left off.
	Marker *string `location:"querystring" locationName:"Marker" type:"string"`

	// (Optional) Maximum number of mount targets to return in the response. Currently,
	// this number is automatically set to 10, and other values are ignored. The
	// response is paginated at 100 per page if you have more than 100 mount targets.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`

	// (Optional) ID of the mount target that you want to have described (String).
	// It must be included in your request if FileSystemId is not included. Accepts
	// either a mount target ID or ARN as input.
	MountTargetId *string `location:"querystring" locationName:"MountTargetId" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsInput) MarshalFields added in v0.3.0 

func (s DescribeMountTargetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeMountTargetsInput) String 

func (s DescribeMountTargetsInput) String() string

String returns the string representation

func (*DescribeMountTargetsInput) Validate 

func (s *DescribeMountTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMountTargetsOutput 

type DescribeMountTargetsOutput struct {

	// If the request included the Marker, the response returns that value in this
	// field.
	Marker *string `type:"string"`

	// Returns the file system's mount targets as an array of MountTargetDescription
	// objects.
	MountTargets []MountTargetDescription `type:"list"`

	// If a value is present, there are more mount targets to return. In a subsequent
	// request, you can provide Marker in your request with this value to retrieve
	// the next set of mount targets.
	NextMarker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsOutput) MarshalFields added in v0.3.0 

func (s DescribeMountTargetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeMountTargetsOutput) String 

func (s DescribeMountTargetsOutput) String() string

String returns the string representation

type DescribeMountTargetsRequest 

type DescribeMountTargetsRequest struct {
	*aws.Request
	Input *DescribeMountTargetsInput
	Copy  func(*DescribeMountTargetsInput) DescribeMountTargetsRequest
}

DescribeMountTargetsRequest is the request type for the DescribeMountTargets API operation.

func (DescribeMountTargetsRequest) Send 

func (r DescribeMountTargetsRequest) Send(ctx context.Context) (*DescribeMountTargetsResponse, error)

Send marshals and sends the DescribeMountTargets API request.

type DescribeMountTargetsResponse added in v0.9.0 

type DescribeMountTargetsResponse struct {
	*DescribeMountTargetsOutput
	// contains filtered or unexported fields
}

DescribeMountTargetsResponse is the response type for the DescribeMountTargets API operation.

func (*DescribeMountTargetsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeMountTargetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeMountTargets request.

type DescribeTagsInput 

type DescribeTagsInput struct {

	// The ID of the file system whose tag set you want to retrieve.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// (Optional) An opaque pagination token returned from a previous DescribeTags
	// operation (String). If present, it specifies to continue the list from where
	// the previous call left off.
	Marker *string `location:"querystring" locationName:"Marker" type:"string"`

	// (Optional) The maximum number of file system tags to return in the response.
	// Currently, this number is automatically set to 100, and other values are
	// ignored. The response is paginated at 100 per page if you have more than
	// 100 tags.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) MarshalFields added in v0.3.0 

func (s DescribeTagsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeTagsInput) String 

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate 

func (s *DescribeTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTagsOutput 

type DescribeTagsOutput struct {

	// If the request included a Marker, the response returns that value in this
	// field.
	Marker *string `type:"string"`

	// If a value is present, there are more tags to return. In a subsequent request,
	// you can provide the value of NextMarker as the value of the Marker parameter
	// in your next request to retrieve the next set of tags.
	NextMarker *string `type:"string"`

	// Returns tags associated with the file system as an array of Tag objects.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTagsOutput) MarshalFields added in v0.3.0 

func (s DescribeTagsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeTagsOutput) String 

func (s DescribeTagsOutput) String() string

String returns the string representation

type DescribeTagsPaginator added in v0.19.0 

type DescribeTagsPaginator struct {
	aws.Pager
}

DescribeTagsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeTagsPaginator added in v0.19.0 

func NewDescribeTagsPaginator(req DescribeTagsRequest) DescribeTagsPaginator

NewDescribeTagsRequestPaginator returns a paginator for DescribeTags. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeTagsRequest(input)
p := efs.NewDescribeTagsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeTagsPaginator) CurrentPage added in v0.19.0 

func (p *DescribeTagsPaginator) CurrentPage() *DescribeTagsOutput

type DescribeTagsRequest 

type DescribeTagsRequest struct {
	*aws.Request
	Input *DescribeTagsInput
	Copy  func(*DescribeTagsInput) DescribeTagsRequest
}

DescribeTagsRequest is the request type for the DescribeTags API operation.

func (DescribeTagsRequest) Send 

func (r DescribeTagsRequest) Send(ctx context.Context) (*DescribeTagsResponse, error)

Send marshals and sends the DescribeTags API request.

type DescribeTagsResponse added in v0.9.0 

type DescribeTagsResponse struct {
	*DescribeTagsOutput
	// contains filtered or unexported fields
}

DescribeTagsResponse is the response type for the DescribeTags API operation.

func (*DescribeTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTags request.

type FileSystemDescription added in v0.9.0 

type FileSystemDescription struct {

	// The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The opaque string specified in the request.
	//
	// CreationToken is a required field
	CreationToken *string `min:"1" type:"string" required:"true"`

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool `type:"boolean"`

	// The ID of the file system, assigned by Amazon EFS.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK)
	// that was used to protect the encrypted file system.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle phase of the file system.
	//
	// LifeCycleState is a required field
	LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`

	// 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 `type:"string"`

	// The current number of mount targets that the file system has. For more information,
	// see CreateMountTarget.
	//
	// NumberOfMountTargets is a required field
	NumberOfMountTargets *int64 `type:"integer" required:"true"`

	// The AWS 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.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

	// The performance mode of the file system.
	//
	// PerformanceMode is a required field
	PerformanceMode PerformanceMode `type:"string" required:"true" enum:"true"`

	// The throughput, measured in MiB/s, that you want to provision for a file
	// system. Valid values are 1-1024. Required if ThroughputMode is set to provisioned.
	// 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 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// 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.
	//
	// SizeInBytes is a required field
	SizeInBytes *FileSystemSize `type:"structure" required:"true"`

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`

	// The throughput mode for a file system. There are two throughput modes to
	// choose from for your file system: bursting and provisioned. If you set ThroughputMode
	// to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// 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.
	ThroughputMode ThroughputMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A description of the file system.

func (FileSystemDescription) MarshalFields added in v0.9.0 

func (s FileSystemDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FileSystemDescription) String added in v0.9.0 

func (s FileSystemDescription) String() string

String returns the string representation

type FileSystemSize 

type FileSystemSize struct {

	// 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 `type:"timestamp"`

	// The latest known metered size (in bytes) of data stored in the file system.
	//
	// Value is a required field
	Value *int64 `type:"long" required:"true"`

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

	// The latest known metered size (in bytes) of data stored in the Standard storage
	// class.
	ValueInStandard *int64 `type:"long"`
	// 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.

func (FileSystemSize) MarshalFields added in v0.3.0 

func (s FileSystemSize) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FileSystemSize) String 

func (s FileSystemSize) String() string

String returns the string representation

type LifeCycleState 

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

Enum values for LifeCycleState

func (LifeCycleState) MarshalValue added in v0.3.0 

func (enum LifeCycleState) MarshalValue() (string, error)

func (LifeCycleState) MarshalValueBuf added in v0.3.0 

func (enum LifeCycleState) MarshalValueBuf(b []byte) ([]byte, error)

type LifecyclePolicy added in v0.8.0 

type LifecyclePolicy struct {

	// A value that describes the period of time that a file is not accessed, after
	// which it transitions to the IA storage class. Metadata operations such as
	// listing the contents of a directory don't count as file access events.
	TransitionToIA TransitionToIARules `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

func (LifecyclePolicy) MarshalFields added in v0.8.0 

func (s LifecyclePolicy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecyclePolicy) String added in v0.8.0 

func (s LifecyclePolicy) String() string

String returns the string representation

type ListTagsForResourceInput added in v0.19.0 

type ListTagsForResourceInput struct {

	// (Optional) Specifies the maximum number of tag objects to return in the response.
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// You can use NextToken in a subsequent request to fetch the next page of access
	// point descriptions if the response payload was paginated.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// Specifies the EFS resource you want to retrieve tags for. You can retrieve
	// tags for EFS file systems and access points using this API endpoint.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.19.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.19.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.19.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.19.0 

type ListTagsForResourceOutput struct {

	// NextToken is present if the response payload is paginated. You can use NextToken
	// in a subsequent request to fetch the next page of access point descriptions.
	NextToken *string `type:"string"`

	// An array of the tags for the specified EFS resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.19.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.19.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator added in v0.19.0 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator added in v0.19.0 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := efs.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage added in v0.19.0 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest added in v0.19.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.19.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.19.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ModifyMountTargetSecurityGroupsInput 

type ModifyMountTargetSecurityGroupsInput struct {

	// The ID of the mount target whose security groups you want to modify.
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`

	// An array of up to five VPC security group IDs.
	SecurityGroups []string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyMountTargetSecurityGroupsInput) MarshalFields added in v0.3.0 

func (s ModifyMountTargetSecurityGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ModifyMountTargetSecurityGroupsInput) String 

func (s ModifyMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) Validate 

func (s *ModifyMountTargetSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyMountTargetSecurityGroupsOutput 

type ModifyMountTargetSecurityGroupsOutput struct {
	// contains filtered or unexported fields
}

func (ModifyMountTargetSecurityGroupsOutput) MarshalFields added in v0.3.0 

func (s ModifyMountTargetSecurityGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ModifyMountTargetSecurityGroupsOutput) String 

func (s ModifyMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type ModifyMountTargetSecurityGroupsRequest 

type ModifyMountTargetSecurityGroupsRequest struct {
	*aws.Request
	Input *ModifyMountTargetSecurityGroupsInput
	Copy  func(*ModifyMountTargetSecurityGroupsInput) ModifyMountTargetSecurityGroupsRequest
}

ModifyMountTargetSecurityGroupsRequest is the request type for the ModifyMountTargetSecurityGroups API operation.

func (ModifyMountTargetSecurityGroupsRequest) Send 

func (r ModifyMountTargetSecurityGroupsRequest) Send(ctx context.Context) (*ModifyMountTargetSecurityGroupsResponse, error)

Send marshals and sends the ModifyMountTargetSecurityGroups API request.

type ModifyMountTargetSecurityGroupsResponse added in v0.9.0 

type ModifyMountTargetSecurityGroupsResponse struct {
	*ModifyMountTargetSecurityGroupsOutput
	// contains filtered or unexported fields
}

ModifyMountTargetSecurityGroupsResponse is the response type for the ModifyMountTargetSecurityGroups API operation.

func (*ModifyMountTargetSecurityGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyMountTargetSecurityGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyMountTargetSecurityGroups request.

type MountTargetDescription added in v0.9.0 

type MountTargetDescription struct {

	// The unique and consistent identifier of the Availability Zone (AZ) 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 AWS account.
	AvailabilityZoneId *string `type:"string"`

	// The name of the Availability Zone (AZ) that the mount target resides in.
	// AZs are independently mapped to names for each AWS account. For example,
	// the Availability Zone us-east-1a for your AWS account might not be the same
	// location as us-east-1a for another AWS account.
	AvailabilityZoneName *string `type:"string"`

	// The ID of the file system for which the mount target is intended.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

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

	// Lifecycle state of the mount target.
	//
	// LifeCycleState is a required field
	LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`

	// System-assigned mount target ID.
	//
	// MountTargetId is a required field
	MountTargetId *string `type:"string" required:"true"`

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

	// AWS account ID that owns the resource.
	OwnerId *string `type:"string"`

	// The ID of the mount target's subnet.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides a description of a mount target.

func (MountTargetDescription) MarshalFields added in v0.9.0 

func (s MountTargetDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MountTargetDescription) String added in v0.9.0 

func (s MountTargetDescription) String() string

String returns the string representation

type PerformanceMode 

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

Enum values for PerformanceMode

func (PerformanceMode) MarshalValue added in v0.3.0 

func (enum PerformanceMode) MarshalValue() (string, error)

func (PerformanceMode) MarshalValueBuf added in v0.3.0 

func (enum PerformanceMode) MarshalValueBuf(b []byte) ([]byte, error)

type PosixUser added in v0.19.0 

type PosixUser struct {

	// The POSIX group ID used for all file system operations using this access
	// point.
	//
	// Gid is a required field
	Gid *int64 `type:"long" required:"true"`

	// Secondary POSIX group IDs used for all file system operations using this
	// access point.
	SecondaryGids []int64 `type:"list"`

	// The POSIX user ID used for all file system operations using this access point.
	//
	// Uid is a required field
	Uid *int64 `type:"long" required:"true"`
	// 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.

func (PosixUser) MarshalFields added in v0.19.0 

func (s PosixUser) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PosixUser) String added in v0.19.0 

func (s PosixUser) String() string

String returns the string representation

func (*PosixUser) Validate added in v0.19.0 

func (s *PosixUser) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutFileSystemPolicyInput added in v0.19.0 

type PutFileSystemPolicyInput struct {

	// (Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout
	// safety check. The policy lockout safety check determines whether the policy
	// in the request will prevent the principal making the request will be locked
	// out from making future PutFileSystemPolicy requests on the file system. Set
	// BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the
	// principal that is making the request from making a subsequent PutFileSystemPolicy
	// request on the file system. The default value is False.
	BypassPolicyLockoutSafetyCheck *bool `type:"boolean"`

	// The ID of the EFS file system that you want to create or update the FileSystemPolicy
	// for.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// The FileSystemPolicy that you're creating. Accepts a JSON formatted policy
	// definition. To find out more about the elements that make up a file system
	// policy, see EFS Resource-based Policies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies).
	//
	// Policy is a required field
	Policy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutFileSystemPolicyInput) MarshalFields added in v0.19.0 

func (s PutFileSystemPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutFileSystemPolicyInput) String added in v0.19.0 

func (s PutFileSystemPolicyInput) String() string

String returns the string representation

func (*PutFileSystemPolicyInput) Validate added in v0.19.0 

func (s *PutFileSystemPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutFileSystemPolicyOutput added in v0.19.0 

type PutFileSystemPolicyOutput struct {

	// Specifies the EFS file system to which the FileSystemPolicy applies.
	FileSystemId *string `type:"string"`

	// The JSON formatted FileSystemPolicy for the EFS file system.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutFileSystemPolicyOutput) MarshalFields added in v0.19.0 

func (s PutFileSystemPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutFileSystemPolicyOutput) String added in v0.19.0 

func (s PutFileSystemPolicyOutput) String() string

String returns the string representation

type PutFileSystemPolicyRequest added in v0.19.0 

type PutFileSystemPolicyRequest struct {
	*aws.Request
	Input *PutFileSystemPolicyInput
	Copy  func(*PutFileSystemPolicyInput) PutFileSystemPolicyRequest
}

PutFileSystemPolicyRequest is the request type for the PutFileSystemPolicy API operation.

func (PutFileSystemPolicyRequest) Send added in v0.19.0 

func (r PutFileSystemPolicyRequest) Send(ctx context.Context) (*PutFileSystemPolicyResponse, error)

Send marshals and sends the PutFileSystemPolicy API request.

type PutFileSystemPolicyResponse added in v0.19.0 

type PutFileSystemPolicyResponse struct {
	*PutFileSystemPolicyOutput
	// contains filtered or unexported fields
}

PutFileSystemPolicyResponse is the response type for the PutFileSystemPolicy API operation.

func (*PutFileSystemPolicyResponse) SDKResponseMetdata added in v0.19.0 

func (r *PutFileSystemPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutFileSystemPolicy request.

type PutLifecycleConfigurationInput added in v0.8.0 

type PutLifecycleConfigurationInput struct {

	// The ID of the file system for which you are creating the LifecycleConfiguration
	// object (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration
	// object. A LifecycleConfiguration object tells lifecycle management when to
	// transition files from the Standard storage class to the Infrequent Access
	// storage class.
	//
	// LifecyclePolicies is a required field
	LifecyclePolicies []LifecyclePolicy `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutLifecycleConfigurationInput) MarshalFields added in v0.8.0 

func (s PutLifecycleConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLifecycleConfigurationInput) String added in v0.8.0 

func (s PutLifecycleConfigurationInput) String() string

String returns the string representation

func (*PutLifecycleConfigurationInput) Validate added in v0.8.0 

func (s *PutLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLifecycleConfigurationOutput added in v0.8.0 

type PutLifecycleConfigurationOutput struct {

	// An array of lifecycle management policies. Currently, EFS supports a maximum
	// of one policy per file system.
	LifecyclePolicies []LifecyclePolicy `type:"list"`
	// contains filtered or unexported fields
}

func (PutLifecycleConfigurationOutput) MarshalFields added in v0.8.0 

func (s PutLifecycleConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLifecycleConfigurationOutput) String added in v0.8.0 

func (s PutLifecycleConfigurationOutput) String() string

String returns the string representation

type PutLifecycleConfigurationRequest added in v0.8.0 

type PutLifecycleConfigurationRequest struct {
	*aws.Request
	Input *PutLifecycleConfigurationInput
	Copy  func(*PutLifecycleConfigurationInput) PutLifecycleConfigurationRequest
}

PutLifecycleConfigurationRequest is the request type for the PutLifecycleConfiguration API operation.

func (PutLifecycleConfigurationRequest) Send added in v0.8.0 

func (r PutLifecycleConfigurationRequest) Send(ctx context.Context) (*PutLifecycleConfigurationResponse, error)

Send marshals and sends the PutLifecycleConfiguration API request.

type PutLifecycleConfigurationResponse added in v0.9.0 

type PutLifecycleConfigurationResponse struct {
	*PutLifecycleConfigurationOutput
	// contains filtered or unexported fields
}

PutLifecycleConfigurationResponse is the response type for the PutLifecycleConfiguration API operation.

func (*PutLifecycleConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutLifecycleConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutLifecycleConfiguration request.

type RootDirectory added in v0.19.0 

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 `type:"structure"`

	// 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 `min:"1" type:"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.

func (RootDirectory) MarshalFields added in v0.19.0 

func (s RootDirectory) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RootDirectory) String added in v0.19.0 

func (s RootDirectory) String() string

String returns the string representation

func (*RootDirectory) Validate added in v0.19.0 

func (s *RootDirectory) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag 

type Tag struct {

	// The tag key (String). The key can't start with aws:.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// 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:+ - = . _ : /

func (Tag) MarshalFields added in v0.3.0 

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v0.19.0 

type TagResourceInput struct {

	// The ID specifying the EFS resource that you want to create a tag for.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`

	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.19.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.19.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.19.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.19.0 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) MarshalFields added in v0.19.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.19.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.19.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.19.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.19.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type ThroughputMode added in v0.5.0 

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

Enum values for ThroughputMode

func (ThroughputMode) MarshalValue added in v0.5.0 

func (enum ThroughputMode) MarshalValue() (string, error)

func (ThroughputMode) MarshalValueBuf added in v0.5.0 

func (enum ThroughputMode) MarshalValueBuf(b []byte) ([]byte, error)

type TransitionToIARules added in v0.8.0 

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) MarshalValue added in v0.8.0 

func (enum TransitionToIARules) MarshalValue() (string, error)

func (TransitionToIARules) MarshalValueBuf added in v0.8.0 

func (enum TransitionToIARules) MarshalValueBuf(b []byte) ([]byte, error)

type UntagResourceInput added in v0.19.0 

type UntagResourceInput struct {

	// Specifies the EFS resource that you want to remove tags from.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`

	// The keys of the key:value tag pairs that you want to remove from the specified
	// EFS resource.
	TagKeys []string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.19.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.19.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.19.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.19.0 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) MarshalFields added in v0.19.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.19.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.19.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.19.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.19.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.19.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateFileSystemInput added in v0.5.0 

type UpdateFileSystemInput struct {

	// The ID of the file system that you want to update.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// (Optional) The amount of throughput, in MiB/s, that you want to provision
	// for your file system. Valid values are 1-1024. Required if ThroughputMode
	// is changed to provisioned on update. If you're not updating the amount of
	// provisioned throughput for your file system, you don't need to provide this
	// value in your request.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// (Optional) The throughput mode that you want your file system to use. If
	// you're not updating your throughput mode, you don't need to provide this
	// value in your request. If you are changing the ThroughputMode to provisioned,
	// you must also set a value for ProvisionedThroughputInMibps.
	ThroughputMode ThroughputMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemInput) MarshalFields added in v0.5.0 

func (s UpdateFileSystemInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFileSystemInput) String added in v0.5.0 

func (s UpdateFileSystemInput) String() string

String returns the string representation

func (*UpdateFileSystemInput) Validate added in v0.5.0 

func (s *UpdateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFileSystemOutput added in v0.5.0 

type UpdateFileSystemOutput struct {

	// The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The opaque string specified in the request.
	//
	// CreationToken is a required field
	CreationToken *string `min:"1" type:"string" required:"true"`

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool `type:"boolean"`

	// The ID of the file system, assigned by Amazon EFS.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK)
	// that was used to protect the encrypted file system.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle phase of the file system.
	//
	// LifeCycleState is a required field
	LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`

	// 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 `type:"string"`

	// The current number of mount targets that the file system has. For more information,
	// see CreateMountTarget.
	//
	// NumberOfMountTargets is a required field
	NumberOfMountTargets *int64 `type:"integer" required:"true"`

	// The AWS 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.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

	// The performance mode of the file system.
	//
	// PerformanceMode is a required field
	PerformanceMode PerformanceMode `type:"string" required:"true" enum:"true"`

	// The throughput, measured in MiB/s, that you want to provision for a file
	// system. Valid values are 1-1024. Required if ThroughputMode is set to provisioned.
	// 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 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// 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.
	//
	// SizeInBytes is a required field
	SizeInBytes *FileSystemSize `type:"structure" required:"true"`

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`

	// The throughput mode for a file system. There are two throughput modes to
	// choose from for your file system: bursting and provisioned. If you set ThroughputMode
	// to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// 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.
	ThroughputMode ThroughputMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A description of the file system.

func (UpdateFileSystemOutput) MarshalFields added in v0.5.0 

func (s UpdateFileSystemOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFileSystemOutput) String added in v0.5.0 

func (s UpdateFileSystemOutput) String() string

String returns the string representation

type UpdateFileSystemRequest added in v0.5.0 

type UpdateFileSystemRequest struct {
	*aws.Request
	Input *UpdateFileSystemInput
	Copy  func(*UpdateFileSystemInput) UpdateFileSystemRequest
}

UpdateFileSystemRequest is the request type for the UpdateFileSystem API operation.

func (UpdateFileSystemRequest) Send added in v0.5.0 

func (r UpdateFileSystemRequest) Send(ctx context.Context) (*UpdateFileSystemResponse, error)

Send marshals and sends the UpdateFileSystem API request.

type UpdateFileSystemResponse added in v0.9.0 

type UpdateFileSystemResponse struct {
	*UpdateFileSystemOutput
	// contains filtered or unexported fields
}

UpdateFileSystemResponse is the response type for the UpdateFileSystem API operation.

func (*UpdateFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFileSystem request.

Source Files

View all Source files

Directories

Path Synopsis
Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.
 Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.

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.