1. Packages
  2. AWS Native
  3. API Docs
  4. qldb
  5. Stream

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.qldb.Stream

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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 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=aws_native.qldb.StreamKinesisConfigurationArgs(
            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=[aws_native.TagArgs(
            key="Domain",
            value="Test",
        )])
    
    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",
        }],
    });
    

    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 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=aws_native.qldb.StreamKinesisConfigurationArgs(
            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=[aws_native.TagArgs(
            key="Domain",
            value="Test",
        )])
    
    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",
        }],
    });
    

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const examplestreamResourceResourceFromQldb = new aws_native.qldb.Stream("examplestreamResourceResourceFromQldb", {
        inclusiveStartTime: "string",
        kinesisConfiguration: {
            aggregationEnabled: false,
            streamArn: "string",
        },
        ledgerName: "string",
        roleArn: "string",
        exclusiveEndTime: "string",
        streamName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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

    The Stream resource accepts the following input properties:

    InclusiveStartTime string
    KinesisConfiguration StreamKinesisConfigurationArgs
    LedgerName string
    RoleArn string
    ExclusiveEndTime string
    StreamName string
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    inclusiveStartTime String
    kinesisConfiguration StreamKinesisConfiguration
    ledgerName String
    roleArn String
    exclusiveEndTime String
    streamName String
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    inclusiveStartTime string
    kinesisConfiguration StreamKinesisConfiguration
    ledgerName string
    roleArn string
    exclusiveEndTime string
    streamName string
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    inclusiveStartTime String
    kinesisConfiguration Property Map
    ledgerName String
    roleArn String
    exclusiveEndTime String
    streamName String
    tags 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
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StreamKinesisConfiguration, StreamKinesisConfigurationArgs

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi