Class KinesisStreamingDestination


  • public class KinesisStreamingDestination
    extends com.pulumi.resources.CustomResource
    Enables a [Kinesis streaming destination](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/kds.html) for data replication of a DynamoDB table. ## Example Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.dynamodb.Table;
     import com.pulumi.aws.dynamodb.TableArgs;
     import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
     import com.pulumi.aws.kinesis.Stream;
     import com.pulumi.aws.kinesis.StreamArgs;
     import com.pulumi.aws.kinesis.inputs.StreamStreamModeDetailsArgs;
     import com.pulumi.aws.dynamodb.KinesisStreamingDestination;
     import com.pulumi.aws.dynamodb.KinesisStreamingDestinationArgs;
     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 Table("example", TableArgs.builder()
                 .attributes(TableAttributeArgs.builder()
                     .name("id")
                     .type("S")
                     .build())
                 .name("orders")
                 .hashKey("id")
                 .build());
     
             var exampleStream = new Stream("exampleStream", StreamArgs.builder()
                 .streamModeDetails(StreamStreamModeDetailsArgs.builder()
                     .streamMode("ON_DEMAND")
                     .build())
                 .name("order_item_changes")
                 .build());
     
             var exampleKinesisStreamingDestination = new KinesisStreamingDestination("exampleKinesisStreamingDestination", KinesisStreamingDestinationArgs.builder()
                 .streamArn(exampleStream.arn())
                 .tableName(example.name())
                 .approximateCreationDateTimePrecision("MICROSECOND")
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import DynamoDB Kinesis Streaming Destinations using the `tableName` and `streamArn` separated by `,`. For example: ```sh $ pulumi import aws:dynamodb/kinesisStreamingDestination:KinesisStreamingDestination example example,arn:aws:kinesis:us-east-1:111122223333:exampleStreamName ```
    • 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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> approximateCreationDateTimePrecision()  
      static KinesisStreamingDestination get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KinesisStreamingDestinationState 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> region()  
      com.pulumi.core.Output<java.lang.String> streamArn()  
      com.pulumi.core.Output<java.lang.String> tableName()  
      • 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

      • KinesisStreamingDestination

        public KinesisStreamingDestination​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • KinesisStreamingDestination

        public KinesisStreamingDestination​(java.lang.String name,
                                           KinesisStreamingDestinationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • KinesisStreamingDestination

        public KinesisStreamingDestination​(java.lang.String name,
                                           KinesisStreamingDestinationArgs 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

      • approximateCreationDateTimePrecision

        public com.pulumi.core.Output<java.lang.String> approximateCreationDateTimePrecision()
        Returns:
        Toggle for the precision of Kinesis data stream timestamp. Valid values: `MILLISECOND` and `MICROSECOND`.
      • 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.
      • streamArn

        public com.pulumi.core.Output<java.lang.String> streamArn()
        Returns:
        The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
      • tableName

        public com.pulumi.core.Output<java.lang.String> tableName()
        Returns:
        The name of the DynamoDB table. There can only be one Kinesis streaming destination for a given DynamoDB table.
      • get

        public static KinesisStreamingDestination get​(java.lang.String name,
                                                      com.pulumi.core.Output<java.lang.String> id,
                                                      @Nullable
                                                      KinesisStreamingDestinationState 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.