Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Snowball.CreateCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateCluster = CreateCluster' {
- description :: Maybe Text
- forwardingAddressId :: Maybe Text
- kmsKeyARN :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- remoteManagement :: Maybe RemoteManagement
- taxDocuments :: Maybe TaxDocuments
- jobType :: JobType
- resources :: JobResource
- addressId :: Text
- roleARN :: Text
- snowballType :: SnowballType
- shippingOption :: ShippingOption
}
newCreateCluster :: JobType -> JobResource -> Text -> Text -> SnowballType -> ShippingOption -> CreateCluster
createCluster_description :: Lens' CreateCluster (Maybe Text)
createCluster_forwardingAddressId :: Lens' CreateCluster (Maybe Text)
createCluster_kmsKeyARN :: Lens' CreateCluster (Maybe Text)
createCluster_notification :: Lens' CreateCluster (Maybe Notification)
createCluster_onDeviceServiceConfiguration :: Lens' CreateCluster (Maybe OnDeviceServiceConfiguration)
createCluster_remoteManagement :: Lens' CreateCluster (Maybe RemoteManagement)
createCluster_taxDocuments :: Lens' CreateCluster (Maybe TaxDocuments)
createCluster_jobType :: Lens' CreateCluster JobType
createCluster_resources :: Lens' CreateCluster JobResource
createCluster_addressId :: Lens' CreateCluster Text
createCluster_roleARN :: Lens' CreateCluster Text
createCluster_snowballType :: Lens' CreateCluster SnowballType
createCluster_shippingOption :: Lens' CreateCluster ShippingOption
data CreateClusterResponse = CreateClusterResponse' {
- clusterId :: Maybe Text
- httpStatus :: Int
}
newCreateClusterResponse :: Int -> CreateClusterResponse
createClusterResponse_clusterId :: Lens' CreateClusterResponse (Maybe Text)
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster'

Fields

description :: Maybe Text
An optional description of this specific cluster, for example Environmental Data Cluster-01.
forwardingAddressId :: Maybe Text
The forwarding address ID for a cluster. This field is not supported in most regions.
kmsKeyARN :: Maybe Text
The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).
notification :: Maybe Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
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).
remoteManagement :: Maybe RemoteManagement
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.
taxDocuments :: Maybe TaxDocuments
The tax documents required in your Amazon Web Services Region.
jobType :: JobType
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.
resources :: JobResource
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
addressId :: Text
The ID for the address that you want the cluster shipped to.
roleARN :: Text
The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).
snowballType :: SnowballType
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.
shippingOption :: ShippingOption
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.

Instances

Instances details

ToJSON CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods toJSON :: CreateCluster -> Value # toEncoding :: CreateCluster -> Encoding # toJSONList :: [CreateCluster] -> Value # toEncodingList :: [CreateCluster] -> Encoding #
ToHeaders CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods toHeaders :: CreateCluster -> [Header] #
ToPath CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods toPath :: CreateCluster -> ByteString #
ToQuery CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods toQuery :: CreateCluster -> QueryString #
AWSRequest CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Associated Types type AWSResponse CreateCluster # Methods request :: (Service -> Service) -> CreateCluster -> Request CreateCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCluster))) #
Generic CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Associated Types type Rep CreateCluster :: Type -> Type # Methods from :: CreateCluster -> Rep CreateCluster x # to :: Rep CreateCluster x -> CreateCluster #
Read CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods readsPrec :: Int -> ReadS CreateCluster # readList :: ReadS [CreateCluster] # readPrec :: ReadPrec CreateCluster # readListPrec :: ReadPrec [CreateCluster] #
Show CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods showsPrec :: Int -> CreateCluster -> ShowS # show :: CreateCluster -> String # showList :: [CreateCluster] -> ShowS #
NFData CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods rnf :: CreateCluster -> () #
Eq CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods (==) :: CreateCluster -> CreateCluster -> Bool # (/=) :: CreateCluster -> CreateCluster -> Bool #
Hashable CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods hashWithSalt :: Int -> CreateCluster -> Int # hash :: CreateCluster -> Int #
type AWSResponse CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster type AWSResponse CreateCluster = CreateClusterResponse
type Rep CreateCluster Source #
Instance details Defined in Amazonka.Snowball.CreateCluster type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.Snowball.CreateCluster" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "forwardingAddressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Notification)) :: (S1 ('MetaSel ('Just "onDeviceServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnDeviceServiceConfiguration)) :: S1 ('MetaSel ('Just "remoteManagement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RemoteManagement))))) :: ((S1 ('MetaSel ('Just "taxDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaxDocuments)) :: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType) :: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobResource))) :: ((S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "snowballType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnowballType) :: S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShippingOption))))))

