libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
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.StorageGateway.Types.VolumeInfo

Description

 
Synopsis

Documentation

data VolumeInfo Source #

Describes a storage volume object.

See: newVolumeInfo smart constructor.

Constructors

VolumeInfo' 

Fields

  • gatewayARN :: Maybe Text
     
  • volumeAttachmentStatus :: Maybe Text

    One of the VolumeStatus values that indicates the state of the storage volume.

  • volumeARN :: Maybe Text

    The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

    arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

  • volumeSizeInBytes :: Maybe Integer

    The size of the volume in bytes.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

  • volumeId :: Maybe Text

    The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

  • gatewayId :: Maybe Text

    The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

  • volumeType :: Maybe Text

    One of the VolumeType enumeration values describing the type of the volume.

Instances

Instances details
Eq VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Read VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Show VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Generic VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Associated Types

type Rep VolumeInfo :: Type -> Type #

NFData VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

rnf :: VolumeInfo -> () #

Hashable VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

FromJSON VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

type Rep VolumeInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.VolumeInfo

type Rep VolumeInfo = D1 ('MetaData "VolumeInfo" "Amazonka.StorageGateway.Types.VolumeInfo" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "VolumeInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "volumeAttachmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "volumeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVolumeInfo :: VolumeInfo Source #

Create a value of VolumeInfo 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:gatewayARN:VolumeInfo', volumeInfo_gatewayARN - Undocumented member.

$sel:volumeAttachmentStatus:VolumeInfo', volumeInfo_volumeAttachmentStatus - One of the VolumeStatus values that indicates the state of the storage volume.

$sel:volumeARN:VolumeInfo', volumeInfo_volumeARN - The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

$sel:volumeSizeInBytes:VolumeInfo', volumeInfo_volumeSizeInBytes - The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

$sel:volumeId:VolumeInfo', volumeInfo_volumeId - The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

$sel:gatewayId:VolumeInfo', volumeInfo_gatewayId - The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

$sel:volumeType:VolumeInfo', volumeInfo_volumeType - One of the VolumeType enumeration values describing the type of the volume.

volumeInfo_volumeAttachmentStatus :: Lens' VolumeInfo (Maybe Text) Source #

One of the VolumeStatus values that indicates the state of the storage volume.

volumeInfo_volumeARN :: Lens' VolumeInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeInfo_volumeSizeInBytes :: Lens' VolumeInfo (Maybe Integer) Source #

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeInfo_volumeId :: Lens' VolumeInfo (Maybe Text) Source #

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeInfo_gatewayId :: Lens' VolumeInfo (Maybe Text) Source #

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeInfo_volumeType :: Lens' VolumeInfo (Maybe Text) Source #

One of the VolumeType enumeration values describing the type of the volume.