Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.qldb.Stream
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::QLDB::Stream.
Example Usage
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var myQLDBStream = new AwsNative.Qldb.Stream("myQLDBStream", new()
{
ExclusiveEndTime = "2020-05-29T22:59:59Z",
InclusiveStartTime = "2020-05-29T00:00:00Z",
KinesisConfiguration = new AwsNative.Qldb.Inputs.StreamKinesisConfigurationArgs
{
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 = new[]
{
new AwsNative.Inputs.TagArgs
{
Key = "Domain",
Value = "Test",
},
},
});
});
package main
import (
awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := qldb.NewStream(ctx, "myQLDBStream", &qldb.StreamArgs{
ExclusiveEndTime: pulumi.String("2020-05-29T22:59:59Z"),
InclusiveStartTime: pulumi.String("2020-05-29T00:00:00Z"),
KinesisConfiguration: &qldb.StreamKinesisConfigurationArgs{
AggregationEnabled: pulumi.Bool(true),
StreamArn: pulumi.String("arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb"),
},
LedgerName: pulumi.String("exampleLedger"),
RoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-kinesis-stream-role"),
StreamName: pulumi.String("exampleLedger-stream"),
Tags: aws.TagArray{
&aws.TagArgs{
Key: pulumi.String("Domain"),
Value: pulumi.String("Test"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
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",
}],
});
import pulumi
import pulumi_aws_native as aws_native
my_qldb_stream = aws_native.qldb.Stream("myQLDBStream",
exclusive_end_time="2020-05-29T22:59:59Z",
inclusive_start_time="2020-05-29T00:00:00Z",
kinesis_configuration={
"aggregation_enabled": True,
"stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
},
ledger_name="exampleLedger",
role_arn="arn:aws:iam::123456789012:role/my-kinesis-stream-role",
stream_name="exampleLedger-stream",
tags=[{
"key": "Domain",
"value": "Test",
}])
Coming soon!
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var myQLDBStream = new AwsNative.Qldb.Stream("myQLDBStream", new()
{
ExclusiveEndTime = "2020-05-29T22:59:59Z",
InclusiveStartTime = "2020-05-29T00:00:00Z",
KinesisConfiguration = new AwsNative.Qldb.Inputs.StreamKinesisConfigurationArgs
{
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 = new[]
{
new AwsNative.Inputs.TagArgs
{
Key = "Domain",
Value = "Test",
},
},
});
});
package main
import (
awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := qldb.NewStream(ctx, "myQLDBStream", &qldb.StreamArgs{
ExclusiveEndTime: pulumi.String("2020-05-29T22:59:59Z"),
InclusiveStartTime: pulumi.String("2020-05-29T00:00:00Z"),
KinesisConfiguration: &qldb.StreamKinesisConfigurationArgs{
AggregationEnabled: pulumi.Bool(true),
StreamArn: pulumi.String("arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb"),
},
LedgerName: pulumi.String("exampleLedger"),
RoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-kinesis-stream-role"),
StreamName: pulumi.String("exampleLedger-stream"),
Tags: aws.TagArray{
&aws.TagArgs{
Key: pulumi.String("Domain"),
Value: pulumi.String("Test"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
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",
}],
});
import pulumi
import pulumi_aws_native as aws_native
my_qldb_stream = aws_native.qldb.Stream("myQLDBStream",
exclusive_end_time="2020-05-29T22:59:59Z",
inclusive_start_time="2020-05-29T00:00:00Z",
kinesis_configuration={
"aggregation_enabled": True,
"stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
},
ledger_name="exampleLedger",
role_arn="arn:aws:iam::123456789012:role/my-kinesis-stream-role",
stream_name="exampleLedger-stream",
tags=[{
"key": "Domain",
"value": "Test",
}])
Coming soon!
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,
exclusive_end_time: Optional[str] = None,
stream_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.
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 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat is before the ledger'sCreationDateTime, QLDB effectively defaults it to the ledger'sCreationDateTime.- Kinesis
Configuration Pulumi.Aws Native. Qldb. Inputs. Stream Kinesis Configuration - The configuration settings of the Kinesis Data Streams destination for your stream request.
- Ledger
Name string - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Inclusive
Start stringTime The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat 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.
- Ledger
Name string - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
-
Tag
Args - An array of key-value pairs to apply to this resource.
- inclusive
Start StringTime The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat 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.
- ledger
Name String - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
- List<Tag>
- An array of key-value pairs to apply to this resource.
- inclusive
Start stringTime The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat 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.
- ledger
Name string - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
- Tag[]
- An array of key-value pairs to apply to this resource.
- inclusive_
start_ strtime The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat 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.
- ledger_
name str - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- inclusive
Start StringTime The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.The
InclusiveStartTimecannot be in the future and must be beforeExclusiveEndTime.If you provide an
InclusiveStartTimethat 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.
- ledger
Name String - The name of the 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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRoleaction on the IAM role resource. This is required for all journal stream requests.- 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.
The
ExclusiveEndTimemust be inISO 8601date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z.- 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 Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - Aws
Id string - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - Id string
- The provider-assigned unique ID for this managed resource.
- Arn string
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - Aws
Id string - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - Id string
- The provider-assigned unique ID for this managed resource.
- arn String
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - aws
Id String - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - id String
- The provider-assigned unique ID for this managed resource.
- arn string
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - aws
Id string - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - id string
- The provider-assigned unique ID for this managed resource.
- arn str
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - aws_
id str - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - id str
- The provider-assigned unique ID for this managed resource.
- arn String
- The Amazon Resource Name (ARN) of the QLDB journal stream. For example:
arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy. - aws
Id String - The unique ID that QLDB assigns to each QLDB journal stream. For example:
IiPT4brpZCqCq3f4MTHbYy. - id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
StreamKinesisConfiguration, StreamKinesisConfigurationArgs
- 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- stream_
arn str - 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:
TrueRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
- stream
Arn String - The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.