Package com.pulumi.aws.qldb

Class Stream

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.qldb.Stream

public class Stream
extends com.pulumi.resources.CustomResource

Provides an AWS Quantum Ledger Database (QLDB) Stream resource ## Example Usage

 
 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());
 
     }
 }
 
 

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
Stream(java.lang.String name)
Stream(java.lang.String name, StreamArgs args)
Stream(java.lang.String name, StreamArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	exclusiveEndTime()
static Stream	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, StreamState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.lang.String>	inclusiveStartTime()
com.pulumi.core.Output<StreamKinesisConfiguration>	kinesisConfiguration()
com.pulumi.core.Output<java.lang.String>	ledgerName()
com.pulumi.core.Output<java.lang.String>	region()
com.pulumi.core.Output<java.lang.String>	roleArn()
com.pulumi.core.Output<java.lang.String>	streamName()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Stream

public Stream(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

Stream

public Stream(java.lang.String name,
              StreamArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

Stream

public Stream(java.lang.String name,
              StreamArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

arn

public com.pulumi.core.Output<java.lang.String> arn()

Returns:

ARN of the QLDB Stream.

exclusiveEndTime

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> exclusiveEndTime()

Returns:

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

inclusiveStartTime

public com.pulumi.core.Output<java.lang.String> inclusiveStartTime()

Returns:

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

kinesisConfiguration

public com.pulumi.core.Output<StreamKinesisConfiguration> kinesisConfiguration()

Returns:

Configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.

ledgerName

public com.pulumi.core.Output<java.lang.String> ledgerName()

Returns:

Name of the QLDB ledger.

region

public com.pulumi.core.Output<java.lang.String> region()

Returns:

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

roleArn

public com.pulumi.core.Output<java.lang.String> roleArn()

Returns:

ARN of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

streamName

public com.pulumi.core.Output<java.lang.String> streamName()

Returns:

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

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

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.

tagsAll

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

get

public static Stream get(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         StreamState state,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)

Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.