Amazonka.IVS.Types.StreamKey

Documentation

data StreamKey

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

FromJSON StreamKey

Defined in Amazonka.IVS.Types.StreamKey

Methods

parseJSON :: Value -> Parser StreamKey

parseJSONList :: Value -> Parser [StreamKey]

Generic StreamKey

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

Defined in Amazonka.IVS.Types.StreamKey

Methods

showsPrec :: Int -> StreamKey -> ShowS

show :: StreamKey -> String

showList :: [StreamKey] -> ShowS

NFData StreamKey

Defined in Amazonka.IVS.Types.StreamKey

Methods

rnf :: StreamKey -> ()

Eq StreamKey

Defined in Amazonka.IVS.Types.StreamKey

Methods

(==) :: StreamKey -> StreamKey -> Bool

(/=) :: StreamKey -> StreamKey -> Bool

Hashable StreamKey

Defined in Amazonka.IVS.Types.StreamKey

Methods

hashWithSalt :: Int -> StreamKey -> Int

hash :: StreamKey -> Int

type Rep StreamKey

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

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)

Stream-key ARN.

streamKey_channelArn :: Lens' StreamKey (Maybe Text)

Channel ARN for the stream.

streamKey_tags :: Lens' StreamKey (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.

streamKey_value :: Lens' StreamKey (Maybe Text)

Stream-key value.