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.StorageGateway.Types.GatewayInfo

Description

Synopsis

data GatewayInfo = GatewayInfo' {
- ec2InstanceId :: Maybe Text
- ec2InstanceRegion :: Maybe Text
- gatewayARN :: Maybe Text
- gatewayId :: Maybe Text
- gatewayName :: Maybe Text
- gatewayOperationalState :: Maybe Text
- gatewayType :: Maybe Text
- hostEnvironment :: Maybe HostEnvironment
- hostEnvironmentId :: Maybe Text
}
newGatewayInfo :: GatewayInfo
gatewayInfo_ec2InstanceId :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_ec2InstanceRegion :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_gatewayARN :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_gatewayId :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_gatewayName :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_gatewayOperationalState :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_gatewayType :: Lens' GatewayInfo (Maybe Text)
gatewayInfo_hostEnvironment :: Lens' GatewayInfo (Maybe HostEnvironment)
gatewayInfo_hostEnvironmentId :: Lens' GatewayInfo (Maybe Text)

Documentation

data GatewayInfo Source #

Describes a gateway object.

See: newGatewayInfo smart constructor.

Constructors

GatewayInfo'

Fields

ec2InstanceId :: Maybe Text
The ID of the Amazon EC2 instance that was used to launch the gateway.
ec2InstanceRegion :: Maybe Text
The Amazon Web Services Region where the Amazon EC2 instance is located.
gatewayARN :: Maybe Text
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
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.
gatewayName :: Maybe Text
The name of the gateway.
gatewayOperationalState :: Maybe Text
The state of the gateway.
Valid Values: DISABLED | ACTIVE
gatewayType :: Maybe Text
The type of the gateway.
hostEnvironment :: Maybe HostEnvironment
The type of hardware or software platform on which the gateway is running.
hostEnvironmentId :: Maybe Text
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

Instances

Instances details

FromJSON GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods parseJSON :: Value -> Parser GatewayInfo # parseJSONList :: Value -> Parser [GatewayInfo] #
Generic GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Associated Types type Rep GatewayInfo :: Type -> Type # Methods from :: GatewayInfo -> Rep GatewayInfo x # to :: Rep GatewayInfo x -> GatewayInfo #
Read GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods readsPrec :: Int -> ReadS GatewayInfo # readList :: ReadS [GatewayInfo] # readPrec :: ReadPrec GatewayInfo # readListPrec :: ReadPrec [GatewayInfo] #
Show GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods showsPrec :: Int -> GatewayInfo -> ShowS # show :: GatewayInfo -> String # showList :: [GatewayInfo] -> ShowS #
NFData GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods rnf :: GatewayInfo -> () #
Eq GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods (==) :: GatewayInfo -> GatewayInfo -> Bool # (/=) :: GatewayInfo -> GatewayInfo -> Bool #
Hashable GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo Methods hashWithSalt :: Int -> GatewayInfo -> Int # hash :: GatewayInfo -> Int #
type Rep GatewayInfo Source #
Instance details Defined in Amazonka.StorageGateway.Types.GatewayInfo type Rep GatewayInfo = D1 ('MetaData "GatewayInfo" "Amazonka.StorageGateway.Types.GatewayInfo" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "GatewayInfo'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ec2InstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ec2InstanceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gatewayOperationalState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "gatewayType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hostEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostEnvironment)) :: S1 ('MetaSel ('Just "hostEnvironmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newGatewayInfo :: GatewayInfo Source #

Create a value of GatewayInfo 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:ec2InstanceId:GatewayInfo', gatewayInfo_ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.

$sel:ec2InstanceRegion:GatewayInfo', gatewayInfo_ec2InstanceRegion - The Amazon Web Services Region where the Amazon EC2 instance is located.

$sel:gatewayARN:GatewayInfo', gatewayInfo_gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

$sel:gatewayId:GatewayInfo', gatewayInfo_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.

$sel:gatewayName:GatewayInfo', gatewayInfo_gatewayName - The name of the gateway.

$sel:gatewayOperationalState:GatewayInfo', gatewayInfo_gatewayOperationalState - The state of the gateway.

Valid Values: DISABLED | ACTIVE

$sel:gatewayType:GatewayInfo', gatewayInfo_gatewayType - The type of the gateway.

$sel:hostEnvironment:GatewayInfo', gatewayInfo_hostEnvironment - The type of hardware or software platform on which the gateway is running.

$sel:hostEnvironmentId:GatewayInfo', gatewayInfo_hostEnvironmentId - A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

gatewayInfo_ec2InstanceId :: Lens' GatewayInfo (Maybe Text) Source #

The ID of the Amazon EC2 instance that was used to launch the gateway.

gatewayInfo_ec2InstanceRegion :: Lens' GatewayInfo (Maybe Text) Source #

The Amazon Web Services Region where the Amazon EC2 instance is located.

gatewayInfo_gatewayARN :: Lens' GatewayInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

gatewayInfo_gatewayId :: Lens' GatewayInfo (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.

gatewayInfo_gatewayName :: Lens' GatewayInfo (Maybe Text) Source #

The name of the gateway.

gatewayInfo_gatewayOperationalState :: Lens' GatewayInfo (Maybe Text) Source #

The state of the gateway.

Valid Values: DISABLED | ACTIVE

gatewayInfo_gatewayType :: Lens' GatewayInfo (Maybe Text) Source #

The type of the gateway.

gatewayInfo_hostEnvironment :: Lens' GatewayInfo (Maybe HostEnvironment) Source #

The type of hardware or software platform on which the gateway is running.

gatewayInfo_hostEnvironmentId :: Lens' GatewayInfo (Maybe Text) Source #

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.