com.pulumi.aws.kinesis.StreamConsumer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.60.0-alpha.1731982519
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.kinesis;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.kinesis.StreamConsumerArgs;
import com.pulumi.aws.kinesis.inputs.StreamConsumerState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import javax.annotation.Nullable;

/**
 * Provides a resource to manage a Kinesis Stream Consumer.
 * 
 * > **Note:** You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
 * 
 * For more details, see the [Amazon Kinesis Stream Consumer Documentation](https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html).
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.kinesis.Stream;
 * import com.pulumi.aws.kinesis.StreamArgs;
 * import com.pulumi.aws.kinesis.StreamConsumer;
 * import com.pulumi.aws.kinesis.StreamConsumerArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * 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()
 *             .name("example-stream")
 *             .shardCount(1)
 *             .build());
 * 
 *         var exampleStreamConsumer = new StreamConsumer("exampleStreamConsumer", StreamConsumerArgs.builder()
 *             .name("example-consumer")
 *             .streamArn(example.arn())
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import Kinesis Stream Consumers using the Amazon Resource Name (ARN). For example:
 * 
 * ```sh
 * $ pulumi import aws:kinesis/streamConsumer:StreamConsumer example arn:aws:kinesis:us-west-2:123456789012:stream/example/consumer/example:1616044553
 * ```
 * 
 */
@ResourceType(type="aws:kinesis/streamConsumer:StreamConsumer")
public class StreamConsumer extends com.pulumi.resources.CustomResource {
    /**
     * Amazon Resource Name (ARN) of the stream consumer.
     * 
     */
    @Export(name="arn", refs={String.class}, tree="[0]")
    private Output arn;

    /**
     * @return Amazon Resource Name (ARN) of the stream consumer.
     * 
     */
    public Output arn() {
        return this.arn;
    }
    /**
     * Approximate timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of when the stream consumer was created.
     * 
     */
    @Export(name="creationTimestamp", refs={String.class}, tree="[0]")
    private Output creationTimestamp;

    /**
     * @return Approximate timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of when the stream consumer was created.
     * 
     */
    public Output creationTimestamp() {
        return this.creationTimestamp;
    }
    /**
     * Name of the stream consumer.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return Name of the stream consumer.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * Amazon Resource Name (ARN) of the data stream the consumer is registered with.
     * 
     */
    @Export(name="streamArn", refs={String.class}, tree="[0]")
    private Output streamArn;

    /**
     * @return Amazon Resource Name (ARN) of the data stream the consumer is registered with.
     * 
     */
    public Output streamArn() {
        return this.streamArn;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public StreamConsumer(java.lang.String name) {
        this(name, StreamConsumerArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public StreamConsumer(java.lang.String name, StreamConsumerArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public StreamConsumer(java.lang.String name, StreamConsumerArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:kinesis/streamConsumer:StreamConsumer", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private StreamConsumer(java.lang.String name, Output id, @Nullable StreamConsumerState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:kinesis/streamConsumer:StreamConsumer", name, state, makeResourceOptions(options, id), false);
    }

    private static StreamConsumerArgs makeArgs(StreamConsumerArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? StreamConsumerArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static StreamConsumer get(java.lang.String name, Output id, @Nullable StreamConsumerState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new StreamConsumer(name, id, state, options);
    }
}