efs

package
v1.5.1 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package efs provides a client for Amazon Elastic File System.

Index

Examples

Constants

View Source 
const (
	// LifeCycleStateCreating is a LifeCycleState enum value
	LifeCycleStateCreating = "creating"

	// LifeCycleStateAvailable is a LifeCycleState enum value
	LifeCycleStateAvailable = "available"

	// LifeCycleStateDeleting is a LifeCycleState enum value
	LifeCycleStateDeleting = "deleting"

	// LifeCycleStateDeleted is a LifeCycleState enum value
	LifeCycleStateDeleted = "deleted"
)
View Source 
const (
	// PerformanceModeGeneralPurpose is a PerformanceMode enum value
	PerformanceModeGeneralPurpose = "generalPurpose"

	// PerformanceModeMaxIo is a PerformanceMode enum value
	PerformanceModeMaxIo = "maxIO"
)
View Source 
const ServiceName = "elasticfilesystem"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// 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"`

	// The PerformanceMode of the file system. We recommend generalPurpose performance
	// mode for most file systems. File systems using the maxIO performance mode
	// can scale to higher levels of aggregate throughput and operations per second
	// with a tradeoff of slightly higher latencies for most file operations. This
	// can't be changed after the file system has been created.
	PerformanceMode *string `type:"string" enum:"PerformanceMode"`
	// contains filtered or unexported fields
}

func (CreateFileSystemInput) GoString added in v0.6.6 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation

func (*CreateFileSystemInput) SetCreationToken added in v1.5.1 

func (s *CreateFileSystemInput) SetCreationToken(v string) *CreateFileSystemInput

SetCreationToken sets the CreationToken field's value.

func (*CreateFileSystemInput) SetPerformanceMode added in v1.5.1 

func (s *CreateFileSystemInput) SetPerformanceMode(v string) *CreateFileSystemInput

SetPerformanceMode sets the PerformanceMode field's value.

func (CreateFileSystemInput) String added in v0.6.6 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate added in v1.1.24 

func (s *CreateFileSystemInput) Validate() error

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

type CreateMountTargetInput 

type CreateMountTargetInput struct {

	// 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"`

	// 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) GoString added in v0.6.6 

func (s CreateMountTargetInput) GoString() string

GoString returns the string representation

func (*CreateMountTargetInput) SetFileSystemId added in v1.5.1 

func (s *CreateMountTargetInput) SetFileSystemId(v string) *CreateMountTargetInput

SetFileSystemId sets the FileSystemId field's value.

func (*CreateMountTargetInput) SetIpAddress added in v1.5.1 

func (s *CreateMountTargetInput) SetIpAddress(v string) *CreateMountTargetInput

SetIpAddress sets the IpAddress field's value.

func (*CreateMountTargetInput) SetSecurityGroups added in v1.5.1 

func (s *CreateMountTargetInput) SetSecurityGroups(v []*string) *CreateMountTargetInput

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateMountTargetInput) SetSubnetId added in v1.5.1 

func (s *CreateMountTargetInput) SetSubnetId(v string) *CreateMountTargetInput

SetSubnetId sets the SubnetId field's value.

func (CreateMountTargetInput) String added in v0.6.6 

func (s CreateMountTargetInput) String() string

String returns the string representation

func (*CreateMountTargetInput) Validate added in v1.1.24 

func (s *CreateMountTargetInput) Validate() error

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

type CreateTagsInput 

type CreateTagsInput struct {

	// 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"`

	// 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) GoString added in v0.6.6 

func (s CreateTagsInput) GoString() string

GoString returns the string representation

func (*CreateTagsInput) SetFileSystemId added in v1.5.1 

func (s *CreateTagsInput) SetFileSystemId(v string) *CreateTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*CreateTagsInput) SetTags added in v1.5.1 

func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput

SetTags sets the Tags field's value.

func (CreateTagsInput) String added in v0.6.6 

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation

func (CreateTagsOutput) String added in v0.6.6 

func (s CreateTagsOutput) String() string

String returns the string representation

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// 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) GoString added in v0.6.6 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation

