amazonka-snowball-1.4.5: Amazon Import/Export Snowball SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Snowball.CreateCluster

Contents

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

Creating a Request

createCluster #

Creates a value of CreateCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ccKMSKeyARN - The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).
  • ccNotification - The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
  • ccSnowballType - The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE .
  • ccDescription - An optional description of this specific cluster, for example Environmental Data Cluster-01 .
  • ccJobType - The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .
  • ccResources - The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.
  • ccAddressId - The ID for the address that you want the cluster shipped to.>
  • ccRoleARN - The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).
  • ccShippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: * In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days. * In the US, you have access to one-day shipping and two-day shipping.

data CreateCluster #

See: createCluster smart constructor.

Instances

Eq CreateCluster # 
Data CreateCluster # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCluster -> c CreateCluster #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCluster #

toConstr :: CreateCluster -> Constr #

dataTypeOf :: CreateCluster -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateCluster) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCluster) #

gmapT :: (forall b. Data b => b -> b) -> CreateCluster -> CreateCluster #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCluster -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCluster -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateCluster -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCluster -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster #

Read CreateCluster # 
Show CreateCluster # 
Generic CreateCluster # 

Associated Types

type Rep CreateCluster :: * -> * #

Hashable CreateCluster # 
ToJSON CreateCluster # 
NFData CreateCluster # 

Methods

rnf :: CreateCluster -> () #

AWSRequest CreateCluster # 
ToQuery CreateCluster # 
ToPath CreateCluster # 
ToHeaders CreateCluster # 
type Rep CreateCluster # 
type Rs CreateCluster # 

Request Lenses

ccKMSKeyARN :: Lens' CreateCluster (Maybe Text) #

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

ccNotification :: Lens' CreateCluster (Maybe Notification) #

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

ccSnowballType :: Lens' CreateCluster (Maybe SnowballType) #

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE .

ccDescription :: Lens' CreateCluster (Maybe Text) #

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

ccJobType :: Lens' CreateCluster JobType #

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .

ccResources :: Lens' CreateCluster JobResource #

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

ccAddressId :: Lens' CreateCluster Text #

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

ccRoleARN :: Lens' CreateCluster Text #

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

ccShippingOption :: Lens' CreateCluster ShippingOption #

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: * In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days. * In the US, you have access to one-day shipping and two-day shipping.

Destructuring the Response

createClusterResponse #

Creates a value of CreateClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateClusterResponse #

See: createClusterResponse smart constructor.

Instances

Eq CreateClusterResponse # 
Data CreateClusterResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateClusterResponse -> c CreateClusterResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateClusterResponse #

toConstr :: CreateClusterResponse -> Constr #

dataTypeOf :: CreateClusterResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateClusterResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateClusterResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateClusterResponse -> CreateClusterResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateClusterResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateClusterResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateClusterResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateClusterResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse #

Read CreateClusterResponse # 
Show CreateClusterResponse # 
Generic CreateClusterResponse # 
NFData CreateClusterResponse # 

Methods

rnf :: CreateClusterResponse -> () #

type Rep CreateClusterResponse # 
type Rep CreateClusterResponse = D1 (MetaData "CreateClusterResponse" "Network.AWS.Snowball.CreateCluster" "amazonka-snowball-1.4.5-wNtnwVdLva9LKtLOJgrwh" False) (C1 (MetaCons "CreateClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crersClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

crersClusterId :: Lens' CreateClusterResponse (Maybe Text) #

The automatically generated ID for a cluster.

crersResponseStatus :: Lens' CreateClusterResponse Int #

  • - | The response status code.