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.IVS.Types.StreamKey

Description

Synopsis

data StreamKey = StreamKey' {
- arn :: Maybe Text
- channelArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- value :: Maybe (Sensitive Text)
}
newStreamKey :: StreamKey
streamKey_arn :: Lens' StreamKey (Maybe Text)
streamKey_channelArn :: Lens' StreamKey (Maybe Text)
streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text))
streamKey_value :: Lens' StreamKey (Maybe Text)

Documentation

data StreamKey Source #

Object specifying a stream key.

See: newStreamKey smart constructor.

Constructors

StreamKey'

Fields

arn :: Maybe Text
Stream-key ARN.
channelArn :: Maybe Text
Channel ARN for the stream.
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
value :: Maybe (Sensitive Text)
Stream-key value.

Instances

Instances details

FromJSON StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods parseJSON :: Value -> Parser StreamKey # parseJSONList :: Value -> Parser [StreamKey] #
Generic StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Associated Types type Rep StreamKey :: Type -> Type # Methods from :: StreamKey -> Rep StreamKey x # to :: Rep StreamKey x -> StreamKey #
Show StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods showsPrec :: Int -> StreamKey -> ShowS # show :: StreamKey -> String # showList :: [StreamKey] -> ShowS #
NFData StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods rnf :: StreamKey -> () #
Eq StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods (==) :: StreamKey -> StreamKey -> Bool # (/=) :: StreamKey -> StreamKey -> Bool #
Hashable StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods hashWithSalt :: Int -> StreamKey -> Int # hash :: StreamKey -> Int #
type Rep StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey type Rep StreamKey = D1 ('MetaData "StreamKey" "Amazonka.IVS.Types.StreamKey" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StreamKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newStreamKey :: StreamKey Source #

Create a value of StreamKey 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:arn:StreamKey', streamKey_arn - Stream-key ARN.

$sel:channelArn:StreamKey', streamKey_channelArn - Channel ARN for the stream.

$sel:tags:StreamKey', streamKey_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$sel:value:StreamKey', streamKey_value - Stream-key value.

streamKey_arn :: Lens' StreamKey (Maybe Text) Source #

Stream-key ARN.

streamKey_channelArn :: Lens' StreamKey (Maybe Text) Source #

Channel ARN for the stream.

streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

streamKey_value :: Lens' StreamKey (Maybe Text) Source #

Stream-key value.