func (*DeleteFileSystemInput) SetFileSystemId added in v1.5.1 

func (s *DeleteFileSystemInput) SetFileSystemId(v string) *DeleteFileSystemInput

SetFileSystemId sets the FileSystemId field's value.

func (DeleteFileSystemInput) String added in v0.6.6 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation

func (DeleteFileSystemOutput) String added in v0.6.6 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteMountTargetInput 

type DeleteMountTargetInput struct {

	// 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) GoString added in v0.6.6 

func (s DeleteMountTargetInput) GoString() string

GoString returns the string representation

func (*DeleteMountTargetInput) SetMountTargetId added in v1.5.1 

func (s *DeleteMountTargetInput) SetMountTargetId(v string) *DeleteMountTargetInput

SetMountTargetId sets the MountTargetId field's value.

func (DeleteMountTargetInput) String added in v0.6.6 

func (s DeleteMountTargetInput) String() string

String returns the string representation

func (*DeleteMountTargetInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s DeleteMountTargetOutput) GoString() string

GoString returns the string representation

func (DeleteMountTargetOutput) String added in v0.6.6 

func (s DeleteMountTargetOutput) String() string

String returns the string representation

type DeleteTagsInput 

type DeleteTagsInput struct {

	// 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"`

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

func (DeleteTagsInput) GoString added in v0.6.6 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation

func (*DeleteTagsInput) SetFileSystemId added in v1.5.1 

func (s *DeleteTagsInput) SetFileSystemId(v string) *DeleteTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteTagsInput) SetTagKeys added in v1.5.1 

func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String added in v0.6.6 

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation

func (DeleteTagsOutput) String added in v0.6.6 

func (s DeleteTagsOutput) String() string

String returns the string representation

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 parameter value must be greater than 0. The number
	// of items that Amazon EFS returns is the minimum of the MaxItems parameter
	// specified in the request and the service's internal maximum number of items
	// per page.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsInput) GoString added in v0.6.6 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsInput) SetCreationToken added in v1.5.1 

func (s *DescribeFileSystemsInput) SetCreationToken(v string) *DescribeFileSystemsInput

SetCreationToken sets the CreationToken field's value.

func (*DescribeFileSystemsInput) SetFileSystemId added in v1.5.1 

func (s *DescribeFileSystemsInput) SetFileSystemId(v string) *DescribeFileSystemsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemsInput) SetMarker added in v1.5.1 

func (s *DescribeFileSystemsInput) SetMarker(v string) *DescribeFileSystemsInput

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsInput) SetMaxItems added in v1.5.1 

func (s *DescribeFileSystemsInput) SetMaxItems(v int64) *DescribeFileSystemsInput

SetMaxItems sets the MaxItems field's value.

func (DescribeFileSystemsInput) String added in v0.6.6 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate added in v1.1.24 

func (s *DescribeFileSystemsInput) Validate() error

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

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// 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) GoString added in v0.6.6 

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsOutput) SetFileSystems added in v1.5.1 

func (s *DescribeFileSystemsOutput) SetFileSystems(v []*FileSystemDescription) *DescribeFileSystemsOutput

SetFileSystems sets the FileSystems field's value.

func (*DescribeFileSystemsOutput) SetMarker added in v1.5.1 

func (s *DescribeFileSystemsOutput) SetMarker(v string) *DescribeFileSystemsOutput

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsOutput) SetNextMarker added in v1.5.1 

func (s *DescribeFileSystemsOutput) SetNextMarker(v string) *DescribeFileSystemsOutput

SetNextMarker sets the NextMarker field's value.

func (DescribeFileSystemsOutput) String added in v0.6.6 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeMountTargetSecurityGroupsInput 

