qldb

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupStreamArgs added in v0.12.0 

type LookupStreamArgs struct {
	// The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .
	Id string `pulumi:"id"`
	// The name of the ledger.
	LedgerName string `pulumi:"ledgerName"`
}

type LookupStreamOutputArgs added in v0.12.0 

type LookupStreamOutputArgs struct {
	// The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .
	Id pulumi.StringInput `pulumi:"id"`
	// The name of the ledger.
	LedgerName pulumi.StringInput `pulumi:"ledgerName"`
}

func (LookupStreamOutputArgs) ElementType added in v0.12.0 

func (LookupStreamOutputArgs) ElementType() reflect.Type

type LookupStreamResult added in v0.12.0 

type LookupStreamResult struct {
	// The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` .
	Arn *string `pulumi:"arn"`
	// The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .
	Id *string `pulumi:"id"`
	// An array of key-value pairs to apply to this resource.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupStream added in v0.12.0 

func LookupStream(ctx *pulumi.Context, args *LookupStreamArgs, opts ...pulumi.InvokeOption) (*LookupStreamResult, error)

Resource schema for AWS::QLDB::Stream.

type LookupStreamResultOutput added in v0.12.0 

type LookupStreamResultOutput struct{ *pulumi.OutputState }

func LookupStreamOutput added in v0.12.0 

func LookupStreamOutput(ctx *pulumi.Context, args LookupStreamOutputArgs, opts ...pulumi.InvokeOption) LookupStreamResultOutput

func (LookupStreamResultOutput) Arn added in v0.12.0 

func (o LookupStreamResultOutput) Arn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` .

func (LookupStreamResultOutput) ElementType added in v0.12.0 

func (LookupStreamResultOutput) ElementType() reflect.Type

func (LookupStreamResultOutput) Id added in v0.12.0 

func (o LookupStreamResultOutput) Id() pulumi.StringPtrOutput

The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .

func (LookupStreamResultOutput) Tags added in v0.12.0 

func (o LookupStreamResultOutput) Tags() aws.TagArrayOutput

An array of key-value pairs to apply to this resource.

func (LookupStreamResultOutput) ToLookupStreamResultOutput added in v0.12.0 

func (o LookupStreamResultOutput) ToLookupStreamResultOutput() LookupStreamResultOutput

func (LookupStreamResultOutput) ToLookupStreamResultOutputWithContext added in v0.12.0 

func (o LookupStreamResultOutput) ToLookupStreamResultOutputWithContext(ctx context.Context) LookupStreamResultOutput

type Stream 

type Stream struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` .
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// 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.StringPtrOutput `pulumi:"exclusiveEndTime"`
	// 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.StringOutput `pulumi:"inclusiveStartTime"`
	// The configuration settings of the Kinesis Data Streams destination for your stream request.
	KinesisConfiguration StreamKinesisConfigurationOutput `pulumi:"kinesisConfiguration"`
	// The name of the ledger.
	LedgerName pulumi.StringOutput `pulumi:"ledgerName"`
	// 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.StringOutput `pulumi:"roleArn"`
	// 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.StringOutput `pulumi:"streamName"`
	// An array of key-value pairs to apply to this resource.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource schema for AWS::QLDB::Stream.

## Example Usage ### Example

```go 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
	})
}

``` ### Example

```go 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
	})
}

```

func GetStream 

func GetStream(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *StreamState, opts ...pulumi.ResourceOption) (*Stream, error)

GetStream gets an existing Stream resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewStream 

func NewStream(ctx *pulumi.Context,
	name string, args *StreamArgs, opts ...pulumi.ResourceOption) (*Stream, error)

NewStream registers a new resource with the given unique name, arguments, and options.

func (*Stream) ElementType 

func (*Stream) ElementType() reflect.Type

func (*Stream) ToStreamOutput 

func (i *Stream) ToStreamOutput() StreamOutput

func (*Stream) ToStreamOutputWithContext 

func (i *Stream) ToStreamOutputWithContext(ctx context.Context) StreamOutput

type StreamArgs 

type StreamArgs struct {
	// 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.StringPtrInput
	// 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.StringInput
	// The configuration settings of the Kinesis Data Streams destination for your stream request.
	KinesisConfiguration StreamKinesisConfigurationInput
	// The name of the ledger.
	LedgerName pulumi.StringInput
	// 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.StringInput
	// 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.StringPtrInput
	// An array of key-value pairs to apply to this resource.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Stream resource.

func (StreamArgs) ElementType 

func (StreamArgs) ElementType() reflect.Type

type StreamInput 

type StreamInput interface {
	pulumi.Input

	ToStreamOutput() StreamOutput
	ToStreamOutputWithContext(ctx context.Context) StreamOutput
}

type StreamKinesisConfiguration 

type StreamKinesisConfiguration struct {
	// 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`
	//
	// > Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .
	AggregationEnabled *bool `pulumi:"aggregationEnabled"`
	// The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
	StreamArn *string `pulumi:"streamArn"`
}

type StreamKinesisConfigurationArgs 

type StreamKinesisConfigurationArgs struct {
	// 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`
	//
	// > Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .
	AggregationEnabled pulumi.BoolPtrInput `pulumi:"aggregationEnabled"`
	// The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
	StreamArn pulumi.StringPtrInput `pulumi:"streamArn"`
}

func (StreamKinesisConfigurationArgs) ElementType 

func (StreamKinesisConfigurationArgs) ElementType() reflect.Type

func (StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutput 

func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutput() StreamKinesisConfigurationOutput

func (StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutputWithContext 

func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutputWithContext(ctx context.Context) StreamKinesisConfigurationOutput

type StreamKinesisConfigurationInput 

type StreamKinesisConfigurationInput interface {
	pulumi.Input

	ToStreamKinesisConfigurationOutput() StreamKinesisConfigurationOutput
	ToStreamKinesisConfigurationOutputWithContext(context.Context) StreamKinesisConfigurationOutput
}

StreamKinesisConfigurationInput is an input type that accepts StreamKinesisConfigurationArgs and StreamKinesisConfigurationOutput values. You can construct a concrete instance of `StreamKinesisConfigurationInput` via: 

StreamKinesisConfigurationArgs{...}

type StreamKinesisConfigurationOutput 

type StreamKinesisConfigurationOutput struct{ *pulumi.OutputState }

func (StreamKinesisConfigurationOutput) AggregationEnabled 

func (o StreamKinesisConfigurationOutput) AggregationEnabled() pulumi.BoolPtrOutput

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`

> Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .

func (StreamKinesisConfigurationOutput) ElementType 

func (StreamKinesisConfigurationOutput) ElementType() reflect.Type

func (StreamKinesisConfigurationOutput) StreamArn 

func (o StreamKinesisConfigurationOutput) StreamArn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

func (StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutput 

func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutput() StreamKinesisConfigurationOutput

func (StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutputWithContext 

func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutputWithContext(ctx context.Context) StreamKinesisConfigurationOutput

type StreamOutput 

type StreamOutput struct{ *pulumi.OutputState }

func (StreamOutput) Arn added in v0.17.0 

func (o StreamOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` .

func (StreamOutput) AwsId added in v0.99.0 

func (o StreamOutput) AwsId() pulumi.StringOutput

The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .

func (StreamOutput) ElementType 

func (StreamOutput) ElementType() reflect.Type

func (StreamOutput) ExclusiveEndTime added in v0.17.0 

func (o StreamOutput) ExclusiveEndTime() pulumi.StringPtrOutput

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` .

func (StreamOutput) InclusiveStartTime added in v0.17.0 

func (o StreamOutput) InclusiveStartTime() pulumi.StringOutput

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` .

func (StreamOutput) KinesisConfiguration added in v0.17.0 

func (o StreamOutput) KinesisConfiguration() StreamKinesisConfigurationOutput

The configuration settings of the Kinesis Data Streams destination for your stream request.

func (StreamOutput) LedgerName added in v0.17.0 

func (o StreamOutput) LedgerName() pulumi.StringOutput

The name of the ledger.

func (StreamOutput) RoleArn added in v0.17.0 

func (o StreamOutput) RoleArn() pulumi.StringOutput

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.

func (StreamOutput) StreamName added in v0.17.0 

func (o StreamOutput) StreamName() pulumi.StringOutput

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* .

func (StreamOutput) Tags added in v0.17.0 

func (o StreamOutput) Tags() aws.TagArrayOutput

An array of key-value pairs to apply to this resource.

func (StreamOutput) ToStreamOutput 

func (o StreamOutput) ToStreamOutput() StreamOutput

func (StreamOutput) ToStreamOutputWithContext 

func (o StreamOutput) ToStreamOutputWithContext(ctx context.Context) StreamOutput

type StreamState 

type StreamState struct {
}

func (StreamState) ElementType 

func (StreamState) ElementType() reflect.Type

type StreamTag 

type StreamTag struct {
	// The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

A key-value pair to associate with a resource.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.