import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource schema for AWS::QLDB::Stream. * * ## Example Usage * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const myQLDBStream = new aws_native.qldb.Stream("myQLDBStream", { * exclusiveEndTime: "2020-05-29T22:59:59Z", * inclusiveStartTime: "2020-05-29T00:00:00Z", * kinesisConfiguration: { * aggregationEnabled: true, * streamArn: "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb", * }, * ledgerName: "exampleLedger", * roleArn: "arn:aws:iam::123456789012:role/my-kinesis-stream-role", * streamName: "exampleLedger-stream", * tags: [{ * key: "Domain", * value: "Test", * }], * }); * * ``` * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const myQLDBStream = new aws_native.qldb.Stream("myQLDBStream", { * exclusiveEndTime: "2020-05-29T22:59:59Z", * inclusiveStartTime: "2020-05-29T00:00:00Z", * kinesisConfiguration: { * aggregationEnabled: true, * streamArn: "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb", * }, * ledgerName: "exampleLedger", * roleArn: "arn:aws:iam::123456789012:role/my-kinesis-stream-role", * streamName: "exampleLedger-stream", * tags: [{ * key: "Domain", * value: "Test", * }], * }); * * ``` */ export declare class Stream extends pulumi.CustomResource { /** * Get an existing Stream resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Stream; /** * Returns true if the given object is an instance of Stream. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Stream; /** * The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` . */ readonly arn: pulumi.Output; /** * The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` . */ readonly awsId: pulumi.Output; /** * The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. * * The `ExclusiveEndTime` must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` . */ readonly exclusiveEndTime: pulumi.Output; /** * The inclusive start date and time from which to start streaming journal data. This parameter must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` . * * The `InclusiveStartTime` cannot be in the future and must be before `ExclusiveEndTime` . * * If you provide an `InclusiveStartTime` that is before the ledger's `CreationDateTime` , QLDB effectively defaults it to the ledger's `CreationDateTime` . */ readonly inclusiveStartTime: pulumi.Output; /** * The configuration settings of the Kinesis Data Streams destination for your stream request. */ readonly kinesisConfiguration: pulumi.Output; /** * The name of the ledger. */ readonly ledgerName: pulumi.Output; /** * 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. * * To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the `iam:PassRole` action on the IAM role resource. This is required for all journal stream requests. */ readonly roleArn: pulumi.Output; /** * The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. * * Your stream name must be unique among other *active* streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* . */ readonly streamName: pulumi.Output; /** * An array of key-value pairs to apply to this resource. */ readonly tags: pulumi.Output; /** * Create a Stream resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: StreamArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Stream resource. */ export interface StreamArgs { /** * The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. * * The `ExclusiveEndTime` must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` . */ exclusiveEndTime?: pulumi.Input; /** * The inclusive start date and time from which to start streaming journal data. This parameter must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` . * * The `InclusiveStartTime` cannot be in the future and must be before `ExclusiveEndTime` . * * If you provide an `InclusiveStartTime` that is before the ledger's `CreationDateTime` , QLDB effectively defaults it to the ledger's `CreationDateTime` . */ inclusiveStartTime: pulumi.Input; /** * The configuration settings of the Kinesis Data Streams destination for your stream request. */ kinesisConfiguration: pulumi.Input; /** * The name of the ledger. */ ledgerName: pulumi.Input; /** * 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. * * To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the `iam:PassRole` action on the IAM role resource. This is required for all journal stream requests. */ roleArn: pulumi.Input; /** * The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. * * Your stream name must be unique among other *active* streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* . */ streamName?: pulumi.Input; /** * An array of key-value pairs to apply to this resource. */ tags?: pulumi.Input[]>; }