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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package storagegateway
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/storagegateway/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a volume on a specified gateway. This operation is only supported in
// the stored volume gateway type. The size of the volume to create is inferred
// from the disk size. You can choose to preserve existing data on the disk, create
// volume from an existing snapshot, or create an empty volume. If you choose to
// create an empty gateway volume, then any existing data on the disk is erased. In
// the request, you must specify the gateway and the disk information on which you
// are creating the volume. In response, the gateway creates the volume and returns
// volume information such as the volume Amazon Resource Name (ARN), its size, and
// the iSCSI target ARN that initiators can use to connect to the volume target.
func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStorediSCSIVolumeInput, optFns ...func(*Options)) (*CreateStorediSCSIVolumeOutput, error) {
if params == nil {
params = &CreateStorediSCSIVolumeInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateStorediSCSIVolume", params, optFns, c.addOperationCreateStorediSCSIVolumeMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateStorediSCSIVolumeOutput)
out.ResultMetadata = metadata
return out, nil
}
// A JSON object containing one or more of the following fields:
// - CreateStorediSCSIVolumeInput$DiskId
// - CreateStorediSCSIVolumeInput$NetworkInterfaceId
// - CreateStorediSCSIVolumeInput$PreserveExistingData
// - CreateStorediSCSIVolumeInput$SnapshotId
// - CreateStorediSCSIVolumeInput$TargetName
type CreateStorediSCSIVolumeInput struct {
// The unique identifier for the gateway local disk that is configured as a stored
// volume. Use ListLocalDisks (https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html)
// to list disk IDs for a gateway.
//
// This member is required.
DiskId *string
// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
// to return a list of gateways for your account and Amazon Web Services Region.
//
// This member is required.
GatewayARN *string
// The network interface of the gateway on which to expose the iSCSI target. Only
// IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of
// the network interfaces available on a gateway. Valid Values: A valid IP address.
//
// This member is required.
NetworkInterfaceId *string
// Set to true if you want to preserve the data on the local disk. Otherwise, set
// to false to create an empty volume. Valid Values: true | false
//
// This member is required.
PreserveExistingData bool
// The name of the iSCSI target used by an initiator to connect to a volume and
// used as a suffix for the target ARN. For example, specifying TargetName as
// myvolume results in the target ARN of
// arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
// . The target name must be unique across all volumes on a gateway. If you don't
// specify a value, Storage Gateway uses the value that was previously used for
// this volume as the new target name.
//
// This member is required.
TargetName *string
// Set to true to use Amazon S3 server-side encryption with your own KMS key, or
// false to use a key managed by Amazon S3. Optional. Valid Values: true | false
KMSEncrypted *bool
// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
// for Amazon S3 server-side encryption. Storage Gateway does not support
// asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
KMSKey *string
// The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new
// stored volume. Specify this field if you want to create the iSCSI storage volume
// from a snapshot; otherwise, do not include this field. To list snapshots for
// your account use DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html)
// in the Amazon Elastic Compute Cloud API Reference.
SnapshotId *string
// A list of up to 50 tags that can be assigned to a stored volume. Each tag is a
// key-value pair. Valid characters for key and value are letters, spaces, and
// numbers representable in UTF-8 format, and the following special characters: + -
// = . _ : / @. The maximum length of a tag's key is 128 characters, and the
// maximum length for a tag's value is 256.
Tags []types.Tag
noSmithyDocumentSerde
}
// A JSON object containing the following fields:
type CreateStorediSCSIVolumeOutput struct {
// The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI
// name that initiators can use to connect to the target.
TargetARN *string
// The Amazon Resource Name (ARN) of the configured volume.
VolumeARN *string
// The size of the volume in bytes.
VolumeSizeInBytes int64
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateStorediSCSIVolumeMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateStorediSCSIVolume{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateStorediSCSIVolume{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateStorediSCSIVolume"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpCreateStorediSCSIVolumeValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateStorediSCSIVolume(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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
}
func newServiceMetadataMiddleware_opCreateStorediSCSIVolume(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateStorediSCSIVolume",
}
}
|