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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package snowball
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/snowball/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an empty cluster. Each cluster supports five nodes. You use the
// CreateJob action separately to create the jobs for each of these nodes. The
// cluster does not ship until these five node jobs have been created.
func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) {
if params == nil {
params = &CreateClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateCluster", params, optFns, c.addOperationCreateClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateClusterInput struct {
// The ID for the address that you want the cluster shipped to.
//
// This member is required.
AddressId *string
// The type of job for this cluster. Currently, the only job type supported for
// clusters is LOCAL_USE . For more information, see
// "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide or
// "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide.
//
// This member is required.
JobType types.JobType
// The shipping speed for each node in this cluster. This speed doesn't dictate
// how soon you'll get each Snowball Edge device, rather it represents how quickly
// each device moves to its destination while in transit. Regional shipping speeds
// are as follows:
// - In Australia, you have access to express shipping. Typically, Snow devices
// shipped express are delivered in about a day.
// - In the European Union (EU), you have access to express shipping. Typically,
// Snow devices shipped express are delivered in about a day. In addition, most
// countries in the EU have access to standard shipping, which typically takes less
// than a week, one way.
// - In India, Snow devices are delivered in one to seven days.
// - In the United States of America (US), you have access to one-day shipping
// and two-day shipping.
//
// - In Australia, you have access to express shipping. Typically, devices
// shipped express are delivered in about a day.
// - In the European Union (EU), you have access to express shipping. Typically,
// Snow devices shipped express are delivered in about a day. In addition, most
// countries in the EU have access to standard shipping, which typically takes less
// than a week, one way.
// - In India, Snow devices are delivered in one to seven days.
// - In the US, you have access to one-day shipping and two-day shipping.
//
// This member is required.
ShippingOption types.ShippingOption
// The type of Snow Family devices to use for this cluster. For cluster jobs,
// Amazon Web Services Snow Family currently supports only the EDGE device type.
// For more information, see
// "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide or
// "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide.
//
// This member is required.
SnowballType types.SnowballType
// An optional description of this specific cluster, for example Environmental
// Data Cluster-01 .
Description *string
// Force to create cluster when user attempts to overprovision or underprovision a
// cluster. A cluster is overprovisioned or underprovisioned if the initial size of
// the cluster is more (overprovisioned) or less (underprovisioned) than what
// needed to meet capacity requirement specified with OnDeviceServiceConfiguration .
ForceCreateJobs bool
// The forwarding address ID for a cluster. This field is not supported in most
// regions.
ForwardingAddressId *string
// If provided, each job will be automatically created and associated with the new
// cluster. If not provided, will be treated as 0.
InitialClusterSize *int32
// The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN
// values are created by using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html)
// API action in Key Management Service (KMS).
KmsKeyARN *string
// Lists long-term pricing id that will be used to associate with jobs
// automatically created for the new cluster.
LongTermPricingIds []string
// The Amazon Simple Notification Service (Amazon SNS) notification settings for
// this cluster.
Notification *types.Notification
// Specifies the service or services on the Snow Family device that your
// transferred data will be exported from or imported into. Amazon Web Services
// Snow Family device clusters support Amazon S3 and NFS (Network File System).
OnDeviceServiceConfiguration *types.OnDeviceServiceConfiguration
// Allows you to securely operate and manage Snow devices in a cluster remotely
// from outside of your internal network. When set to INSTALLED_AUTOSTART , remote
// management will automatically be available when the device arrives at your
// location. Otherwise, you need to use the Snowball Client to manage the device.
RemoteManagement types.RemoteManagement
// The resources associated with the cluster job. These resources include Amazon
// S3 buckets and optional Lambda functions written in the Python language.
Resources *types.JobResource
// The RoleARN that you want to associate with this cluster. RoleArn values are
// created by using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)
// API action in Identity and Access Management (IAM).
RoleARN *string
// If your job is being created in one of the US regions, you have the option of
// specifying what size Snow device you'd like for this job. In all other regions,
// Snowballs come with 80 TB in storage capacity. For more information, see
// "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide or
// "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html"
// (Snow Family Devices and Capacity) in the Snowcone User Guide.
SnowballCapacityPreference types.SnowballCapacity
// The tax documents required in your Amazon Web Services Region.
TaxDocuments *types.TaxDocuments
noSmithyDocumentSerde
}
type CreateClusterOutput struct {
// The automatically generated ID for a cluster.
ClusterId *string
// List of jobs created for this cluster. For syntax, see
// ListJobsResult$JobListEntries (http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax)
// in this guide.
JobListEntries []types.JobListEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateCluster{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateCluster"); 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 = addOpCreateClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateCluster(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_opCreateCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateCluster",
}
}
|