Documentation ¶
Index ¶
- type Ledger
- type LedgerArgs
- type LedgerArray
- type LedgerArrayInput
- type LedgerArrayOutput
- type LedgerInput
- type LedgerMap
- type LedgerMapInput
- type LedgerMapOutput
- type LedgerOutput
- func (o LedgerOutput) Arn() pulumi.StringOutput
- func (o LedgerOutput) DeletionProtection() pulumi.BoolPtrOutput
- func (LedgerOutput) ElementType() reflect.Type
- func (o LedgerOutput) KmsKey() pulumi.StringOutput
- func (o LedgerOutput) Name() pulumi.StringOutput
- func (o LedgerOutput) PermissionsMode() pulumi.StringOutput
- func (o LedgerOutput) Tags() pulumi.StringMapOutput
- func (o LedgerOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o LedgerOutput) ToLedgerOutput() LedgerOutput
- func (o LedgerOutput) ToLedgerOutputWithContext(ctx context.Context) LedgerOutput
- type LedgerState
- type LookupLedgerArgs
- type LookupLedgerOutputArgs
- type LookupLedgerResult
- type LookupLedgerResultOutput
- func (o LookupLedgerResultOutput) Arn() pulumi.StringOutput
- func (o LookupLedgerResultOutput) DeletionProtection() pulumi.BoolOutput
- func (LookupLedgerResultOutput) ElementType() reflect.Type
- func (o LookupLedgerResultOutput) Id() pulumi.StringOutput
- func (o LookupLedgerResultOutput) KmsKey() pulumi.StringOutput
- func (o LookupLedgerResultOutput) Name() pulumi.StringOutput
- func (o LookupLedgerResultOutput) PermissionsMode() pulumi.StringOutput
- func (o LookupLedgerResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupLedgerResultOutput) ToLookupLedgerResultOutput() LookupLedgerResultOutput
- func (o LookupLedgerResultOutput) ToLookupLedgerResultOutputWithContext(ctx context.Context) LookupLedgerResultOutput
- type Stream
- type StreamArgs
- type StreamArray
- type StreamArrayInput
- type StreamArrayOutput
- type StreamInput
- type StreamKinesisConfiguration
- type StreamKinesisConfigurationArgs
- func (StreamKinesisConfigurationArgs) ElementType() reflect.Type
- func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutput() StreamKinesisConfigurationOutput
- func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationOutputWithContext(ctx context.Context) StreamKinesisConfigurationOutput
- func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
- func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
- type StreamKinesisConfigurationInput
- type StreamKinesisConfigurationOutput
- func (o StreamKinesisConfigurationOutput) AggregationEnabled() pulumi.BoolPtrOutput
- func (StreamKinesisConfigurationOutput) ElementType() reflect.Type
- func (o StreamKinesisConfigurationOutput) StreamArn() pulumi.StringOutput
- func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutput() StreamKinesisConfigurationOutput
- func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationOutputWithContext(ctx context.Context) StreamKinesisConfigurationOutput
- func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
- func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
- type StreamKinesisConfigurationPtrInput
- type StreamKinesisConfigurationPtrOutput
- func (o StreamKinesisConfigurationPtrOutput) AggregationEnabled() pulumi.BoolPtrOutput
- func (o StreamKinesisConfigurationPtrOutput) Elem() StreamKinesisConfigurationOutput
- func (StreamKinesisConfigurationPtrOutput) ElementType() reflect.Type
- func (o StreamKinesisConfigurationPtrOutput) StreamArn() pulumi.StringPtrOutput
- func (o StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
- func (o StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
- type StreamMap
- type StreamMapInput
- type StreamMapOutput
- type StreamOutput
- func (o StreamOutput) Arn() pulumi.StringOutput
- func (StreamOutput) ElementType() reflect.Type
- func (o StreamOutput) ExclusiveEndTime() pulumi.StringPtrOutput
- func (o StreamOutput) InclusiveStartTime() pulumi.StringOutput
- func (o StreamOutput) KinesisConfiguration() StreamKinesisConfigurationOutput
- func (o StreamOutput) LedgerName() pulumi.StringOutput
- func (o StreamOutput) RoleArn() pulumi.StringOutput
- func (o StreamOutput) StreamName() pulumi.StringOutput
- func (o StreamOutput) Tags() pulumi.StringMapOutput
- func (o StreamOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o StreamOutput) ToStreamOutput() StreamOutput
- func (o StreamOutput) ToStreamOutputWithContext(ctx context.Context) StreamOutput
- type StreamState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Ledger ¶
type Ledger struct { pulumi.CustomResourceState // The ARN of the QLDB Ledger Arn pulumi.StringOutput `pulumi:"arn"` // The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via the provider, this value must be configured to `false` and applied first before attempting deletion. DeletionProtection pulumi.BoolPtrOutput `pulumi:"deletionProtection"` // The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key. KmsKey pulumi.StringOutput `pulumi:"kmsKey"` // The friendly name for the QLDB Ledger instance. By default generated by the provider. Name pulumi.StringOutput `pulumi:"name"` // The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`. PermissionsMode pulumi.StringOutput `pulumi:"permissionsMode"` // 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. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides an AWS Quantum Ledger Database (QLDB) resource
> **NOTE:** Deletion protection is enabled by default. To successfully delete this resource via this provider, `deletionProtection = false` must be applied before attempting deletion.
## Example Usage
```go 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.NewLedger(ctx, "sample-ledger", &qldb.LedgerArgs{ Name: pulumi.String("sample-ledger"), PermissionsMode: pulumi.String("STANDARD"), }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import QLDB Ledgers using the `name`. For example:
```sh $ pulumi import aws:qldb/ledger:Ledger sample-ledger sample-ledger ```
func GetLedger ¶
func GetLedger(ctx *pulumi.Context, name string, id pulumi.IDInput, state *LedgerState, opts ...pulumi.ResourceOption) (*Ledger, error)
GetLedger gets an existing Ledger 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 NewLedger ¶
func NewLedger(ctx *pulumi.Context, name string, args *LedgerArgs, opts ...pulumi.ResourceOption) (*Ledger, error)
NewLedger registers a new resource with the given unique name, arguments, and options.
func (*Ledger) ElementType ¶
func (*Ledger) ToLedgerOutput ¶
func (i *Ledger) ToLedgerOutput() LedgerOutput
func (*Ledger) ToLedgerOutputWithContext ¶
func (i *Ledger) ToLedgerOutputWithContext(ctx context.Context) LedgerOutput
type LedgerArgs ¶
type LedgerArgs struct { // The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via the provider, this value must be configured to `false` and applied first before attempting deletion. DeletionProtection pulumi.BoolPtrInput // The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key. KmsKey pulumi.StringPtrInput // The friendly name for the QLDB Ledger instance. By default generated by the provider. Name pulumi.StringPtrInput // The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`. PermissionsMode pulumi.StringInput // 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. Tags pulumi.StringMapInput }
The set of arguments for constructing a Ledger resource.
func (LedgerArgs) ElementType ¶
func (LedgerArgs) ElementType() reflect.Type
type LedgerArray ¶
type LedgerArray []LedgerInput
func (LedgerArray) ElementType ¶
func (LedgerArray) ElementType() reflect.Type
func (LedgerArray) ToLedgerArrayOutput ¶
func (i LedgerArray) ToLedgerArrayOutput() LedgerArrayOutput
func (LedgerArray) ToLedgerArrayOutputWithContext ¶
func (i LedgerArray) ToLedgerArrayOutputWithContext(ctx context.Context) LedgerArrayOutput
type LedgerArrayInput ¶
type LedgerArrayInput interface { pulumi.Input ToLedgerArrayOutput() LedgerArrayOutput ToLedgerArrayOutputWithContext(context.Context) LedgerArrayOutput }
LedgerArrayInput is an input type that accepts LedgerArray and LedgerArrayOutput values. You can construct a concrete instance of `LedgerArrayInput` via:
LedgerArray{ LedgerArgs{...} }
type LedgerArrayOutput ¶
type LedgerArrayOutput struct{ *pulumi.OutputState }
func (LedgerArrayOutput) ElementType ¶
func (LedgerArrayOutput) ElementType() reflect.Type
func (LedgerArrayOutput) Index ¶
func (o LedgerArrayOutput) Index(i pulumi.IntInput) LedgerOutput
func (LedgerArrayOutput) ToLedgerArrayOutput ¶
func (o LedgerArrayOutput) ToLedgerArrayOutput() LedgerArrayOutput
func (LedgerArrayOutput) ToLedgerArrayOutputWithContext ¶
func (o LedgerArrayOutput) ToLedgerArrayOutputWithContext(ctx context.Context) LedgerArrayOutput
type LedgerInput ¶
type LedgerInput interface { pulumi.Input ToLedgerOutput() LedgerOutput ToLedgerOutputWithContext(ctx context.Context) LedgerOutput }
type LedgerMap ¶
type LedgerMap map[string]LedgerInput
func (LedgerMap) ElementType ¶
func (LedgerMap) ToLedgerMapOutput ¶
func (i LedgerMap) ToLedgerMapOutput() LedgerMapOutput
func (LedgerMap) ToLedgerMapOutputWithContext ¶
func (i LedgerMap) ToLedgerMapOutputWithContext(ctx context.Context) LedgerMapOutput
type LedgerMapInput ¶
type LedgerMapInput interface { pulumi.Input ToLedgerMapOutput() LedgerMapOutput ToLedgerMapOutputWithContext(context.Context) LedgerMapOutput }
LedgerMapInput is an input type that accepts LedgerMap and LedgerMapOutput values. You can construct a concrete instance of `LedgerMapInput` via:
LedgerMap{ "key": LedgerArgs{...} }
type LedgerMapOutput ¶
type LedgerMapOutput struct{ *pulumi.OutputState }
func (LedgerMapOutput) ElementType ¶
func (LedgerMapOutput) ElementType() reflect.Type
func (LedgerMapOutput) MapIndex ¶
func (o LedgerMapOutput) MapIndex(k pulumi.StringInput) LedgerOutput
func (LedgerMapOutput) ToLedgerMapOutput ¶
func (o LedgerMapOutput) ToLedgerMapOutput() LedgerMapOutput
func (LedgerMapOutput) ToLedgerMapOutputWithContext ¶
func (o LedgerMapOutput) ToLedgerMapOutputWithContext(ctx context.Context) LedgerMapOutput
type LedgerOutput ¶
type LedgerOutput struct{ *pulumi.OutputState }
func (LedgerOutput) Arn ¶
func (o LedgerOutput) Arn() pulumi.StringOutput
The ARN of the QLDB Ledger
func (LedgerOutput) DeletionProtection ¶
func (o LedgerOutput) DeletionProtection() pulumi.BoolPtrOutput
The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via the provider, this value must be configured to `false` and applied first before attempting deletion.
func (LedgerOutput) ElementType ¶
func (LedgerOutput) ElementType() reflect.Type
func (LedgerOutput) KmsKey ¶
func (o LedgerOutput) KmsKey() pulumi.StringOutput
The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key.
func (LedgerOutput) Name ¶
func (o LedgerOutput) Name() pulumi.StringOutput
The friendly name for the QLDB Ledger instance. By default generated by the provider.
func (LedgerOutput) PermissionsMode ¶
func (o LedgerOutput) PermissionsMode() pulumi.StringOutput
The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`.
func (LedgerOutput) Tags ¶
func (o LedgerOutput) Tags() pulumi.StringMapOutput
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.
func (LedgerOutput) TagsAll
deprecated
func (o LedgerOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (LedgerOutput) ToLedgerOutput ¶
func (o LedgerOutput) ToLedgerOutput() LedgerOutput
func (LedgerOutput) ToLedgerOutputWithContext ¶
func (o LedgerOutput) ToLedgerOutputWithContext(ctx context.Context) LedgerOutput
type LedgerState ¶
type LedgerState struct { // The ARN of the QLDB Ledger Arn pulumi.StringPtrInput // The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via the provider, this value must be configured to `false` and applied first before attempting deletion. DeletionProtection pulumi.BoolPtrInput // The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key. KmsKey pulumi.StringPtrInput // The friendly name for the QLDB Ledger instance. By default generated by the provider. Name pulumi.StringPtrInput // The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`. PermissionsMode pulumi.StringPtrInput // 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. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (LedgerState) ElementType ¶
func (LedgerState) ElementType() reflect.Type
type LookupLedgerArgs ¶
type LookupLedgerArgs struct { // Friendly name of the ledger to match. Name string `pulumi:"name"` Tags map[string]string `pulumi:"tags"` }
A collection of arguments for invoking getLedger.
type LookupLedgerOutputArgs ¶
type LookupLedgerOutputArgs struct { // Friendly name of the ledger to match. Name pulumi.StringInput `pulumi:"name"` Tags pulumi.StringMapInput `pulumi:"tags"` }
A collection of arguments for invoking getLedger.
func (LookupLedgerOutputArgs) ElementType ¶
func (LookupLedgerOutputArgs) ElementType() reflect.Type
type LookupLedgerResult ¶
type LookupLedgerResult struct { Arn string `pulumi:"arn"` DeletionProtection bool `pulumi:"deletionProtection"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` KmsKey string `pulumi:"kmsKey"` Name string `pulumi:"name"` PermissionsMode string `pulumi:"permissionsMode"` Tags map[string]string `pulumi:"tags"` }
A collection of values returned by getLedger.
func LookupLedger ¶
func LookupLedger(ctx *pulumi.Context, args *LookupLedgerArgs, opts ...pulumi.InvokeOption) (*LookupLedgerResult, error)
Use this data source to fetch information about a Quantum Ledger Database.
## Example Usage
```go 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.LookupLedger(ctx, &qldb.LookupLedgerArgs{ Name: "an_example_ledger", }, nil) if err != nil { return err } return nil }) }
```
type LookupLedgerResultOutput ¶
type LookupLedgerResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getLedger.
func LookupLedgerOutput ¶
func LookupLedgerOutput(ctx *pulumi.Context, args LookupLedgerOutputArgs, opts ...pulumi.InvokeOption) LookupLedgerResultOutput
func (LookupLedgerResultOutput) Arn ¶
func (o LookupLedgerResultOutput) Arn() pulumi.StringOutput
func (LookupLedgerResultOutput) DeletionProtection ¶
func (o LookupLedgerResultOutput) DeletionProtection() pulumi.BoolOutput
func (LookupLedgerResultOutput) ElementType ¶
func (LookupLedgerResultOutput) ElementType() reflect.Type
func (LookupLedgerResultOutput) Id ¶
func (o LookupLedgerResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupLedgerResultOutput) KmsKey ¶
func (o LookupLedgerResultOutput) KmsKey() pulumi.StringOutput
func (LookupLedgerResultOutput) Name ¶
func (o LookupLedgerResultOutput) Name() pulumi.StringOutput
func (LookupLedgerResultOutput) PermissionsMode ¶
func (o LookupLedgerResultOutput) PermissionsMode() pulumi.StringOutput
func (LookupLedgerResultOutput) Tags ¶
func (o LookupLedgerResultOutput) Tags() pulumi.StringMapOutput
func (LookupLedgerResultOutput) ToLookupLedgerResultOutput ¶
func (o LookupLedgerResultOutput) ToLookupLedgerResultOutput() LookupLedgerResultOutput
func (LookupLedgerResultOutput) ToLookupLedgerResultOutputWithContext ¶
func (o LookupLedgerResultOutput) ToLookupLedgerResultOutputWithContext(ctx context.Context) LookupLedgerResultOutput
type Stream ¶
type Stream struct { pulumi.CustomResourceState // The ARN of the QLDB Stream. Arn pulumi.StringOutput `pulumi:"arn"` // 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"`. 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"`. 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`. InclusiveStartTime pulumi.StringOutput `pulumi:"inclusiveStartTime"` // The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. KinesisConfiguration StreamKinesisConfigurationOutput `pulumi:"kinesisConfiguration"` // The name of the QLDB 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. 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 the [Amazon QLDB Developer Guide](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming). StreamName pulumi.StringOutput `pulumi:"streamName"` // 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. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides an AWS Quantum Ledger Database (QLDB) Stream resource
## Example Usage
```go 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 }) }
```
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) 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. It 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"`. 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`. InclusiveStartTime pulumi.StringInput // The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. KinesisConfiguration StreamKinesisConfigurationInput // The name of the QLDB 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. 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 the [Amazon QLDB Developer Guide](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming). StreamName pulumi.StringInput // 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. Tags pulumi.StringMapInput }
The set of arguments for constructing a Stream resource.
func (StreamArgs) ElementType ¶
func (StreamArgs) ElementType() reflect.Type
type StreamArray ¶
type StreamArray []StreamInput
func (StreamArray) ElementType ¶
func (StreamArray) ElementType() reflect.Type
func (StreamArray) ToStreamArrayOutput ¶
func (i StreamArray) ToStreamArrayOutput() StreamArrayOutput
func (StreamArray) ToStreamArrayOutputWithContext ¶
func (i StreamArray) ToStreamArrayOutputWithContext(ctx context.Context) StreamArrayOutput
type StreamArrayInput ¶
type StreamArrayInput interface { pulumi.Input ToStreamArrayOutput() StreamArrayOutput ToStreamArrayOutputWithContext(context.Context) StreamArrayOutput }
StreamArrayInput is an input type that accepts StreamArray and StreamArrayOutput values. You can construct a concrete instance of `StreamArrayInput` via:
StreamArray{ StreamArgs{...} }
type StreamArrayOutput ¶
type StreamArrayOutput struct{ *pulumi.OutputState }
func (StreamArrayOutput) ElementType ¶
func (StreamArrayOutput) ElementType() reflect.Type
func (StreamArrayOutput) Index ¶
func (o StreamArrayOutput) Index(i pulumi.IntInput) StreamOutput
func (StreamArrayOutput) ToStreamArrayOutput ¶
func (o StreamArrayOutput) ToStreamArrayOutput() StreamArrayOutput
func (StreamArrayOutput) ToStreamArrayOutputWithContext ¶
func (o StreamArrayOutput) ToStreamArrayOutputWithContext(ctx context.Context) StreamArrayOutput
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`. 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`. AggregationEnabled pulumi.BoolPtrInput `pulumi:"aggregationEnabled"` // The Amazon Resource Name (ARN) of the Kinesis Data Streams resource. StreamArn pulumi.StringInput `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
func (StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutput ¶
func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
func (StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutputWithContext ¶
func (i StreamKinesisConfigurationArgs) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
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`.
func (StreamKinesisConfigurationOutput) ElementType ¶
func (StreamKinesisConfigurationOutput) ElementType() reflect.Type
func (StreamKinesisConfigurationOutput) StreamArn ¶
func (o StreamKinesisConfigurationOutput) StreamArn() pulumi.StringOutput
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
func (StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutput ¶
func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
func (StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutputWithContext ¶
func (o StreamKinesisConfigurationOutput) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
type StreamKinesisConfigurationPtrInput ¶
type StreamKinesisConfigurationPtrInput interface { pulumi.Input ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput ToStreamKinesisConfigurationPtrOutputWithContext(context.Context) StreamKinesisConfigurationPtrOutput }
StreamKinesisConfigurationPtrInput is an input type that accepts StreamKinesisConfigurationArgs, StreamKinesisConfigurationPtr and StreamKinesisConfigurationPtrOutput values. You can construct a concrete instance of `StreamKinesisConfigurationPtrInput` via:
StreamKinesisConfigurationArgs{...} or: nil
func StreamKinesisConfigurationPtr ¶
func StreamKinesisConfigurationPtr(v *StreamKinesisConfigurationArgs) StreamKinesisConfigurationPtrInput
type StreamKinesisConfigurationPtrOutput ¶
type StreamKinesisConfigurationPtrOutput struct{ *pulumi.OutputState }
func (StreamKinesisConfigurationPtrOutput) AggregationEnabled ¶
func (o StreamKinesisConfigurationPtrOutput) 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`.
func (StreamKinesisConfigurationPtrOutput) Elem ¶
func (o StreamKinesisConfigurationPtrOutput) Elem() StreamKinesisConfigurationOutput
func (StreamKinesisConfigurationPtrOutput) ElementType ¶
func (StreamKinesisConfigurationPtrOutput) ElementType() reflect.Type
func (StreamKinesisConfigurationPtrOutput) StreamArn ¶
func (o StreamKinesisConfigurationPtrOutput) StreamArn() pulumi.StringPtrOutput
The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
func (StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutput ¶
func (o StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutput() StreamKinesisConfigurationPtrOutput
func (StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutputWithContext ¶
func (o StreamKinesisConfigurationPtrOutput) ToStreamKinesisConfigurationPtrOutputWithContext(ctx context.Context) StreamKinesisConfigurationPtrOutput
type StreamMap ¶
type StreamMap map[string]StreamInput
func (StreamMap) ElementType ¶
func (StreamMap) ToStreamMapOutput ¶
func (i StreamMap) ToStreamMapOutput() StreamMapOutput
func (StreamMap) ToStreamMapOutputWithContext ¶
func (i StreamMap) ToStreamMapOutputWithContext(ctx context.Context) StreamMapOutput
type StreamMapInput ¶
type StreamMapInput interface { pulumi.Input ToStreamMapOutput() StreamMapOutput ToStreamMapOutputWithContext(context.Context) StreamMapOutput }
StreamMapInput is an input type that accepts StreamMap and StreamMapOutput values. You can construct a concrete instance of `StreamMapInput` via:
StreamMap{ "key": StreamArgs{...} }
type StreamMapOutput ¶
type StreamMapOutput struct{ *pulumi.OutputState }
func (StreamMapOutput) ElementType ¶
func (StreamMapOutput) ElementType() reflect.Type
func (StreamMapOutput) MapIndex ¶
func (o StreamMapOutput) MapIndex(k pulumi.StringInput) StreamOutput
func (StreamMapOutput) ToStreamMapOutput ¶
func (o StreamMapOutput) ToStreamMapOutput() StreamMapOutput
func (StreamMapOutput) ToStreamMapOutputWithContext ¶
func (o StreamMapOutput) ToStreamMapOutputWithContext(ctx context.Context) StreamMapOutput
type StreamOutput ¶
type StreamOutput struct{ *pulumi.OutputState }
func (StreamOutput) Arn ¶
func (o StreamOutput) Arn() pulumi.StringOutput
The ARN of the QLDB Stream.
func (StreamOutput) ElementType ¶
func (StreamOutput) ElementType() reflect.Type
func (StreamOutput) ExclusiveEndTime ¶
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. It 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 ¶
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"`. 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`.
func (StreamOutput) KinesisConfiguration ¶
func (o StreamOutput) KinesisConfiguration() StreamKinesisConfigurationOutput
The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
func (StreamOutput) LedgerName ¶
func (o StreamOutput) LedgerName() pulumi.StringOutput
The name of the QLDB ledger.
func (StreamOutput) RoleArn ¶
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.
func (StreamOutput) StreamName ¶
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 the [Amazon QLDB Developer Guide](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming).
func (StreamOutput) Tags ¶
func (o StreamOutput) Tags() pulumi.StringMapOutput
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.
func (StreamOutput) TagsAll
deprecated
func (o StreamOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (StreamOutput) ToStreamOutput ¶
func (o StreamOutput) ToStreamOutput() StreamOutput
func (StreamOutput) ToStreamOutputWithContext ¶
func (o StreamOutput) ToStreamOutputWithContext(ctx context.Context) StreamOutput
type StreamState ¶
type StreamState struct { // The ARN of the QLDB Stream. Arn pulumi.StringPtrInput // 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"`. 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"`. 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`. InclusiveStartTime pulumi.StringPtrInput // The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. KinesisConfiguration StreamKinesisConfigurationPtrInput // The name of the QLDB ledger. LedgerName pulumi.StringPtrInput // 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. RoleArn pulumi.StringPtrInput // 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](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming). StreamName pulumi.StringPtrInput // 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. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (StreamState) ElementType ¶
func (StreamState) ElementType() reflect.Type