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

Amazonka.Snowball.Types.ClusterMetadata

Description

 
Synopsis

Documentation

data ClusterMetadata Source #

Contains metadata about a specific cluster.

See: newClusterMetadata smart constructor.

Constructors

ClusterMetadata' 

Fields

  • jobType :: Maybe JobType

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

  • kmsKeyARN :: Maybe Text

    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

  • clusterState :: Maybe ClusterState

    The current status of the cluster.

  • notification :: Maybe Notification

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

  • forwardingAddressId :: Maybe Text

    The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

  • addressId :: Maybe Text

    The automatically generated ID for a specific address.

  • snowballType :: Maybe SnowballType

    The type of AWS Snow device to use for this cluster.

    For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

  • shippingOption :: Maybe ShippingOption

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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.
  • resources :: Maybe JobResource

    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

  • onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration

    Represents metadata and configuration settings for services on an AWS Snow Family device.

  • clusterId :: Maybe Text

    The automatically generated ID for a cluster.

  • creationDate :: Maybe POSIX

    The creation date for this cluster.

  • description :: Maybe Text

    The optional description of the cluster.

  • taxDocuments :: Maybe TaxDocuments

    The tax documents required in your AWS Region.

  • roleARN :: Maybe Text

    The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Instances

Instances details
Eq ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

Read ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

Show ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

Generic ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

Associated Types

type Rep ClusterMetadata :: Type -> Type #

NFData ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

Methods

rnf :: ClusterMetadata -> () #

Hashable ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

FromJSON ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

type Rep ClusterMetadata Source # 
Instance details

Defined in Amazonka.Snowball.Types.ClusterMetadata

type Rep ClusterMetadata = D1 ('MetaData "ClusterMetadata" "Amazonka.Snowball.Types.ClusterMetadata" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "ClusterMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :*: (S1 ('MetaSel ('Just "kmsKeyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)))) :*: ((S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Notification)) :*: S1 ('MetaSel ('Just "forwardingAddressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snowballType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnowballType))))) :*: (((S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingOption)) :*: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobResource))) :*: (S1 ('MetaSel ('Just "onDeviceServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnDeviceServiceConfiguration)) :*: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "taxDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaxDocuments)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newClusterMetadata :: ClusterMetadata Source #

Create a value of ClusterMetadata 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:

$sel:jobType:ClusterMetadata', clusterMetadata_jobType - The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

$sel:kmsKeyARN:ClusterMetadata', clusterMetadata_kmsKeyARN - The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

$sel:clusterState:ClusterMetadata', clusterMetadata_clusterState - The current status of the cluster.

$sel:notification:ClusterMetadata', clusterMetadata_notification - The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

$sel:forwardingAddressId:ClusterMetadata', clusterMetadata_forwardingAddressId - The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

$sel:addressId:ClusterMetadata', clusterMetadata_addressId - The automatically generated ID for a specific address.

$sel:snowballType:ClusterMetadata', clusterMetadata_snowballType - The type of AWS Snow device to use for this cluster.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

$sel:shippingOption:ClusterMetadata', clusterMetadata_shippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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.

$sel:resources:ClusterMetadata', clusterMetadata_resources - The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

$sel:onDeviceServiceConfiguration:ClusterMetadata', clusterMetadata_onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an AWS Snow Family device.

$sel:clusterId:ClusterMetadata', clusterMetadata_clusterId - The automatically generated ID for a cluster.

$sel:creationDate:ClusterMetadata', clusterMetadata_creationDate - The creation date for this cluster.

$sel:description:ClusterMetadata', clusterMetadata_description - The optional description of the cluster.

$sel:taxDocuments:ClusterMetadata', clusterMetadata_taxDocuments - The tax documents required in your AWS Region.

$sel:roleARN:ClusterMetadata', clusterMetadata_roleARN - The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

clusterMetadata_jobType :: Lens' ClusterMetadata (Maybe JobType) Source #

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

clusterMetadata_kmsKeyARN :: Lens' ClusterMetadata (Maybe Text) Source #

The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

clusterMetadata_notification :: Lens' ClusterMetadata (Maybe Notification) Source #

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

clusterMetadata_forwardingAddressId :: Lens' ClusterMetadata (Maybe Text) Source #

The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

clusterMetadata_addressId :: Lens' ClusterMetadata (Maybe Text) Source #

The automatically generated ID for a specific address.

clusterMetadata_snowballType :: Lens' ClusterMetadata (Maybe SnowballType) Source #

The type of AWS Snow device to use for this cluster.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

clusterMetadata_shippingOption :: Lens' ClusterMetadata (Maybe ShippingOption) Source #

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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.

clusterMetadata_resources :: Lens' ClusterMetadata (Maybe JobResource) Source #

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

clusterMetadata_onDeviceServiceConfiguration :: Lens' ClusterMetadata (Maybe OnDeviceServiceConfiguration) Source #

Represents metadata and configuration settings for services on an AWS Snow Family device.

clusterMetadata_clusterId :: Lens' ClusterMetadata (Maybe Text) Source #

The automatically generated ID for a cluster.

clusterMetadata_creationDate :: Lens' ClusterMetadata (Maybe UTCTime) Source #

The creation date for this cluster.

clusterMetadata_description :: Lens' ClusterMetadata (Maybe Text) Source #

The optional description of the cluster.

clusterMetadata_taxDocuments :: Lens' ClusterMetadata (Maybe TaxDocuments) Source #

The tax documents required in your AWS Region.

clusterMetadata_roleARN :: Lens' ClusterMetadata (Maybe Text) Source #

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).