1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package fsx
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/fsx/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or
// Amazon FSx for OpenZFS file system from an existing Amazon FSx 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 file system with the specified client request token exists but 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 the 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 a success message 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.
//
// [DescribeFileSystems]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html
func (c *Client) CreateFileSystemFromBackup(ctx context.Context, params *CreateFileSystemFromBackupInput, optFns ...func(*Options)) (*CreateFileSystemFromBackupOutput, error) {
if params == nil {
params = &CreateFileSystemFromBackupInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateFileSystemFromBackup", params, optFns, c.addOperationCreateFileSystemFromBackupMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateFileSystemFromBackupOutput)
out.ResultMetadata = metadata
return out, nil
}
// The request object for the CreateFileSystemFromBackup operation.
type CreateFileSystemFromBackupInput struct {
// The ID of the source backup. Specifies the backup that you are copying.
//
// This member is required.
BackupId *string
// Specifies the IDs of the subnets that the file system will be accessible from.
// For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet
// IDs, one for the preferred file server and one for the standby file server. You
// specify one of these subnets as the preferred subnet using the
// WindowsConfiguration > PreferredSubnetID property.
//
// Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file
// systems, and OpenZFS file systems provide exactly one subnet ID. The file server
// is launched in that subnet's Availability Zone.
//
// This member is required.
SubnetIds []string
// A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent
// creation. This string is automatically filled on your behalf when you use the
// Command Line Interface (CLI) or an Amazon Web Services SDK.
ClientRequestToken *string
// Sets the version for the Amazon FSx for Lustre file system that you're creating
// from a backup. Valid values are 2.10 , 2.12 , and 2.15 .
//
// You don't need to specify FileSystemTypeVersion because it will be applied
// using the backup's FileSystemTypeVersion setting. If you choose to specify
// FileSystemTypeVersion when creating from backup, the value must match the
// backup's FileSystemTypeVersion setting.
FileSystemTypeVersion *string
// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
// data on Amazon FSx file systems, as follows:
//
// - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.
//
// SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key
// for your account.
//
// - Amazon FSx for NetApp ONTAP
//
// - Amazon FSx for OpenZFS
//
// - Amazon FSx for Windows File Server
//
// If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account
// is used. For more information, see [Encrypt]in the Key Management Service API Reference.
//
// [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
KmsKeyId *string
// The Lustre configuration for the file system being created.
//
// The following parameters are not supported for file systems with a data
// repository association created with .
//
// - AutoImportPolicy
//
// - ExportPath
//
// - ImportedFileChunkSize
//
// - ImportPath
LustreConfiguration *types.CreateFileSystemLustreConfiguration
// The OpenZFS configuration for the file system that's being created.
OpenZFSConfiguration *types.CreateFileSystemOpenZFSConfiguration
// 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 DescribeFileSystem
// requests.
SecurityGroupIds []string
// Sets the storage capacity of the OpenZFS file system that you're creating from
// a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB
// (512 TiB). However, the value that you specify must be equal to or greater than
// the backup's storage capacity value. If you don't use the StorageCapacity
// parameter, the default is the backup's StorageCapacity value.
//
// If used to create a file system other than OpenZFS, you must provide a value
// that matches the backup's StorageCapacity value. If you provide any other
// value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
StorageCapacity *int32
// Sets the storage type for the Windows or OpenZFS file system that you're
// creating from a backup. Valid values are SSD and HDD .
//
// - Set to SSD to use solid state drive storage. SSD is supported on all Windows
// and OpenZFS deployment types.
//
// - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2
// and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
//
// The default value is SSD .
//
// HDD and SSD storage types have different minimum storage capacity requirements.
// A restored file system's storage capacity is tied to the file system that was
// backed up. You can create a file system that uses HDD storage from a backup of a
// file system that used SSD storage if the original SSD file system had a storage
// capacity of at least 2000 GiB.
StorageType types.StorageType
// 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 []types.Tag
// The configuration for this Microsoft Windows file system.
WindowsConfiguration *types.CreateFileSystemWindowsConfiguration
noSmithyDocumentSerde
}
// The response object for the CreateFileSystemFromBackup operation.
type CreateFileSystemFromBackupOutput struct {
// A description of the file system.
FileSystem *types.FileSystem
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateFileSystemFromBackupMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateFileSystemFromBackup{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateFileSystemFromBackup{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateFileSystemFromBackup"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addIdempotencyToken_opCreateFileSystemFromBackupMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateFileSystemFromBackupValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateFileSystemFromBackup(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpCreateFileSystemFromBackup struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateFileSystemFromBackup) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateFileSystemFromBackup) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateFileSystemFromBackupInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateFileSystemFromBackupInput ")
}
if input.ClientRequestToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientRequestToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateFileSystemFromBackupMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateFileSystemFromBackup{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateFileSystemFromBackup(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateFileSystemFromBackup",
}
}
|