amazonka-greengrassv2-2.0: Amazon IoT Greengrass V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GreengrassV2.Types.ConnectivityInfo

Description

 
Synopsis

Documentation

data ConnectivityInfo Source #

Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.

See: newConnectivityInfo smart constructor.

Constructors

ConnectivityInfo' 

Fields

  • hostAddress :: Maybe Text

    The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.

  • id :: Maybe Text

    An ID for the connectivity information.

  • metadata :: Maybe Text

    Additional metadata to provide to client devices that connect to this core device.

  • portNumber :: Maybe Natural

    The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.

Instances

Instances details
FromJSON ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

ToJSON ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

Generic ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

Associated Types

type Rep ConnectivityInfo :: Type -> Type #

Read ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

Show ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

NFData ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

Methods

rnf :: ConnectivityInfo -> () #

Eq ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

Hashable ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

type Rep ConnectivityInfo Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.ConnectivityInfo

type Rep ConnectivityInfo = D1 ('MetaData "ConnectivityInfo" "Amazonka.GreengrassV2.Types.ConnectivityInfo" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "ConnectivityInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "portNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newConnectivityInfo :: ConnectivityInfo Source #

Create a value of ConnectivityInfo 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:hostAddress:ConnectivityInfo', connectivityInfo_hostAddress - The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.

$sel:id:ConnectivityInfo', connectivityInfo_id - An ID for the connectivity information.

$sel:metadata:ConnectivityInfo', connectivityInfo_metadata - Additional metadata to provide to client devices that connect to this core device.

$sel:portNumber:ConnectivityInfo', connectivityInfo_portNumber - The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.

connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text) Source #

The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.

connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text) Source #

An ID for the connectivity information.

connectivityInfo_metadata :: Lens' ConnectivityInfo (Maybe Text) Source #

Additional metadata to provide to client devices that connect to this core device.

connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Natural) Source #

The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.