Amazonka.QLDB.Types.JournalKinesisStreamDescription

Documentation

data JournalKinesisStreamDescription

Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

See: newJournalKinesisStreamDescription smart constructor.

Constructors

JournalKinesisStreamDescription'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the QLDB journal stream.

• creationTime :: Maybe POSIX

  The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

• errorCause :: Maybe ErrorCause

  The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

• exclusiveEndTime :: Maybe POSIX

  The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

• inclusiveStartTime :: Maybe POSIX

  The inclusive start date and time from which to start streaming journal data.

• ledgerName :: Text

  The name of the ledger.

• roleArn :: Text

  The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

• streamId :: Text

  The UUID (represented in Base62-encoded text) of the QLDB journal stream.

• status :: StreamStatus

  The current state of the QLDB journal stream.

• kinesisConfiguration :: KinesisConfiguration

  The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

• streamName :: Text

  The user-defined name of the QLDB journal stream.

Instances

FromJSON JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

parseJSON :: Value -> Parser JournalKinesisStreamDescription

parseJSONList :: Value -> Parser [JournalKinesisStreamDescription]

Generic JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Associated Types

type Rep JournalKinesisStreamDescription :: Type -> Type

Methods

from :: JournalKinesisStreamDescription -> Rep JournalKinesisStreamDescription x

to :: Rep JournalKinesisStreamDescription x -> JournalKinesisStreamDescription

Read JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

readsPrec :: Int -> ReadS JournalKinesisStreamDescription

readList :: ReadS [JournalKinesisStreamDescription]

readPrec :: ReadPrec JournalKinesisStreamDescription

readListPrec :: ReadPrec [JournalKinesisStreamDescription]

Show JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

showsPrec :: Int -> JournalKinesisStreamDescription -> ShowS

show :: JournalKinesisStreamDescription -> String

showList :: [JournalKinesisStreamDescription] -> ShowS

NFData JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

rnf :: JournalKinesisStreamDescription -> ()

Eq JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

(==) :: JournalKinesisStreamDescription -> JournalKinesisStreamDescription -> Bool

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

Hashable JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

Methods

hashWithSalt :: Int -> JournalKinesisStreamDescription -> Int

hash :: JournalKinesisStreamDescription -> Int

type Rep JournalKinesisStreamDescription

Defined in Amazonka.QLDB.Types.JournalKinesisStreamDescription

type Rep JournalKinesisStreamDescription = D1 ('MetaData "JournalKinesisStreamDescription" "Amazonka.QLDB.Types.JournalKinesisStreamDescription" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "JournalKinesisStreamDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "errorCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCause)) :*: (S1 ('MetaSel ('Just "exclusiveEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "inclusiveStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamStatus) :*: (S1 ('MetaSel ('Just "kinesisConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KinesisConfiguration) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJournalKinesisStreamDescription

Arguments

:: Text

$sel:ledgerName:JournalKinesisStreamDescription'

-> Text

$sel:roleArn:JournalKinesisStreamDescription'

-> Text

$sel:streamId:JournalKinesisStreamDescription'

-> StreamStatus

$sel:status:JournalKinesisStreamDescription'

-> KinesisConfiguration

$sel:kinesisConfiguration:JournalKinesisStreamDescription'

-> Text

$sel:streamName:JournalKinesisStreamDescription'

-> JournalKinesisStreamDescription

Create a value of JournalKinesisStreamDescription 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:JournalKinesisStreamDescription', journalKinesisStreamDescription_arn - The Amazon Resource Name (ARN) of the QLDB journal stream.

$sel:creationTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_creationTime - The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

$sel:errorCause:JournalKinesisStreamDescription', journalKinesisStreamDescription_errorCause - The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

$sel:exclusiveEndTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

$sel:inclusiveStartTime:JournalKinesisStreamDescription', journalKinesisStreamDescription_inclusiveStartTime - The inclusive start date and time from which to start streaming journal data.

$sel:ledgerName:JournalKinesisStreamDescription', journalKinesisStreamDescription_ledgerName - The name of the ledger.

$sel:roleArn:JournalKinesisStreamDescription', journalKinesisStreamDescription_roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

$sel:streamId:JournalKinesisStreamDescription', journalKinesisStreamDescription_streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream.

$sel:status:JournalKinesisStreamDescription', journalKinesisStreamDescription_status - The current state of the QLDB journal stream.

$sel:kinesisConfiguration:JournalKinesisStreamDescription', journalKinesisStreamDescription_kinesisConfiguration - The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

$sel:streamName:JournalKinesisStreamDescription', journalKinesisStreamDescription_streamName - The user-defined name of the QLDB journal stream.

journalKinesisStreamDescription_arn :: Lens' JournalKinesisStreamDescription (Maybe Text)

The Amazon Resource Name (ARN) of the QLDB journal stream.

journalKinesisStreamDescription_creationTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime)

The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

journalKinesisStreamDescription_errorCause :: Lens' JournalKinesisStreamDescription (Maybe ErrorCause)

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

journalKinesisStreamDescription_exclusiveEndTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime)

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

journalKinesisStreamDescription_inclusiveStartTime :: Lens' JournalKinesisStreamDescription (Maybe UTCTime)

The inclusive start date and time from which to start streaming journal data.

journalKinesisStreamDescription_ledgerName :: Lens' JournalKinesisStreamDescription Text

The name of the ledger.

journalKinesisStreamDescription_roleArn :: Lens' JournalKinesisStreamDescription Text

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

journalKinesisStreamDescription_streamId :: Lens' JournalKinesisStreamDescription Text

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

journalKinesisStreamDescription_status :: Lens' JournalKinesisStreamDescription StreamStatus

The current state of the QLDB journal stream.

journalKinesisStreamDescription_kinesisConfiguration :: Lens' JournalKinesisStreamDescription KinesisConfiguration

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

journalKinesisStreamDescription_streamName :: Lens' JournalKinesisStreamDescription Text

The user-defined name of the QLDB journal stream.