Docs Home
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
aws.qldb.Stream
Explore with Pulumi AI
Provides an AWS Quantum Ledger Database (QLDB) Stream resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.qldb.Stream("example", {
ledgerName: "existing-ledger-name",
streamName: "sample-ledger-stream",
roleArn: "sample-role-arn",
inclusiveStartTime: "2021-01-01T00:00:00Z",
kinesisConfiguration: {
aggregationEnabled: false,
streamArn: "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
},
tags: {
example: "tag",
},
});
import pulumi
import pulumi_aws as aws
example = aws.qldb.Stream("example",
ledger_name="existing-ledger-name",
stream_name="sample-ledger-stream",
role_arn="sample-role-arn",
inclusive_start_time="2021-01-01T00:00:00Z",
kinesis_configuration={
"aggregation_enabled": False,
"stream_arn": "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
},
tags={
"example": "tag",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := qldb.NewStream(ctx, "example", &qldb.StreamArgs{
LedgerName: pulumi.String("existing-ledger-name"),
StreamName: pulumi.String("sample-ledger-stream"),
RoleArn: pulumi.String("sample-role-arn"),
InclusiveStartTime: pulumi.String("2021-01-01T00:00:00Z"),
KinesisConfiguration: &qldb.StreamKinesisConfigurationArgs{
AggregationEnabled: pulumi.Bool(false),
StreamArn: pulumi.String("arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream"),
},
Tags: pulumi.StringMap{
"example": pulumi.String("tag"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Qldb.Stream("example", new()
{
LedgerName = "existing-ledger-name",
StreamName = "sample-ledger-stream",
RoleArn = "sample-role-arn",
InclusiveStartTime = "2021-01-01T00:00:00Z",
KinesisConfiguration = new Aws.Qldb.Inputs.StreamKinesisConfigurationArgs
{
AggregationEnabled = false,
StreamArn = "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
},
Tags =
{
{ "example", "tag" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.qldb.Stream;
import com.pulumi.aws.qldb.StreamArgs;
import com.pulumi.aws.qldb.inputs.StreamKinesisConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Stream("example", StreamArgs.builder()
.ledgerName("existing-ledger-name")
.streamName("sample-ledger-stream")
.roleArn("sample-role-arn")
.inclusiveStartTime("2021-01-01T00:00:00Z")
.kinesisConfiguration(StreamKinesisConfigurationArgs.builder()
.aggregationEnabled(false)
.streamArn("arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream")
.build())
.tags(Map.of("example", "tag"))
.build());
}
}
resources:
example:
type: aws:qldb:Stream
properties:
ledgerName: existing-ledger-name
streamName: sample-ledger-stream
roleArn: sample-role-arn
inclusiveStartTime: 2021-01-01T00:00:00Z
kinesisConfiguration:
aggregationEnabled: false
streamArn: arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream
tags:
example: tag
Create Stream Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Stream(name: string, args: StreamArgs, opts?: CustomResourceOptions);@overload
def Stream(resource_name: str,
args: StreamArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Stream(resource_name: str,
opts: Optional[ResourceOptions] = None,
inclusive_start_time: Optional[str] = None,
kinesis_configuration: Optional[StreamKinesisConfigurationArgs] = None,
ledger_name: Optional[str] = None,
role_arn: Optional[str] = None,
stream_name: Optional[str] = None,
exclusive_end_time: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewStream(ctx *Context, name string, args StreamArgs, opts ...ResourceOption) (*Stream, error)public Stream(string name, StreamArgs args, CustomResourceOptions? opts = null)
public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)
type: aws:qldb:Stream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var awsStreamResource = new Aws.Qldb.Stream("awsStreamResource", new()
{
InclusiveStartTime = "string",
KinesisConfiguration = new Aws.Qldb.Inputs.StreamKinesisConfigurationArgs
{
StreamArn = "string",
AggregationEnabled = false,
},
LedgerName = "string",
RoleArn = "string",
StreamName = "string",
ExclusiveEndTime = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := qldb.NewStream(ctx, "awsStreamResource", &qldb.StreamArgs{
InclusiveStartTime: pulumi.String("string"),
KinesisConfiguration: &qldb.StreamKinesisConfigurationArgs{
StreamArn: pulumi.String("string"),
AggregationEnabled: pulumi.Bool(false),
},
LedgerName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
StreamName: pulumi.String("string"),
ExclusiveEndTime: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var awsStreamResource = new Stream("awsStreamResource", StreamArgs.builder()
.inclusiveStartTime("string")
.kinesisConfiguration(StreamKinesisConfigurationArgs.builder()
.streamArn("string")
.aggregationEnabled(false)
.build())
.ledgerName("string")
.roleArn("string")
.streamName("string")
.exclusiveEndTime("string")
.tags(Map.of("string", "string"))
.build());
aws_stream_resource = aws.qldb.Stream("awsStreamResource",
inclusive_start_time="string",
kinesis_configuration={
"stream_arn": "string",
"aggregation_enabled": False,
},
ledger_name="string",
role_arn="string",
stream_name="string",
exclusive_end_time="string",
tags={
"string": "string",
})
const awsStreamResource = new aws.qldb.Stream("awsStreamResource", {
inclusiveStartTime: "string",
kinesisConfiguration: {
streamArn: "string",
aggregationEnabled: false,
},
ledgerName: "string",
roleArn: "string",
streamName: "string",
exclusiveEndTime: "string",
tags: {
string: "string",
},
});
type: aws:qldb:Stream
properties:
exclusiveEndTime: string
inclusiveStartTime: string
kinesisConfiguration:
aggregationEnabled: false
streamArn: string
ledgerName: string
roleArn: string
streamName: string
tags:
string: string
Stream Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Stream resource accepts the following input properties:
- Inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - Kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- Ledger
Name string - The name of the QLDB ledger.
- Role
Arn string - 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.
- Stream
Name string - 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 the Amazon QLDB Developer Guide.
- Exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - Kinesis
Configuration StreamKinesis Configuration Args - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- Ledger
Name string - The name of the QLDB ledger.
- Role
Arn string - 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.
- Stream
Name string - 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 the Amazon QLDB Developer Guide.
- Exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- inclusive
Start StringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name String - The name of the QLDB ledger.
- role
Arn String - 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.
- stream
Name String - 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 the Amazon QLDB Developer Guide.
- exclusive
End StringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name string - The name of the QLDB ledger.
- role
Arn string - 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.
- stream
Name string - 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 the Amazon QLDB Developer Guide.
- exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- inclusive_
start_ strtime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis_
configuration StreamKinesis Configuration Args - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger_
name str - The name of the QLDB ledger.
- role_
arn str - 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.
- stream_
name str - 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 the Amazon QLDB Developer Guide.
- exclusive_
end_ strtime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- inclusive
Start StringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration Property Map - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name String - The name of the QLDB ledger.
- role
Arn String - 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.
- stream
Name String - 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 the Amazon QLDB Developer Guide.
- exclusive
End StringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:
Look up Existing Stream Resource
Get an existing Stream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: StreamState, opts?: CustomResourceOptions): Stream@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
exclusive_end_time: Optional[str] = None,
inclusive_start_time: Optional[str] = None,
kinesis_configuration: Optional[StreamKinesisConfigurationArgs] = None,
ledger_name: Optional[str] = None,
role_arn: Optional[str] = None,
stream_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> Streamfunc GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)resources: _: type: aws:qldb:Stream get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The ARN of the QLDB Stream.
- Exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - Kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- Ledger
Name string - The name of the QLDB ledger.
- Role
Arn string - 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.
- Stream
Name string - 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 the Amazon QLDB Developer Guide.
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- The ARN of the QLDB Stream.
- Exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - Inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - Kinesis
Configuration StreamKinesis Configuration Args - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- Ledger
Name string - The name of the QLDB ledger.
- Role
Arn string - 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.
- Stream
Name string - 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 the Amazon QLDB Developer Guide.
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- The ARN of the QLDB Stream.
- exclusive
End StringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - inclusive
Start StringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name String - The name of the QLDB ledger.
- role
Arn String - 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.
- stream
Name String - 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 the Amazon QLDB Developer Guide.
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- The ARN of the QLDB Stream.
- exclusive
End stringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - inclusive
Start stringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration StreamKinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name string - The name of the QLDB ledger.
- role
Arn string - 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.
- stream
Name string - 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 the Amazon QLDB Developer Guide.
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn str
- The ARN of the QLDB Stream.
- exclusive_
end_ strtime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - inclusive_
start_ strtime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis_
configuration StreamKinesis Configuration Args - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger_
name str - The name of the QLDB ledger.
- role_
arn str - 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.
- stream_
name str - 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 the Amazon QLDB Developer Guide.
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- The ARN of the QLDB Stream.
- exclusive
End StringTime - 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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
"2019-06-13T21:36:34Z". - inclusive
Start StringTime - 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". This cannot be in the future and must be beforeexclusive_end_time. If you provide a value that is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime. - kinesis
Configuration Property Map - The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
- ledger
Name String - The name of the QLDB ledger.
- role
Arn String - 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.
- stream
Name String - 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 the Amazon QLDB Developer Guide.
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
Supporting Types
StreamKinesisConfiguration, StreamKinesisConfigurationArgs
- Stream
Arn string - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- Aggregation
Enabled bool - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
- Stream
Arn string - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- Aggregation
Enabled bool - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
- stream
Arn String - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- aggregation
Enabled Boolean - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
- stream
Arn string - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- aggregation
Enabled boolean - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
- stream_
arn str - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- aggregation_
enabled bool - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
- stream
Arn String - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
- aggregation
Enabled Boolean - Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default:
true.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.