type DescribeMountTargetSecurityGroupsInput struct {

	// 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) GoString added in v0.6.6 

func (s DescribeMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.1 

func (s *DescribeMountTargetSecurityGroupsInput) SetMountTargetId(v string) *DescribeMountTargetSecurityGroupsInput

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetSecurityGroupsInput) String added in v0.6.6 

func (s DescribeMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) Validate added in v1.1.24 

func (s *DescribeMountTargetSecurityGroupsInput) Validate() error

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

type DescribeMountTargetSecurityGroupsOutput 

type DescribeMountTargetSecurityGroupsOutput struct {

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

func (DescribeMountTargetSecurityGroupsOutput) GoString added in v0.6.6 

func (s DescribeMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups added in v1.5.1 

func (s *DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups(v []*string) *DescribeMountTargetSecurityGroupsOutput

SetSecurityGroups sets the SecurityGroups field's value.

func (DescribeMountTargetSecurityGroupsOutput) String added in v0.6.6 

func (s DescribeMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type DescribeMountTargetsInput 

type DescribeMountTargetsInput struct {

	// (Optional) ID of the file system whose mount targets you want to list (String).
	// It must be included in your request if MountTargetId is not included.
	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. It
	// must be an integer with a value greater than zero.
	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.
	MountTargetId *string `location:"querystring" locationName:"MountTargetId" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsInput) GoString added in v0.6.6 

func (s DescribeMountTargetsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsInput) SetFileSystemId added in v1.5.1 

func (s *DescribeMountTargetsInput) SetFileSystemId(v string) *DescribeMountTargetsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeMountTargetsInput) SetMarker added in v1.5.1 

func (s *DescribeMountTargetsInput) SetMarker(v string) *DescribeMountTargetsInput

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsInput) SetMaxItems added in v1.5.1 

func (s *DescribeMountTargetsInput) SetMaxItems(v int64) *DescribeMountTargetsInput

SetMaxItems sets the MaxItems field's value.

func (*DescribeMountTargetsInput) SetMountTargetId added in v1.5.1 

func (s *DescribeMountTargetsInput) SetMountTargetId(v string) *DescribeMountTargetsInput

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetsInput) String added in v0.6.6 

func (s DescribeMountTargetsInput) String() string

String returns the string representation

func (*DescribeMountTargetsInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s DescribeMountTargetsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsOutput) SetMarker added in v1.5.1 

func (s *DescribeMountTargetsOutput) SetMarker(v string) *DescribeMountTargetsOutput

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsOutput) SetMountTargets added in v1.5.1 

func (s *DescribeMountTargetsOutput) SetMountTargets(v []*MountTargetDescription) *DescribeMountTargetsOutput

SetMountTargets sets the MountTargets field's value.

func (*DescribeMountTargetsOutput) SetNextMarker added in v1.5.1 

func (s *DescribeMountTargetsOutput) SetNextMarker(v string) *DescribeMountTargetsOutput

SetNextMarker sets the NextMarker field's value.

func (DescribeMountTargetsOutput) String added in v0.6.6 

func (s DescribeMountTargetsOutput) String() string

String returns the string representation

type DescribeTagsInput 

type DescribeTagsInput struct {

	// 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) 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) Maximum number of file system tags to return in the response.
	// It must be an integer with a value greater than zero.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) GoString added in v0.6.6 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (*DescribeTagsInput) SetFileSystemId added in v1.5.1 

func (s *DescribeTagsInput) SetFileSystemId(v string) *DescribeTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeTagsInput) SetMarker added in v1.5.1 

func (s *DescribeTagsInput) SetMarker(v string) *DescribeTagsInput

SetMarker sets the Marker field's value.

func (*DescribeTagsInput) SetMaxItems added in v1.5.1 

func (s *DescribeTagsInput) SetMaxItems(v int64) *DescribeTagsInput

SetMaxItems sets the MaxItems field's value.

func (DescribeTagsInput) String added in v0.6.6 

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (*DescribeTagsOutput) SetMarker added in v1.5.1 

func (s *DescribeTagsOutput) SetMarker(v string) *DescribeTagsOutput

SetMarker sets the Marker field's value.

func (*DescribeTagsOutput) SetNextMarker added in v1.5.1 

func (s *DescribeTagsOutput) SetNextMarker(v string) *DescribeTagsOutput

SetNextMarker sets the NextMarker field's value.

func (*DescribeTagsOutput) SetTags added in v1.5.1 

func (s *DescribeTagsOutput) SetTags(v []*Tag) *DescribeTagsOutput

SetTags sets the Tags field's value.

func (DescribeTagsOutput) String added in v0.6.6 

func (s DescribeTagsOutput) String() string

String returns the string representation

type EFS 

type EFS struct {
	*client.Client
}

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 (http://docs.aws.amazon.com/efs/latest/ug/api-reference.html). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *EFS

New creates a new instance of the EFS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a EFS client from just a session.
svc := efs.New(mySession)

// Create a EFS client with additional configuration
svc := efs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*EFS) CreateFileSystem 

func (c *EFS) CreateFileSystem(input *CreateFileSystemInput) (*FileSystemDescription, error)

CreateFileSystem 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 (http://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 via the mount target. For more information, see Amazon EFS: How it Works (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation CreateFileSystem for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

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

  • FileSystemLimitExceeded Returned if the AWS account has already created maximum number of file systems allowed per account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.CreateFileSystemInput{
		CreationToken:   aws.String("CreationToken"), // Required
		PerformanceMode: aws.String("PerformanceMode"),
	}
	resp, err := svc.CreateFileSystem(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) CreateFileSystemRequest 

func (c *EFS) CreateFileSystemRequest(input *CreateFileSystemInput) (req *request.Request, output *FileSystemDescription)

CreateFileSystemRequest generates a "aws/request.Request" representing the client's request for the CreateFileSystem operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateFileSystem for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFileSystem method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateFileSystemRequest method.
req, resp := client.CreateFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) CreateMountTarget 

func (c *EFS) CreateMountTarget(input *CreateMountTargetInput) (*MountTargetDescription, error)
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.CreateMountTargetInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		SubnetId:     aws.String("SubnetId"),     // Required
		IpAddress:    aws.String("IpAddress"),
		SecurityGroups: []*string{
			aws.String("SecurityGroup"), // Required
			// More values...
		},
	}
	resp, err := svc.CreateMountTarget(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) CreateMountTargetRequest 

func (c *EFS) CreateMountTargetRequest(input *CreateMountTargetInput) (req *request.Request, output *MountTargetDescription)

CreateMountTargetRequest generates a "aws/request.Request" representing the client's request for the CreateMountTarget operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateMountTarget for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateMountTarget method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateMountTargetRequest method.
req, resp := client.CreateMountTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) CreateTags 

func (c *EFS) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation CreateTags for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.CreateTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		Tags: []*efs.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"),   // Required
				Value: aws.String("TagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.CreateTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) CreateTagsRequest 

func (c *EFS) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)

CreateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateTagsRequest method.
req, resp := client.CreateTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DeleteFileSystem 

func (c *EFS) DeleteFileSystem(input *DeleteFileSystemInput) (*DeleteFileSystemOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DeleteFileSystem for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

  • FileSystemInUse Returned if a file system has mount targets.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DeleteFileSystemInput{
		FileSystemId: aws.String("FileSystemId"), // Required
	}
	resp, err := svc.DeleteFileSystem(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DeleteFileSystemRequest 

func (c *EFS) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *request.Request, output *DeleteFileSystemOutput)

DeleteFileSystemRequest generates a "aws/request.Request" representing the client's request for the DeleteFileSystem operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteFileSystem for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFileSystem method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteFileSystemRequest method.
req, resp := client.DeleteFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DeleteMountTarget 

func (c *EFS) DeleteMountTarget(input *DeleteMountTargetInput) (*DeleteMountTargetOutput, error)

DeleteMountTarget API operation for Amazon Elastic File System.

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via 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 may 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 via 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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DeleteMountTarget for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

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

  • MountTargetNotFound Returned if there is no mount target with the specified ID found in the caller's account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DeleteMountTargetInput{
		MountTargetId: aws.String("MountTargetId"), // Required
	}
	resp, err := svc.DeleteMountTarget(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DeleteMountTargetRequest 

func (c *EFS) DeleteMountTargetRequest(input *DeleteMountTargetInput) (req *request.Request, output *DeleteMountTargetOutput)

DeleteMountTargetRequest generates a "aws/request.Request" representing the client's request for the DeleteMountTarget operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteMountTarget for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMountTarget method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteMountTargetRequest method.
req, resp := client.DeleteMountTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DeleteTags 

func (c *EFS) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

DeleteTags API operation for Amazon Elastic File System.

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions (http://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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DeleteTags for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DeleteTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		TagKeys: []*string{ // Required
			aws.String("TagKey"), // Required
			// More values...
		},
	}
	resp, err := svc.DeleteTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DeleteTagsRequest 

func (c *EFS) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

DeleteTagsRequest generates a "aws/request.Request" representing the client's request for the DeleteTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteTagsRequest method.
req, resp := client.DeleteTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DescribeFileSystems 

func (c *EFS) DescribeFileSystems(input *DescribeFileSystemsInput) (*DescribeFileSystemsOutput, error)

DescribeFileSystems 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. 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 implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DescribeFileSystems for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DescribeFileSystemsInput{
		CreationToken: aws.String("CreationToken"),
		FileSystemId:  aws.String("FileSystemId"),
		Marker:        aws.String("Marker"),
		MaxItems:      aws.Int64(1),
	}
	resp, err := svc.DescribeFileSystems(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DescribeFileSystemsRequest 

func (c *EFS) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) (req *request.Request, output *DescribeFileSystemsOutput)

DescribeFileSystemsRequest generates a "aws/request.Request" representing the client's request for the DescribeFileSystems operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFileSystems for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFileSystems method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeFileSystemsRequest method.
req, resp := client.DescribeFileSystemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DescribeMountTargetSecurityGroups 

func (c *EFS) DescribeMountTargetSecurityGroups(input *DescribeMountTargetSecurityGroupsInput) (*DescribeMountTargetSecurityGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DescribeMountTargetSecurityGroups for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • MountTargetNotFound Returned if there is no mount target with the specified ID found in the caller's account.

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DescribeMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("MountTargetId"), // Required
	}
	resp, err := svc.DescribeMountTargetSecurityGroups(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DescribeMountTargetSecurityGroupsRequest 

func (c *EFS) DescribeMountTargetSecurityGroupsRequest(input *DescribeMountTargetSecurityGroupsInput) (req *request.Request, output *DescribeMountTargetSecurityGroupsOutput)

DescribeMountTargetSecurityGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeMountTargetSecurityGroups operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeMountTargetSecurityGroups for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeMountTargetSecurityGroups method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeMountTargetSecurityGroupsRequest method.
req, resp := client.DescribeMountTargetSecurityGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DescribeMountTargets 

func (c *EFS) DescribeMountTargets(input *DescribeMountTargetsInput) (*DescribeMountTargetsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DescribeMountTargets for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

  • MountTargetNotFound Returned if there is no mount target with the specified ID found in the caller's account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DescribeMountTargetsInput{
		FileSystemId:  aws.String("FileSystemId"),
		Marker:        aws.String("Marker"),
		MaxItems:      aws.Int64(1),
		MountTargetId: aws.String("MountTargetId"),
	}
	resp, err := svc.DescribeMountTargets(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DescribeMountTargetsRequest 

func (c *EFS) DescribeMountTargetsRequest(input *DescribeMountTargetsInput) (req *request.Request, output *DescribeMountTargetsOutput)

DescribeMountTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeMountTargets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeMountTargets for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeMountTargets method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeMountTargetsRequest method.
req, resp := client.DescribeMountTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) DescribeTags 

func (c *EFS) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

DescribeTags 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 multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation DescribeTags for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • FileSystemNotFound Returned if the specified FileSystemId does not exist in the requester's AWS account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.DescribeTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		Marker:       aws.String("Marker"),
		MaxItems:     aws.Int64(1),
	}
	resp, err := svc.DescribeTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) DescribeTagsRequest 

func (c *EFS) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeTagsRequest method.
req, resp := client.DescribeTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*EFS) ModifyMountTargetSecurityGroups 

func (c *EFS) ModifyMountTargetSecurityGroups(input *ModifyMountTargetSecurityGroupsInput) (*ModifyMountTargetSecurityGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation ModifyMountTargetSecurityGroups for usage and error information.

Returned Error Codes:

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

  • InternalServerError Returned if an error occurred on the server side.

  • MountTargetNotFound Returned if there is no mount target with the specified ID found in the caller's account.

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

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

  • SecurityGroupNotFound Returned if one of the specified security groups does not exist in the subnet's VPC.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := efs.New(sess)

	params := &efs.ModifyMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("MountTargetId"), // Required
		SecurityGroups: []*string{
			aws.String("SecurityGroup"), // Required
			// More values...
		},
	}
	resp, err := svc.ModifyMountTargetSecurityGroups(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*EFS) ModifyMountTargetSecurityGroupsRequest 

func (c *EFS) ModifyMountTargetSecurityGroupsRequest(input *ModifyMountTargetSecurityGroupsInput) (req *request.Request, output *ModifyMountTargetSecurityGroupsOutput)

ModifyMountTargetSecurityGroupsRequest generates a "aws/request.Request" representing the client's request for the ModifyMountTargetSecurityGroups operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ModifyMountTargetSecurityGroups for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyMountTargetSecurityGroups method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ModifyMountTargetSecurityGroupsRequest method.
req, resp := client.ModifyMountTargetSecurityGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

type FileSystemDescription 

type FileSystemDescription struct {

	// 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" timestampFormat:"unix" required:"true"`

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

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

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

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

	// 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"`

	// 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 PerformanceMode of the file system.
	//
	// PerformanceMode is a required field
	PerformanceMode *string `type:"string" required:"true" enum:"PerformanceMode"`

	// Latest known metered size (in bytes) of data stored in the file system, in
	// bytes, 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. Note that the value does not 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 will represent
	// 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 the file system
	// was at any instant in time.
	//
	// SizeInBytes is a required field
	SizeInBytes *FileSystemSize `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Description of the file system.

func (FileSystemDescription) GoString added in v0.6.6 

func (s FileSystemDescription) GoString() string

GoString returns the string representation

func (*FileSystemDescription) SetCreationTime added in v1.5.1 

func (s *FileSystemDescription) SetCreationTime(v time.Time) *FileSystemDescription

SetCreationTime sets the CreationTime field's value.

func (*FileSystemDescription) SetCreationToken added in v1.5.1 

func (s *FileSystemDescription) SetCreationToken(v string) *FileSystemDescription

SetCreationToken sets the CreationToken field's value.

func (*FileSystemDescription) SetFileSystemId added in v1.5.1 

func (s *FileSystemDescription) SetFileSystemId(v string) *FileSystemDescription

SetFileSystemId sets the FileSystemId field's value.

func (*FileSystemDescription) SetLifeCycleState added in v1.5.1 

func (s *FileSystemDescription) SetLifeCycleState(v string) *FileSystemDescription

SetLifeCycleState sets the LifeCycleState field's value.

func (*FileSystemDescription) SetName added in v1.5.1 

func (s *FileSystemDescription) SetName(v string) *FileSystemDescription

SetName sets the Name field's value.

func (*FileSystemDescription) SetNumberOfMountTargets added in v1.5.1 

func (s *FileSystemDescription) SetNumberOfMountTargets(v int64) *FileSystemDescription

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*FileSystemDescription) SetOwnerId added in v1.5.1 

func (s *FileSystemDescription) SetOwnerId(v string) *FileSystemDescription

SetOwnerId sets the OwnerId field's value.

func (*FileSystemDescription) SetPerformanceMode added in v1.5.1 

func (s *FileSystemDescription) SetPerformanceMode(v string) *FileSystemDescription

SetPerformanceMode sets the PerformanceMode field's value.

func (*FileSystemDescription) SetSizeInBytes added in v1.5.1 

func (s *FileSystemDescription) SetSizeInBytes(v *FileSystemSize) *FileSystemDescription

SetSizeInBytes sets the SizeInBytes field's value.

func (FileSystemDescription) String added in v0.6.6 

func (s FileSystemDescription) String() string

String returns the string representation

type FileSystemSize 

type FileSystemSize struct {

	// 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" timestampFormat:"unix"`

	// Latest known metered size (in bytes) of data stored in the file system.
	//
	// Value is a required field
	Value *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

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. Note that the value does not 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 will represent 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) GoString added in v0.6.6 

func (s FileSystemSize) GoString() string

GoString returns the string representation

func (*FileSystemSize) SetTimestamp added in v1.5.1 

func (s *FileSystemSize) SetTimestamp(v time.Time) *FileSystemSize

SetTimestamp sets the Timestamp field's value.

func (*FileSystemSize) SetValue added in v1.5.1 

func (s *FileSystemSize) SetValue(v int64) *FileSystemSize

SetValue sets the Value field's value.

func (FileSystemSize) String added in v0.6.6 

func (s FileSystemSize) String() string

String returns the string representation

type ModifyMountTargetSecurityGroupsInput 

type ModifyMountTargetSecurityGroupsInput struct {

	// 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"`

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

func (ModifyMountTargetSecurityGroupsInput) GoString added in v0.6.6 

func (s ModifyMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.1 

func (s *ModifyMountTargetSecurityGroupsInput) SetMountTargetId(v string) *ModifyMountTargetSecurityGroupsInput

SetMountTargetId sets the MountTargetId field's value.

func (*ModifyMountTargetSecurityGroupsInput) SetSecurityGroups added in v1.5.1 

func (s *ModifyMountTargetSecurityGroupsInput) SetSecurityGroups(v []*string) *ModifyMountTargetSecurityGroupsInput

SetSecurityGroups sets the SecurityGroups field's value.

func (ModifyMountTargetSecurityGroupsInput) String added in v0.6.6 

func (s ModifyMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) Validate added in v1.1.24 

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) GoString added in v0.6.6 

func (s ModifyMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (ModifyMountTargetSecurityGroupsOutput) String added in v0.6.6 

func (s ModifyMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type MountTargetDescription 

type MountTargetDescription struct {

	// 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 may be mounted via the mount target.
	IpAddress *string `type:"string"`

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

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

	// 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"`

	// 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) GoString added in v0.6.6 

func (s MountTargetDescription) GoString() string

GoString returns the string representation

func (*MountTargetDescription) SetFileSystemId added in v1.5.1 

func (s *MountTargetDescription) SetFileSystemId(v string) *MountTargetDescription

SetFileSystemId sets the FileSystemId field's value.

func (*MountTargetDescription) SetIpAddress added in v1.5.1 

func (s *MountTargetDescription) SetIpAddress(v string) *MountTargetDescription

SetIpAddress sets the IpAddress field's value.

func (*MountTargetDescription) SetLifeCycleState added in v1.5.1 

func (s *MountTargetDescription) SetLifeCycleState(v string) *MountTargetDescription

SetLifeCycleState sets the LifeCycleState field's value.

func (*MountTargetDescription) SetMountTargetId added in v1.5.1 

func (s *MountTargetDescription) SetMountTargetId(v string) *MountTargetDescription

SetMountTargetId sets the MountTargetId field's value.

func (*MountTargetDescription) SetNetworkInterfaceId added in v1.5.1 

func (s *MountTargetDescription) SetNetworkInterfaceId(v string) *MountTargetDescription

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*MountTargetDescription) SetOwnerId added in v1.5.1 

func (s *MountTargetDescription) SetOwnerId(v string) *MountTargetDescription

SetOwnerId sets the OwnerId field's value.

func (*MountTargetDescription) SetSubnetId added in v1.5.1 

func (s *MountTargetDescription) SetSubnetId(v string) *MountTargetDescription

SetSubnetId sets the SubnetId field's value.

func (MountTargetDescription) String added in v0.6.6 

func (s MountTargetDescription) String() string

String returns the string representation

type Tag 

type Tag struct {

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

	// 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: letters, whitespace, and numbers, representable in UTF-8, and the following characters: + - = . _ : /

func (Tag) GoString added in v0.6.6 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.1 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.1 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.6 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.24 

func (s *Tag) Validate() error

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

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.