newCreateCluster Source #

Arguments

:: JobType	`CreateCluster`
-> JobResource	`CreateCluster`
-> Text	`CreateCluster`
-> Text	`CreateCluster`
-> SnowballType	`CreateCluster`
-> ShippingOption	`CreateCluster`
-> CreateCluster

Create a value of CreateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCluster, createCluster_description - An optional description of this specific cluster, for example Environmental Data Cluster-01.

CreateCluster, createCluster_forwardingAddressId - The forwarding address ID for a cluster. This field is not supported in most regions.

CreateCluster, createCluster_kmsKeyARN - The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).

CreateCluster, createCluster_notification - The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

CreateCluster, createCluster_onDeviceServiceConfiguration - 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).

CreateCluster, createCluster_remoteManagement - 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.

CreateCluster, createCluster_taxDocuments - The tax documents required in your Amazon Web Services Region.

CreateCluster, createCluster_jobType - 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.

CreateCluster, createCluster_resources - The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.

CreateCluster, createCluster_addressId - The ID for the address that you want the cluster shipped to.

CreateCluster, createCluster_roleARN - The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).

CreateCluster, createCluster_snowballType - 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.

CreateCluster, createCluster_shippingOption - 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.

Request Lenses

createCluster_description :: Lens' CreateCluster (Maybe Text) Source #

An optional description of this specific cluster, for example Environmental Data Cluster-01.

createCluster_forwardingAddressId :: Lens' CreateCluster (Maybe Text) Source #

The forwarding address ID for a cluster. This field is not supported in most regions.

createCluster_kmsKeyARN :: Lens' CreateCluster (Maybe Text) Source #

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).

createCluster_notification :: Lens' CreateCluster (Maybe Notification) Source #

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

createCluster_onDeviceServiceConfiguration :: Lens' CreateCluster (Maybe OnDeviceServiceConfiguration) Source #

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

createCluster_remoteManagement :: Lens' CreateCluster (Maybe RemoteManagement) Source #

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.

createCluster_taxDocuments :: Lens' CreateCluster (Maybe TaxDocuments) Source #

The tax documents required in your Amazon Web Services Region.

createCluster_jobType :: Lens' CreateCluster JobType Source #

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.

createCluster_resources :: Lens' CreateCluster JobResource Source #

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.

createCluster_addressId :: Lens' CreateCluster Text Source #

The ID for the address that you want the cluster shipped to.

createCluster_roleARN :: Lens' CreateCluster Text Source #

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).

createCluster_snowballType :: Lens' CreateCluster SnowballType Source #

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.

createCluster_shippingOption :: Lens' CreateCluster ShippingOption Source #

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.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse'
Fields clusterId :: Maybe Text The automatically generated ID for a cluster. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Associated Types type Rep CreateClusterResponse :: Type -> Type # Methods from :: CreateClusterResponse -> Rep CreateClusterResponse x # to :: Rep CreateClusterResponse x -> CreateClusterResponse #
Read CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods readsPrec :: Int -> ReadS CreateClusterResponse # readList :: ReadS [CreateClusterResponse] # readPrec :: ReadPrec CreateClusterResponse # readListPrec :: ReadPrec [CreateClusterResponse] #
Show CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods showsPrec :: Int -> CreateClusterResponse -> ShowS # show :: CreateClusterResponse -> String # showList :: [CreateClusterResponse] -> ShowS #
NFData CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods rnf :: CreateClusterResponse -> () #
Eq CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster Methods (==) :: CreateClusterResponse -> CreateClusterResponse -> Bool # (/=) :: CreateClusterResponse -> CreateClusterResponse -> Bool #
type Rep CreateClusterResponse Source #
Instance details Defined in Amazonka.Snowball.CreateCluster type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.Snowball.CreateCluster" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CreateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateClusterResponse'`
-> CreateClusterResponse

Create a value of CreateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateClusterResponse, createClusterResponse_clusterId - The automatically generated ID for a cluster.

$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

Response Lenses

createClusterResponse_clusterId :: Lens' CreateClusterResponse (Maybe Text) Source #

The automatically generated ID for a cluster.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.