Stream class

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", {
    kinesisConfiguration: {
        aggregationEnabled: false,
        streamArn: "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
    },
    ledgerName: "existing-ledger-name",
    streamName: "sample-ledger-stream",
    roleArn: "sample-role-arn",
    inclusiveStartTime: "2021-01-01T00:00:00Z",
    tags: {
        example: "tag",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.qldb.Stream("example",
    kinesis_configuration={
        "aggregation_enabled": False,
        "stream_arn": "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
    },
    ledger_name="existing-ledger-name",
    stream_name="sample-ledger-stream",
    role_arn="sample-role-arn",
    inclusive_start_time="2021-01-01T00:00:00Z",
    tags={
        "example": "tag",
    })
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()
    {
        KinesisConfiguration = new Aws.Qldb.Inputs.StreamKinesisConfigurationArgs
        {
            AggregationEnabled = false,
            StreamArn = "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
        },
        LedgerName = "existing-ledger-name",
        StreamName = "sample-ledger-stream",
        RoleArn = "sample-role-arn",
        InclusiveStartTime = "2021-01-01T00:00:00Z",
        Tags =
        {
            { "example", "tag" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			KinesisConfiguration: &qldb.StreamKinesisConfigurationArgs{
				AggregationEnabled: pulumi.Bool(false),
				StreamArn:          pulumi.String("arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream"),
			},
			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"),
			Tags: pulumi.StringMap{
				"example": pulumi.String("tag"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_qldb_stream" "example" {
  kinesis_configuration = {
    aggregation_enabled = false
    stream_arn          = "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream"
  }
  ledger_name          = "existing-ledger-name"
  stream_name          = "sample-ledger-stream"
  role_arn             = "sample-role-arn"
  inclusive_start_time = "2021-01-01T00:00:00Z"
  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.ArrayList;
import java.util.Arrays;
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()
            .kinesisConfiguration(StreamKinesisConfigurationArgs.builder()
                .aggregationEnabled(false)
                .streamArn("arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream")
                .build())
            .ledgerName("existing-ledger-name")
            .streamName("sample-ledger-stream")
            .roleArn("sample-role-arn")
            .inclusiveStartTime("2021-01-01T00:00:00Z")
            .tags(Map.of("example", "tag"))
            .build());

    }
}
resources:
  example:
    type: aws:qldb:Stream
    properties:
      kinesisConfiguration:
        aggregationEnabled: false
        streamArn: arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream
      ledgerName: existing-ledger-name
      streamName: sample-ledger-stream
      roleArn: sample-role-arn
      inclusiveStartTime: 2021-01-01T00:00:00Z
      tags:
        example: tag

Constructors

Stream(String name, {StreamArgs? args, CustomResourceOptions? options})
Creates a new Stream. name The Pulumi resource name. args Arguments used to configure this Stream. The set of arguments for Stream. options Resource options controlling this resource's behavior.
Stream.reference(String urn)
Creates a typed reference to an existing Stream resource.

Properties

arn ↔ Output<String>
The ARN of the QLDB Stream.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
exclusiveEndTime ↔ Output<String?>
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".
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
inclusiveStartTime ↔ Output<String>
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 before exclusiveEndTime. If you provide a value that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kinesisConfiguration ↔ Output<StreamKinesisConfiguration>
The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
latefinal
ledgerName ↔ Output<String>
The name of the QLDB ledger.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String>
ARN of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamName ↔ Output<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.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {StreamState? state, CustomResourceOptions? options}) → Stream
Gets an existing Stream resource's state with the given name and id.