Documentation ¶
Overview ¶
Package fsx provides the client and types for making API requests to Amazon FSx.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
See https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01 for more information on this service.
See fsx package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/
Using the Client ¶
To use Amazon FSx 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 Amazon FSx client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/#New
Index ¶
- Constants
- type ActiveDirectoryBackupAttributes
- type ActiveDirectoryErrorType
- type Backup
- type BackupFailureDetails
- type BackupLifecycle
- type BackupType
- type Client
- func (c *Client) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest
- func (c *Client) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest
- func (c *Client) CreateFileSystemRequest(input *CreateFileSystemInput) CreateFileSystemRequest
- func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest
- func (c *Client) DeleteFileSystemRequest(input *DeleteFileSystemInput) DeleteFileSystemRequest
- func (c *Client) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest
- func (c *Client) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) DescribeFileSystemsRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateFileSystemRequest(input *UpdateFileSystemInput) UpdateFileSystemRequest
- type CreateBackupInput
- type CreateBackupOutput
- type CreateBackupRequest
- type CreateBackupResponse
- type CreateFileSystemFromBackupInput
- type CreateFileSystemFromBackupOutput
- type CreateFileSystemFromBackupRequest
- type CreateFileSystemFromBackupResponse
- type CreateFileSystemInput
- type CreateFileSystemLustreConfiguration
- type CreateFileSystemOutput
- type CreateFileSystemRequest
- type CreateFileSystemResponse
- type CreateFileSystemWindowsConfiguration
- type DataRepositoryConfiguration
- type DeleteBackupInput
- type DeleteBackupOutput
- type DeleteBackupRequest
- type DeleteBackupResponse
- type DeleteFileSystemInput
- type DeleteFileSystemOutput
- type DeleteFileSystemRequest
- type DeleteFileSystemResponse
- type DeleteFileSystemWindowsConfiguration
- type DeleteFileSystemWindowsResponse
- type DescribeBackupsInput
- type DescribeBackupsOutput
- type DescribeBackupsPaginator
- type DescribeBackupsRequest
- type DescribeBackupsResponse
- type DescribeFileSystemsInput
- type DescribeFileSystemsOutput
- type DescribeFileSystemsPaginator
- type DescribeFileSystemsRequest
- type DescribeFileSystemsResponse
- type FileSystem
- type FileSystemFailureDetails
- type FileSystemLifecycle
- type FileSystemMaintenanceOperation
- type FileSystemType
- type Filter
- type FilterName
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type LustreFileSystemConfiguration
- type SelfManagedActiveDirectoryAttributes
- type SelfManagedActiveDirectoryConfiguration
- type SelfManagedActiveDirectoryConfigurationUpdates
- type ServiceLimit
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateFileSystemInput
- type UpdateFileSystemLustreConfiguration
- type UpdateFileSystemOutput
- type UpdateFileSystemRequest
- type UpdateFileSystemResponse
- type UpdateFileSystemWindowsConfiguration
- type WindowsFileSystemConfiguration
Examples ¶
- Client.CreateBackupRequest (Shared00)
- Client.CreateFileSystemFromBackupRequest (Shared00)
- Client.CreateFileSystemRequest (Shared00)
- Client.DeleteBackupRequest (Shared00)
- Client.DeleteFileSystemRequest (Shared00)
- Client.DescribeBackupsRequest (Shared00)
- Client.DescribeFileSystemsRequest (Shared00)
- Client.ListTagsForResourceRequest (Shared00)
- Client.TagResourceRequest (Shared00)
- Client.UntagResourceRequest (Shared00)
- Client.UpdateFileSystemRequest (Shared00)
Constants ¶
const ( ServiceName = "Amazon FSx" // Service's name ServiceID = "FSx" // Service's identifier EndpointsID = "fsx" // Service's Endpoint identifier )
const ( // ErrCodeActiveDirectoryError for service response error code // "ActiveDirectoryError". // // An Active Directory error. ErrCodeActiveDirectoryError = "ActiveDirectoryError" // ErrCodeBackupInProgress for service response error code // "BackupInProgress". // // Another backup is already under way. Wait for completion before initiating // additional backups of this file system. ErrCodeBackupInProgress = "BackupInProgress" // ErrCodeBackupNotFound for service response error code // "BackupNotFound". // // No Amazon FSx backups were found based upon the supplied parameters. ErrCodeBackupNotFound = "BackupNotFound" // ErrCodeBackupRestoring for service response error code // "BackupRestoring". // // You can't delete a backup while it's being used to restore a file system. ErrCodeBackupRestoring = "BackupRestoring" // ErrCodeBadRequest for service response error code // "BadRequest". // // A generic error indicating a failure with a client request. ErrCodeBadRequest = "BadRequest" // ErrCodeFileSystemNotFound for service response error code // "FileSystemNotFound". // // No Amazon FSx file systems were found based upon supplied parameters. ErrCodeFileSystemNotFound = "FileSystemNotFound" // ErrCodeIncompatibleParameterError for service response error code // "IncompatibleParameterError". // // The error returned when a second request is received with the same client // request token but different parameters settings. A client request token should // always uniquely identify a single request. ErrCodeIncompatibleParameterError = "IncompatibleParameterError" // ErrCodeInternalServerError for service response error code // "InternalServerError". // // A generic error indicating a server-side failure. ErrCodeInternalServerError = "InternalServerError" // ErrCodeInvalidExportPath for service response error code // "InvalidExportPath". // // The path provided for data repository export isn't valid. ErrCodeInvalidExportPath = "InvalidExportPath" // ErrCodeInvalidImportPath for service response error code // "InvalidImportPath". // // The path provided for data repository import isn't valid. ErrCodeInvalidImportPath = "InvalidImportPath" // ErrCodeInvalidNetworkSettings for service response error code // "InvalidNetworkSettings". // // One or more network settings specified in the request are invalid. InvalidVpcId // means that the ID passed for the virtual private cloud (VPC) is invalid. // InvalidSubnetIds returns the list of IDs for subnets that are either invalid // or not part of the VPC specified. InvalidSecurityGroupIds returns the list // of IDs for security groups that are either invalid or not part of the VPC // specified. ErrCodeInvalidNetworkSettings = "InvalidNetworkSettings" // ErrCodeMissingFileSystemConfiguration for service response error code // "MissingFileSystemConfiguration". // // File system configuration is required for this operation. ErrCodeMissingFileSystemConfiguration = "MissingFileSystemConfiguration" // ErrCodeNotServiceResourceError for service response error code // "NotServiceResourceError". // // The resource specified for the tagging operation is not a resource type owned // by Amazon FSx. Use the API of the relevant service to perform the operation. ErrCodeNotServiceResourceError = "NotServiceResourceError" // ErrCodeResourceDoesNotSupportTagging for service response error code // "ResourceDoesNotSupportTagging". // // The resource specified does not support tagging. ErrCodeResourceDoesNotSupportTagging = "ResourceDoesNotSupportTagging" // ErrCodeResourceNotFound for service response error code // "ResourceNotFound". // // The resource specified by the Amazon Resource Name (ARN) can't be found. ErrCodeResourceNotFound = "ResourceNotFound" // ErrCodeServiceLimitExceeded for service response error code // "ServiceLimitExceeded". // // An error indicating that a particular service limit was exceeded. You can // increase some service limits by contacting AWS Support. ErrCodeServiceLimitExceeded = "ServiceLimitExceeded" // ErrCodeUnsupportedOperation for service response error code // "UnsupportedOperation". // // An error occured. ErrCodeUnsupportedOperation = "UnsupportedOperation" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActiveDirectoryBackupAttributes ¶ added in v0.10.0
type ActiveDirectoryBackupAttributes struct { // The ID of the AWS Managed Microsoft Active Directory instance to which the // file system is joined. ActiveDirectoryId *string `min:"12" type:"string"` // The fully qualified domain name of the self-managed AD directory. DomainName *string `type:"string"` // contains filtered or unexported fields }
The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.
func (ActiveDirectoryBackupAttributes) String ¶ added in v0.10.0
func (s ActiveDirectoryBackupAttributes) String() string
String returns the string representation
type ActiveDirectoryErrorType ¶
type ActiveDirectoryErrorType string
The type of error relating to Microsoft Active Directory. NOT_FOUND means that no directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified directory isn't accessible from the specified VPC. WRONG_STAGE means that the specified directory isn't currently in the ACTIVE state.
const ( ActiveDirectoryErrorTypeDomainNotFound ActiveDirectoryErrorType = "DOMAIN_NOT_FOUND" ActiveDirectoryErrorTypeIncompatibleDomainMode ActiveDirectoryErrorType = "INCOMPATIBLE_DOMAIN_MODE" ActiveDirectoryErrorTypeWrongVpc ActiveDirectoryErrorType = "WRONG_VPC" ActiveDirectoryErrorTypeInvalidDomainStage ActiveDirectoryErrorType = "INVALID_DOMAIN_STAGE" )
Enum values for ActiveDirectoryErrorType
func (ActiveDirectoryErrorType) MarshalValue ¶
func (enum ActiveDirectoryErrorType) MarshalValue() (string, error)
func (ActiveDirectoryErrorType) MarshalValueBuf ¶
func (enum ActiveDirectoryErrorType) MarshalValueBuf(b []byte) ([]byte, error)
type Backup ¶
type Backup struct { // The ID of the backup. // // BackupId is a required field BackupId *string `min:"12" type:"string" required:"true"` // The time when a particular backup was created. // // CreationTime is a required field CreationTime *time.Time `type:"timestamp" required:"true"` // The configuration of the self-managed Microsoft Active Directory (AD) to // which the Windows File Server instance is joined. DirectoryInformation *ActiveDirectoryBackupAttributes `type:"structure"` // Details explaining any failures that occur when creating a backup. FailureDetails *BackupFailureDetails `type:"structure"` // Metadata of the file system associated with the backup. This metadata is // persisted even if the file system is deleted. // // FileSystem is a required field FileSystem *FileSystem `type:"structure" required:"true"` // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this // backup's data. KmsKeyId *string `min:"1" type:"string"` // The lifecycle status of the backup. // // Lifecycle is a required field Lifecycle BackupLifecycle `type:"string" required:"true" enum:"true"` // The current percent of progress of an asynchronous task. ProgressPercent *int64 `type:"integer"` // The Amazon Resource Name (ARN) for the backup resource. ResourceARN *string `min:"8" type:"string"` // Tags associated with a particular file system. Tags []Tag `min:"1" type:"list"` // The type of the backup. // // Type is a required field Type BackupType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.
type BackupFailureDetails ¶
type BackupFailureDetails struct { // A message describing the backup creation failure. Message *string `min:"1" type:"string"` // contains filtered or unexported fields }
If backup creation fails, this structure contains the details of that failure.
func (BackupFailureDetails) String ¶
func (s BackupFailureDetails) String() string
String returns the string representation
type BackupLifecycle ¶
type BackupLifecycle string
The lifecycle status of the backup.
const ( BackupLifecycleAvailable BackupLifecycle = "AVAILABLE" BackupLifecycleCreating BackupLifecycle = "CREATING" BackupLifecycleDeleted BackupLifecycle = "DELETED" BackupLifecycleFailed BackupLifecycle = "FAILED" )
Enum values for BackupLifecycle
func (BackupLifecycle) MarshalValue ¶
func (enum BackupLifecycle) MarshalValue() (string, error)
func (BackupLifecycle) MarshalValueBuf ¶
func (enum BackupLifecycle) MarshalValueBuf(b []byte) ([]byte, error)
type BackupType ¶
type BackupType string
The type of the backup.
const ( BackupTypeAutomatic BackupType = "AUTOMATIC" BackupTypeUserInitiated BackupType = "USER_INITIATED" )
Enum values for BackupType
func (BackupType) MarshalValue ¶
func (enum BackupType) MarshalValue() (string, error)
func (BackupType) MarshalValueBuf ¶
func (enum BackupType) MarshalValueBuf(b []byte) ([]byte, error)
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amazon FSx. 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 ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := fsx.New(myConfig)
func (*Client) CreateBackupRequest ¶ added in v0.9.0
func (c *Client) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest
CreateBackupRequest returns a request value for making API operation for Amazon FSx.
Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
// Example sending a request using CreateBackupRequest. req := client.CreateBackupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackup
func (*Client) CreateFileSystemFromBackupRequest ¶ added in v0.9.0
func (c *Client) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest
CreateFileSystemFromBackupRequest returns a request value for making API operation for Amazon FSx.
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
The CreateFileSystemFromBackup 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 returns the file system state along with other information.
// Example sending a request using CreateFileSystemFromBackupRequest. req := client.CreateFileSystemFromBackupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup
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 FSx.
Creates a new, empty Amazon FSx file system.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
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 returns the file system state along with other information.
// 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/fsx-2018-03-01/CreateFileSystem
func (*Client) DeleteBackupRequest ¶ added in v0.9.0
func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest
DeleteBackupRequest returns a request value for making API operation for Amazon FSx.
Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
// Example sending a request using DeleteBackupRequest. req := client.DeleteBackupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackup
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 FSx.
Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
The data in a deleted file system is also deleted and can't be recovered by any means.
// 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/fsx-2018-03-01/DeleteFileSystem
func (*Client) DescribeBackupsRequest ¶ added in v0.9.0
func (c *Client) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest
DescribeBackupsRequest returns a request value for making API operation for Amazon FSx.
Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
// Example sending a request using DescribeBackupsRequest. req := client.DescribeBackupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups
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 FSx.
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken 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 multicall iteration is unspecified.
// 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/fsx-2018-03-01/DescribeFileSystems
func (*Client) ListTagsForResourceRequest ¶ added in v0.9.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon FSx.
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.
// 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/fsx-2018-03-01/ListTagsForResource
func (*Client) TagResourceRequest ¶ added in v0.9.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon FSx.
Tags an Amazon FSx resource.
// 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/fsx-2018-03-01/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.9.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon FSx.
This action removes a tag from an Amazon FSx resource.
// 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/fsx-2018-03-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 FSx.
Updates a file system configuration.
// 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/fsx-2018-03-01/UpdateFileSystem
type CreateBackupInput ¶
type CreateBackupInput struct { // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent creation. This string is automatically filled on your behalf // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The ID of the file system to back up. // // FileSystemId is a required field FileSystemId *string `min:"11" type:"string" required:"true"` // The tags to apply to the backup at backup creation. The key value of the // Name tag appears in the console as the backup name. Tags []Tag `min:"1" type:"list"` // contains filtered or unexported fields }
The request object for the CreateBackup operation.
func (CreateBackupInput) String ¶
func (s CreateBackupInput) String() string
String returns the string representation
func (*CreateBackupInput) Validate ¶
func (s *CreateBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBackupOutput ¶
type CreateBackupOutput struct { // A description of the backup. Backup *Backup `type:"structure"` // contains filtered or unexported fields }
The response object for the CreateBackup operation.
func (CreateBackupOutput) String ¶
func (s CreateBackupOutput) String() string
String returns the string representation
type CreateBackupRequest ¶
type CreateBackupRequest struct { *aws.Request Input *CreateBackupInput Copy func(*CreateBackupInput) CreateBackupRequest }
CreateBackupRequest is the request type for the CreateBackup API operation.
func (CreateBackupRequest) Send ¶
func (r CreateBackupRequest) Send(ctx context.Context) (*CreateBackupResponse, error)
Send marshals and sends the CreateBackup API request.
type CreateBackupResponse ¶ added in v0.9.0
type CreateBackupResponse struct { *CreateBackupOutput // contains filtered or unexported fields }
CreateBackupResponse is the response type for the CreateBackup API operation.
func (*CreateBackupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateBackupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateBackup request.
type CreateFileSystemFromBackupInput ¶
type CreateFileSystemFromBackupInput struct { // The ID of the backup. Specifies the backup to use if you're creating a file // system from an existing backup. // // BackupId is a required field BackupId *string `min:"12" type:"string" required:"true"` // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent creation. This string is automatically filled on your behalf // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // A list of IDs for the security groups that apply to the specified network // interfaces created for file system access. These security groups apply to // all network interfaces. This value isn't returned in later describe requests. SecurityGroupIds []string `type:"list"` // A list of IDs for the subnets that the file system will be accessible from. // Currently, you can specify only one subnet. The file server is also launched // in that subnet's Availability Zone. // // SubnetIds is a required field SubnetIds []string `type:"list" required:"true"` // The tags to be applied to the file system at file system creation. The key // value of the Name tag appears in the console as the file system name. Tags []Tag `min:"1" type:"list"` // The configuration for this Microsoft Windows file system. WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"` // contains filtered or unexported fields }
The request object for the CreateFileSystemFromBackup operation.
func (CreateFileSystemFromBackupInput) String ¶
func (s CreateFileSystemFromBackupInput) String() string
String returns the string representation
func (*CreateFileSystemFromBackupInput) Validate ¶
func (s *CreateFileSystemFromBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateFileSystemFromBackupOutput ¶
type CreateFileSystemFromBackupOutput struct { // A description of the file system. FileSystem *FileSystem `type:"structure"` // contains filtered or unexported fields }
The response object for the CreateFileSystemFromBackup operation.
func (CreateFileSystemFromBackupOutput) String ¶
func (s CreateFileSystemFromBackupOutput) String() string
String returns the string representation
type CreateFileSystemFromBackupRequest ¶
type CreateFileSystemFromBackupRequest struct { *aws.Request Input *CreateFileSystemFromBackupInput Copy func(*CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest }
CreateFileSystemFromBackupRequest is the request type for the CreateFileSystemFromBackup API operation.
func (CreateFileSystemFromBackupRequest) Send ¶
func (r CreateFileSystemFromBackupRequest) Send(ctx context.Context) (*CreateFileSystemFromBackupResponse, error)
Send marshals and sends the CreateFileSystemFromBackup API request.
type CreateFileSystemFromBackupResponse ¶ added in v0.9.0
type CreateFileSystemFromBackupResponse struct { *CreateFileSystemFromBackupOutput // contains filtered or unexported fields }
CreateFileSystemFromBackupResponse is the response type for the CreateFileSystemFromBackup API operation.
func (*CreateFileSystemFromBackupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateFileSystemFromBackupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateFileSystemFromBackup request.
type CreateFileSystemInput ¶
type CreateFileSystemInput struct { // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent creation. This string is automatically filled on your behalf // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The type of Amazon FSx file system to create. // // FileSystemType is a required field FileSystemType FileSystemType `type:"string" required:"true" enum:"true"` // The ID of your AWS Key Management Service (AWS KMS) key. This ID is used // to encrypt the data in your file system at rest. For more information, see // Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) // in the AWS Key Management Service API Reference. KmsKeyId *string `min:"1" type:"string"` // The Lustre configuration for the file system being created. This value is // required if FileSystemType is set to LUSTRE. LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"` // A list of IDs specifying the security groups to apply to all network interfaces // created for file system access. This list isn't returned in later requests // to describe the file system. SecurityGroupIds []string `type:"list"` // The storage capacity of the file system being created. // // For Windows file systems, the storage capacity has a minimum of 300 GiB, // and a maximum of 65,536 GiB. // // For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. // Storage capacity is provisioned in increments of 3,600 GiB. // // StorageCapacity is a required field StorageCapacity *int64 `min:"1" type:"integer" required:"true"` // The IDs of the subnets that the file system will be accessible from. File // systems support only one subnet. The file server is also launched in that // subnet's Availability Zone. // // SubnetIds is a required field SubnetIds []string `type:"list" required:"true"` // The tags to apply to the file system being created. The key value of the // Name tag appears in the console as the file system name. Tags []Tag `min:"1" type:"list"` // The Microsoft Windows configuration for the file system being created. This // value is required if FileSystemType is set to WINDOWS. WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"` // contains filtered or unexported fields }
The request object used to create a new Amazon FSx file system.
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 CreateFileSystemLustreConfiguration ¶
type CreateFileSystemLustreConfiguration struct { // (Optional) The path in Amazon S3 where the root of your Amazon FSx file system // is exported. The path must use the same Amazon S3 bucket as specified in // ImportPath. You can provide an optional prefix to which new and changed data // is to be exported from your Amazon FSx for Lustre file system. If an ExportPath // value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. // The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. // // The Amazon S3 export bucket must be the same as the import bucket specified // by ImportPath. If you only specify a bucket name, such as s3://import-bucket, // you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping // means that the input data in S3 is overwritten on export. If you provide // a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], // Amazon FSx exports the contents of your file system to that export prefix // in the Amazon S3 bucket. ExportPath *string `min:"3" type:"string"` // (Optional) The path to the Amazon S3 bucket (including the optional prefix) // that you're using as the data repository for your Amazon FSx for Lustre file // system. The root of your FSx for Lustre file system will be mapped to the // root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. // If you specify a prefix after the Amazon S3 bucket name, only object keys // with that prefix are loaded into the file system. ImportPath *string `min:"3" type:"string"` // (Optional) For files imported from a data repository, this value determines // the stripe count and maximum amount of data per file (in MiB) stored on a // single physical disk. The maximum number of disks that a single file can // be striped across is limited by the total number of disks that make up the // file system. // // The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 // MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. ImportedFileChunkSize *int64 `min:"1" type:"integer"` // The preferred time to perform weekly maintenance, in the UTC time zone. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE.
func (CreateFileSystemLustreConfiguration) String ¶
func (s CreateFileSystemLustreConfiguration) String() string
String returns the string representation
func (*CreateFileSystemLustreConfiguration) Validate ¶
func (s *CreateFileSystemLustreConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateFileSystemOutput ¶
type CreateFileSystemOutput struct { // The configuration of the file system that was created. FileSystem *FileSystem `type:"structure"` // contains filtered or unexported fields }
The response object returned after the file system is created.
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 CreateFileSystemWindowsConfiguration ¶
type CreateFileSystemWindowsConfiguration struct { // The ID for an existing AWS Managed Microsoft Active Directory (AD) instance // that the file system should join when it's created. ActiveDirectoryId *string `min:"12" type:"string"` // The number of days to retain automatic backups. The default is to retain // backups for 7 days. Setting this value to 0 disables the creation of automatic // backups. The maximum retention period for backups is 35 days. AutomaticBackupRetentionDays *int64 `type:"integer"` // A boolean flag indicating whether tags for the file system should be copied // to backups. This value defaults to false. If it's set to true, all tags for // the file system are copied to all automatic and user-initiated backups where // the user doesn't specify tags. If this value is true, and you specify one // or more tags, only the specified tags are copied to backups. CopyTagsToBackups *bool `type:"boolean"` // The preferred time to take daily automatic backups, formatted HH:MM in the // UTC time zone. DailyAutomaticBackupStartTime *string `min:"5" type:"string"` // The configuration that Amazon FSx uses to join the Windows File Server instance // to your self-managed (including on-premises) Microsoft Active Directory (AD) // directory. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration `type:"structure"` // The throughput of an Amazon FSx file system, measured in megabytes per second, // in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). // // ThroughputCapacity is a required field ThroughputCapacity *int64 `min:"8" type:"integer" required:"true"` // The preferred start time to perform weekly maintenance, formatted d:HH:MM // in the UTC time zone. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
func (CreateFileSystemWindowsConfiguration) String ¶
func (s CreateFileSystemWindowsConfiguration) String() string
String returns the string representation
func (*CreateFileSystemWindowsConfiguration) Validate ¶
func (s *CreateFileSystemWindowsConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DataRepositoryConfiguration ¶
type DataRepositoryConfiguration struct { // The export path to the Amazon S3 bucket (and prefix) that you are using to // store new and changed Lustre file system files in S3. ExportPath *string `min:"3" type:"string"` // The import path to the Amazon S3 bucket (and optional prefix) that you're // using as the data repository for your FSx for Lustre file system, for example // s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon // S3 bucket name, only object keys with that prefix are loaded into the file // system. ImportPath *string `min:"3" type:"string"` // For files imported from a data repository, this value determines the stripe // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across // is limited by the total number of disks that make up the file system. // // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 // MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. ImportedFileChunkSize *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
func (DataRepositoryConfiguration) String ¶
func (s DataRepositoryConfiguration) String() string
String returns the string representation
type DeleteBackupInput ¶
type DeleteBackupInput struct { // The ID of the backup you want to delete. // // BackupId is a required field BackupId *string `min:"12" type:"string" required:"true"` // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent deletion. This is automatically filled on your behalf when // using the AWS CLI or SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // contains filtered or unexported fields }
The request object for DeleteBackup operation.
func (DeleteBackupInput) String ¶
func (s DeleteBackupInput) String() string
String returns the string representation
func (*DeleteBackupInput) Validate ¶
func (s *DeleteBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupOutput ¶
type DeleteBackupOutput struct { // The ID of the backup deleted. BackupId *string `min:"12" type:"string"` // The lifecycle of the backup. Should be DELETED. Lifecycle BackupLifecycle `type:"string" enum:"true"` // contains filtered or unexported fields }
The response object for DeleteBackup operation.
func (DeleteBackupOutput) String ¶
func (s DeleteBackupOutput) String() string
String returns the string representation
type DeleteBackupRequest ¶
type DeleteBackupRequest struct { *aws.Request Input *DeleteBackupInput Copy func(*DeleteBackupInput) DeleteBackupRequest }
DeleteBackupRequest is the request type for the DeleteBackup API operation.
func (DeleteBackupRequest) Send ¶
func (r DeleteBackupRequest) Send(ctx context.Context) (*DeleteBackupResponse, error)
Send marshals and sends the DeleteBackup API request.
type DeleteBackupResponse ¶ added in v0.9.0
type DeleteBackupResponse struct { *DeleteBackupOutput // contains filtered or unexported fields }
DeleteBackupResponse is the response type for the DeleteBackup API operation.
func (*DeleteBackupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteBackupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteBackup request.
type DeleteFileSystemInput ¶
type DeleteFileSystemInput struct { // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent deletion. This is automatically filled on your behalf when // using the AWS CLI or SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The ID of the file system you want to delete. // // FileSystemId is a required field FileSystemId *string `min:"11" type:"string" required:"true"` // The configuration object for the Microsoft Windows file system used in the // DeleteFileSystem operation. WindowsConfiguration *DeleteFileSystemWindowsConfiguration `type:"structure"` // contains filtered or unexported fields }
The request object for DeleteFileSystem operation.
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 { // The ID of the file system being deleted. FileSystemId *string `min:"11" type:"string"` // The file system lifecycle for the deletion request. Should be DELETING. Lifecycle FileSystemLifecycle `type:"string" enum:"true"` // The response object for the Microsoft Windows file system used in the DeleteFileSystem // operation. WindowsResponse *DeleteFileSystemWindowsResponse `type:"structure"` // contains filtered or unexported fields }
The response object for the DeleteFileSystem operation.
func (DeleteFileSystemOutput) String ¶
func (s DeleteFileSystemOutput) String() string
String returns the string representation
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 DeleteFileSystemWindowsConfiguration ¶
type DeleteFileSystemWindowsConfiguration struct { // A set of tags for your final backup. FinalBackupTags []Tag `min:"1" type:"list"` // By default, Amazon FSx for Windows takes a final backup on your behalf when // the DeleteFileSystem operation is invoked. Doing this helps protect you from // data loss, and we highly recommend taking the final backup. If you want to // skip this backup, use this flag to do so. SkipFinalBackup *bool `type:"boolean"` // contains filtered or unexported fields }
The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.
func (DeleteFileSystemWindowsConfiguration) String ¶
func (s DeleteFileSystemWindowsConfiguration) String() string
String returns the string representation
func (*DeleteFileSystemWindowsConfiguration) Validate ¶
func (s *DeleteFileSystemWindowsConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteFileSystemWindowsResponse ¶
type DeleteFileSystemWindowsResponse struct { // The ID of the final backup for this file system. FinalBackupId *string `min:"12" type:"string"` // The set of tags applied to the final backup. FinalBackupTags []Tag `min:"1" type:"list"` // contains filtered or unexported fields }
The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
func (DeleteFileSystemWindowsResponse) String ¶
func (s DeleteFileSystemWindowsResponse) String() string
String returns the string representation
type DescribeBackupsInput ¶
type DescribeBackupsInput struct { // (Optional) IDs of the backups you want to retrieve (String). This overrides // any filters. If any IDs are not found, BackupNotFound will be thrown. BackupIds []string `type:"list"` // (Optional) Filters structure. Supported names are file-system-id and backup-type. Filters []Filter `type:"list"` // (Optional) Maximum number of backups to return in the response (integer). // This parameter value must be greater than 0. The number of items that Amazon // FSx returns is the minimum of the MaxResults parameter specified in the request // and the service's internal maximum number of items per page. MaxResults *int64 `min:"1" type:"integer"` // (Optional) Opaque pagination token returned from a previous DescribeBackups // operation (String). If a token present, the action continues the list from // where the returning call left off. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The request object for DescribeBackups operation.
func (DescribeBackupsInput) String ¶
func (s DescribeBackupsInput) String() string
String returns the string representation
func (*DescribeBackupsInput) Validate ¶
func (s *DescribeBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBackupsOutput ¶
type DescribeBackupsOutput struct { // Any array of backups. Backups []Backup `type:"list"` // This is present if there are more backups than returned in the response (String). // You can use the NextToken value in the later request to fetch the backups. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Response object for DescribeBackups operation.
func (DescribeBackupsOutput) String ¶
func (s DescribeBackupsOutput) String() string
String returns the string representation
type DescribeBackupsPaginator ¶ added in v0.9.0
DescribeBackupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeBackupsPaginator ¶ added in v0.9.0
func NewDescribeBackupsPaginator(req DescribeBackupsRequest) DescribeBackupsPaginator
NewDescribeBackupsRequestPaginator returns a paginator for DescribeBackups. 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.DescribeBackupsRequest(input) p := fsx.NewDescribeBackupsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeBackupsPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeBackupsPaginator) CurrentPage() *DescribeBackupsOutput
type DescribeBackupsRequest ¶
type DescribeBackupsRequest struct { *aws.Request Input *DescribeBackupsInput Copy func(*DescribeBackupsInput) DescribeBackupsRequest }
DescribeBackupsRequest is the request type for the DescribeBackups API operation.
func (DescribeBackupsRequest) Send ¶
func (r DescribeBackupsRequest) Send(ctx context.Context) (*DescribeBackupsResponse, error)
Send marshals and sends the DescribeBackups API request.
type DescribeBackupsResponse ¶ added in v0.9.0
type DescribeBackupsResponse struct { *DescribeBackupsOutput // contains filtered or unexported fields }
DescribeBackupsResponse is the response type for the DescribeBackups API operation.
func (*DescribeBackupsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeBackupsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeBackups request.
type DescribeFileSystemsInput ¶
type DescribeFileSystemsInput struct { // (Optional) IDs of the file systems whose descriptions you want to retrieve // (String). FileSystemIds []string `type:"list"` // (Optional) 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 // FSx returns is the minimum of the MaxResults parameter specified in the request // and the service's internal maximum number of items per page. MaxResults *int64 `min:"1" type:"integer"` // (Optional) Opaque pagination token returned from a previous DescribeFileSystems // operation (String). If a token present, the action continues the list from // where the returning call left off. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The request object for DescribeFileSystems operation.
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 []FileSystem `type:"list"` // Present if there are more file systems than returned in the response (String). // You can use the NextToken value in the later request to fetch the descriptions. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The response object for DescribeFileSystems operation.
func (DescribeFileSystemsOutput) String ¶
func (s DescribeFileSystemsOutput) String() string
String returns the string representation
type DescribeFileSystemsPaginator ¶ added in v0.9.0
DescribeFileSystemsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeFileSystemsPaginator ¶ added in v0.9.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 := fsx.NewDescribeFileSystemsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeFileSystemsPaginator) CurrentPage ¶ added in v0.9.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 FileSystem ¶
type FileSystem struct { // The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), // also known as Unix time. CreationTime *time.Time `type:"timestamp"` // The DNS name for the file system. DNSName *string `min:"16" type:"string"` // A structure providing details of any failures that occur when creating the // file system has failed. FailureDetails *FileSystemFailureDetails `type:"structure"` // The system-generated, unique 17-digit ID of the file system. FileSystemId *string `min:"11" type:"string"` // The type of Amazon FSx file system, either LUSTRE or WINDOWS. FileSystemType FileSystemType `type:"string" enum:"true"` // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the // file system's data for an Amazon FSx for Windows File Server file system. KmsKeyId *string `min:"1" type:"string"` // The lifecycle status of the file system: // // * AVAILABLE indicates that the file system is reachable and available // for use. // // * CREATING indicates that Amazon FSx is in the process of creating the // new file system. // // * DELETING indicates that Amazon FSx is in the process of deleting the // file system. // // * FAILED indicates that Amazon FSx was not able to create the file system. // // * MISCONFIGURED indicates that the file system is in a failed but recoverable // state. // // * UPDATING indicates that the file system is undergoing a customer initiated // update. Lifecycle FileSystemLifecycle `type:"string" enum:"true"` // The configuration for the Amazon FSx for Lustre file system. LustreConfiguration *LustreFileSystemConfiguration `type:"structure"` // The IDs of the elastic network interface from which a specific file system // is accessible. The elastic network interface is automatically created in // the same VPC that the Amazon FSx file system was created in. For more information, // see Elastic Network Interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) // in the Amazon EC2 User Guide. // // For an Amazon FSx for Windows File Server file system, you can have one network // interface ID. For an Amazon FSx for Lustre file system, you can have more // than one. NetworkInterfaceIds []string `type:"list"` // The AWS account that created the file system. If the file system was created // by an AWS Identity and Access Management (IAM) user, the AWS account to which // the IAM user belongs is the owner. OwnerId *string `min:"12" type:"string"` // The Amazon Resource Name (ARN) for the file system resource. ResourceARN *string `min:"8" type:"string"` // The storage capacity of the file system in gigabytes (GB). StorageCapacity *int64 `min:"1" type:"integer"` // The ID of the subnet to contain the endpoint for the file system. One and // only one is supported. The file system is launched in the Availability Zone // associated with this subnet. SubnetIds []string `type:"list"` // The tags to associate with the file system. For more information, see Tagging // Your Amazon EC2 Resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) // in the Amazon EC2 User Guide. Tags []Tag `min:"1" type:"list"` // The ID of the primary VPC for the file system. VpcId *string `min:"12" type:"string"` // The configuration for this Microsoft Windows file system. WindowsConfiguration *WindowsFileSystemConfiguration `type:"structure"` // contains filtered or unexported fields }
A description of a specific Amazon FSx file system.
func (FileSystem) String ¶
func (s FileSystem) String() string
String returns the string representation
type FileSystemFailureDetails ¶
type FileSystemFailureDetails struct { // A message describing any failures that occurred during file system creation. Message *string `min:"1" type:"string"` // contains filtered or unexported fields }
A structure providing details of any failures that occur when creating the file system has failed.
func (FileSystemFailureDetails) String ¶
func (s FileSystemFailureDetails) String() string
String returns the string representation
type FileSystemLifecycle ¶
type FileSystemLifecycle string
The lifecycle status of the file system.
const ( FileSystemLifecycleAvailable FileSystemLifecycle = "AVAILABLE" FileSystemLifecycleCreating FileSystemLifecycle = "CREATING" FileSystemLifecycleFailed FileSystemLifecycle = "FAILED" FileSystemLifecycleDeleting FileSystemLifecycle = "DELETING" FileSystemLifecycleMisconfigured FileSystemLifecycle = "MISCONFIGURED" FileSystemLifecycleUpdating FileSystemLifecycle = "UPDATING" )
Enum values for FileSystemLifecycle
func (FileSystemLifecycle) MarshalValue ¶
func (enum FileSystemLifecycle) MarshalValue() (string, error)
func (FileSystemLifecycle) MarshalValueBuf ¶
func (enum FileSystemLifecycle) MarshalValueBuf(b []byte) ([]byte, error)
type FileSystemMaintenanceOperation ¶
type FileSystemMaintenanceOperation string
An enumeration specifying the currently ongoing maintenance operation.
const ( FileSystemMaintenanceOperationPatching FileSystemMaintenanceOperation = "PATCHING" FileSystemMaintenanceOperationBackingUp FileSystemMaintenanceOperation = "BACKING_UP" )
Enum values for FileSystemMaintenanceOperation
func (FileSystemMaintenanceOperation) MarshalValue ¶
func (enum FileSystemMaintenanceOperation) MarshalValue() (string, error)
func (FileSystemMaintenanceOperation) MarshalValueBuf ¶
func (enum FileSystemMaintenanceOperation) MarshalValueBuf(b []byte) ([]byte, error)
type FileSystemType ¶
type FileSystemType string
The type of file system.
const ( FileSystemTypeWindows FileSystemType = "WINDOWS" FileSystemTypeLustre FileSystemType = "LUSTRE" )
Enum values for FileSystemType
func (FileSystemType) MarshalValue ¶
func (enum FileSystemType) MarshalValue() (string, error)
func (FileSystemType) MarshalValueBuf ¶
func (enum FileSystemType) MarshalValueBuf(b []byte) ([]byte, error)
type Filter ¶
type Filter struct { // The name for this filter. Name FilterName `type:"string" enum:"true"` // The values of the filter. These are all the values for any of the applied // filters. Values []string `type:"list"` // contains filtered or unexported fields }
A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.
type FilterName ¶
type FilterName string
The name for a filter.
const ( FilterNameFileSystemId FilterName = "file-system-id" FilterNameBackupType FilterName = "backup-type" )
Enum values for FilterName
func (FilterName) MarshalValue ¶
func (enum FilterName) MarshalValue() (string, error)
func (FilterName) MarshalValueBuf ¶
func (enum FilterName) MarshalValueBuf(b []byte) ([]byte, error)
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // (Optional) Maximum number of tags to return in the response (integer). This // parameter value must be greater than 0. The number of items that Amazon FSx // returns is the minimum of the MaxResults parameter specified in the request // and the service's internal maximum number of items per page. MaxResults *int64 `min:"1" type:"integer"` // (Optional) Opaque pagination token returned from a previous ListTagsForResource // operation (String). If a token present, the action continues the list from // where the returning call left off. NextToken *string `min:"1" type:"string"` // The ARN of the Amazon FSx resource that will have its tags listed. // // ResourceARN is a required field ResourceARN *string `min:"8" type:"string" required:"true"` // contains filtered or unexported fields }
The request object for ListTagsForResource operation.
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // This is present if there are more tags than returned in the response (String). // You can use the NextToken value in the later request to fetch the tags. NextToken *string `min:"1" type:"string"` // A list of tags on the resource. Tags []Tag `min:"1" type:"list"` // contains filtered or unexported fields }
The response object for ListTagsForResource operation.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.9.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.9.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type LustreFileSystemConfiguration ¶
type LustreFileSystemConfiguration struct { // The data repository configuration object for Lustre file systems returned // in the response of the CreateFileSystem operation. DataRepositoryConfiguration *DataRepositoryConfiguration `type:"structure"` // The UTC time that you want to begin your weekly maintenance window. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
The configuration for the Amazon FSx for Lustre file system.
func (LustreFileSystemConfiguration) String ¶
func (s LustreFileSystemConfiguration) String() string
String returns the string representation
type SelfManagedActiveDirectoryAttributes ¶ added in v0.10.0
type SelfManagedActiveDirectoryAttributes struct { // A list of up to two IP addresses of DNS servers or domain controllers in // the self-managed AD directory. DnsIps []string `min:"1" type:"list"` // The fully qualified domain name of the self-managed AD directory. DomainName *string `type:"string"` // The name of the domain group whose members have administrative privileges // for the FSx file system. FileSystemAdministratorsGroup *string `min:"1" type:"string"` // The fully qualified distinguished name of the organizational unit within // the self-managed AD directory to which the Windows File Server instance is // joined. OrganizationalUnitDistinguishedName *string `min:"1" type:"string"` // The user name for the service account on your self-managed AD domain that // FSx uses to join to your AD domain. UserName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.
func (SelfManagedActiveDirectoryAttributes) String ¶ added in v0.10.0
func (s SelfManagedActiveDirectoryAttributes) String() string
String returns the string representation
type SelfManagedActiveDirectoryConfiguration ¶ added in v0.10.0
type SelfManagedActiveDirectoryConfiguration struct { // A list of up to two IP addresses of DNS servers or domain controllers in // the self-managed AD directory. The IP addresses need to be either in the // same VPC CIDR range as the one in which your Amazon FSx file system is being // created, or in the private IP version 4 (Iv4) address ranges, as specified // in RFC 1918 (http://www.faqs.org/rfcs/rfc1918.html): // // * 10.0.0.0 - 10.255.255.255 (10/8 prefix) // // * 172.16.0.0 - 172.31.255.255 (172.16/12 prefix) // // * 192.168.0.0 - 192.168.255.255 (192.168/16 prefix) // // DnsIps is a required field DnsIps []string `min:"1" type:"list" required:"true"` // The fully qualified domain name of the self-managed AD directory, such as // corp.example.com. // // DomainName is a required field DomainName *string `type:"string" required:"true"` // (Optional) The name of the domain group whose members are granted administrative // privileges for the file system. Administrative privileges include taking // ownership of files and folders, and setting audit controls (audit ACLs) on // files and folders. The group that you specify must already exist in your // domain. If you don't provide one, your AD domain's Domain Admins group is // used. FileSystemAdministratorsGroup *string `min:"1" type:"string"` // (Optional) The fully qualified distinguished name of the organizational unit // within your self-managed AD directory that the Windows File Server instance // will join. Amazon FSx only accepts OU as the direct parent of the file system. // An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC // 2253 (https://tools.ietf.org/html/rfc2253). If none is provided, the FSx // file system is created in the default location of your self-managed AD directory. // // Only Organizational Unit (OU) objects can be the direct parent of the file // system that you're creating. OrganizationalUnitDistinguishedName *string `min:"1" type:"string"` // The password for the service account on your self-managed AD domain that // Amazon FSx will use to join to your AD domain. // // Password is a required field Password *string `min:"1" type:"string" required:"true" sensitive:"true"` // The user name for the service account on your self-managed AD domain that // Amazon FSx will use to join to your AD domain. This account must have the // permission to join computers to the domain in the organizational unit provided // in OrganizationalUnitDistinguishedName, or in the default location of your // AD domain. // // UserName is a required field UserName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
func (SelfManagedActiveDirectoryConfiguration) String ¶ added in v0.10.0
func (s SelfManagedActiveDirectoryConfiguration) String() string
String returns the string representation
func (*SelfManagedActiveDirectoryConfiguration) Validate ¶ added in v0.10.0
func (s *SelfManagedActiveDirectoryConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SelfManagedActiveDirectoryConfigurationUpdates ¶ added in v0.10.0
type SelfManagedActiveDirectoryConfigurationUpdates struct { // A list of up to two IP addresses of DNS servers or domain controllers in // the self-managed AD directory. DnsIps []string `min:"1" type:"list"` // The password for the service account on your self-managed AD domain that // Amazon FSx will use to join to your AD domain. Password *string `min:"1" type:"string" sensitive:"true"` // The user name for the service account on your self-managed AD domain that // Amazon FSx will use to join to your AD domain. This account must have the // permission to join computers to the domain in the organizational unit provided // in OrganizationalUnitDistinguishedName. UserName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The configuration that Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft Active Directory (AD) directory.
func (SelfManagedActiveDirectoryConfigurationUpdates) String ¶ added in v0.10.0
func (s SelfManagedActiveDirectoryConfigurationUpdates) String() string
String returns the string representation
func (*SelfManagedActiveDirectoryConfigurationUpdates) Validate ¶ added in v0.10.0
func (s *SelfManagedActiveDirectoryConfigurationUpdates) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceLimit ¶
type ServiceLimit string
The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific AWS Region. You can increase some of them by contacting AWS Support.
const ( ServiceLimitFileSystemCount ServiceLimit = "FILE_SYSTEM_COUNT" ServiceLimitTotalThroughputCapacity ServiceLimit = "TOTAL_THROUGHPUT_CAPACITY" ServiceLimitTotalStorage ServiceLimit = "TOTAL_STORAGE" ServiceLimitTotalUserInitiatedBackups ServiceLimit = "TOTAL_USER_INITIATED_BACKUPS" )
Enum values for ServiceLimit
func (ServiceLimit) MarshalValue ¶
func (enum ServiceLimit) MarshalValue() (string, error)
func (ServiceLimit) MarshalValueBuf ¶
func (enum ServiceLimit) MarshalValueBuf(b []byte) ([]byte, error)
type Tag ¶
type Tag struct { // A value that specifies the TagKey, the name of the tag. Tag keys must be // unique for the resource to which they are attached. Key *string `min:"1" type:"string"` // A value that specifies the TagValue, the value assigned to the corresponding // tag key. Tag values can be null and don't have to be unique in a tag set. // For example, you can have a key-value pair in a tag set of finances : April // and also of payroll : April. Value *string `type:"string"` // contains filtered or unexported fields }
Specifies a key-value pair for a resource tag.
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to // tag. // // ResourceARN is a required field ResourceARN *string `min:"8" type:"string" required:"true"` // A list of tags for the resource. If a tag with a given key already exists, // the value is replaced by the one specified in this parameter. // // Tags is a required field Tags []Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
The request object for the TagResource operation.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
The response object for the TagResource operation.
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.9.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.9.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type UntagResourceInput ¶
type UntagResourceInput struct { // The ARN of the Amazon FSx resource to untag. // // ResourceARN is a required field ResourceARN *string `min:"8" type:"string" required:"true"` // A list of keys of tags on the resource to untag. In case the tag key doesn't // exist, the call will still succeed to be idempotent. // // TagKeys is a required field TagKeys []string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
The request object for UntagResource action.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
The response object for UntagResource action.
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.9.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.9.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateFileSystemInput ¶
type UpdateFileSystemInput struct { // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to // ensure idempotent updates. This string is automatically filled on your behalf // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The globally unique ID of the file system, assigned by Amazon FSx. // // FileSystemId is a required field FileSystemId *string `min:"11" type:"string" required:"true"` // The configuration object for Amazon FSx for Lustre file systems used in the // UpdateFileSystem operation. LustreConfiguration *UpdateFileSystemLustreConfiguration `type:"structure"` // The configuration update for this Microsoft Windows file system. The only // supported options are for backup and maintenance and for self-managed Active // Directory configuration. WindowsConfiguration *UpdateFileSystemWindowsConfiguration `type:"structure"` // contains filtered or unexported fields }
The request object for the UpdateFileSystem operation.
func (UpdateFileSystemInput) String ¶
func (s UpdateFileSystemInput) String() string
String returns the string representation
func (*UpdateFileSystemInput) Validate ¶
func (s *UpdateFileSystemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateFileSystemLustreConfiguration ¶
type UpdateFileSystemLustreConfiguration struct { // The preferred time to perform weekly maintenance, in the UTC time zone. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
func (UpdateFileSystemLustreConfiguration) String ¶
func (s UpdateFileSystemLustreConfiguration) String() string
String returns the string representation
func (*UpdateFileSystemLustreConfiguration) Validate ¶
func (s *UpdateFileSystemLustreConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateFileSystemOutput ¶
type UpdateFileSystemOutput struct { // A description of the file system that was updated. FileSystem *FileSystem `type:"structure"` // contains filtered or unexported fields }
The response object for the UpdateFileSystem operation.
func (UpdateFileSystemOutput) String ¶
func (s UpdateFileSystemOutput) String() string
String returns the string representation
type UpdateFileSystemRequest ¶
type UpdateFileSystemRequest struct { *aws.Request Input *UpdateFileSystemInput Copy func(*UpdateFileSystemInput) UpdateFileSystemRequest }
UpdateFileSystemRequest is the request type for the UpdateFileSystem API operation.
func (UpdateFileSystemRequest) Send ¶
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.
type UpdateFileSystemWindowsConfiguration ¶
type UpdateFileSystemWindowsConfiguration struct { // The number of days to retain automatic backups. Setting this to 0 disables // automatic backups. You can retain automatic backups for a maximum of 35 days. AutomaticBackupRetentionDays *int64 `type:"integer"` // The preferred time to take daily automatic backups, in the UTC time zone. DailyAutomaticBackupStartTime *string `min:"5" type:"string"` // The configuration Amazon FSx uses to join the Windows File Server instance // to the self-managed Microsoft AD directory. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"` // The preferred time to perform weekly maintenance, in the UTC time zone. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
Updates the Microsoft Windows configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx overwrites existing properties with non-null values provided in the request. If you don't specify a non-null value for a property, that property is not updated.
func (UpdateFileSystemWindowsConfiguration) String ¶
func (s UpdateFileSystemWindowsConfiguration) String() string
String returns the string representation
func (*UpdateFileSystemWindowsConfiguration) Validate ¶
func (s *UpdateFileSystemWindowsConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WindowsFileSystemConfiguration ¶
type WindowsFileSystemConfiguration struct { // The ID for an existing Microsoft Active Directory instance that the file // system should join when it's created. ActiveDirectoryId *string `min:"12" type:"string"` // The number of days to retain automatic backups. Setting this to 0 disables // automatic backups. You can retain automatic backups for a maximum of 35 days. AutomaticBackupRetentionDays *int64 `type:"integer"` // A boolean flag indicating whether tags on the file system should be copied // to backups. This value defaults to false. If it's set to true, all tags on // the file system are copied to all automatic backups and any user-initiated // backups where the user doesn't specify any tags. If this value is true, and // you specify one or more tags, only the specified tags are copied to backups. CopyTagsToBackups *bool `type:"boolean"` // The preferred time to take daily automatic backups, in the UTC time zone. DailyAutomaticBackupStartTime *string `min:"5" type:"string"` // The list of maintenance operations in progress for this file system. MaintenanceOperationsInProgress []FileSystemMaintenanceOperation `type:"list"` // The configuration of the self-managed Microsoft Active Directory (AD) directory // to which the Windows File Server instance is joined. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryAttributes `type:"structure"` // The throughput of an Amazon FSx file system, measured in megabytes per second. ThroughputCapacity *int64 `min:"8" type:"integer"` // The preferred time to perform weekly maintenance, in the UTC time zone. WeeklyMaintenanceStartTime *string `min:"7" type:"string"` // contains filtered or unexported fields }
The configuration for this Microsoft Windows file system.
func (WindowsFileSystemConfiguration) String ¶
func (s WindowsFileSystemConfiguration) String() string
String returns the string representation
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateBackup.go
- api_op_CreateFileSystem.go
- api_op_CreateFileSystemFromBackup.go
- api_op_DeleteBackup.go
- api_op_DeleteFileSystem.go
- api_op_DescribeBackups.go
- api_op_DescribeFileSystems.go
- api_op_ListTagsForResource.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateFileSystem.go
- api_types.go