kinesisStreamingDestination.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package dynamodb

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Enables a [Kinesis streaming destination](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/kds.html) for data replication of a DynamoDB table.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesis"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			example, err := dynamodb.NewTable(ctx, "example", &dynamodb.TableArgs{
//				Name:    pulumi.String("orders"),
//				HashKey: pulumi.String("id"),
//				Attributes: dynamodb.TableAttributeArray{
//					&dynamodb.TableAttributeArgs{
//						Name: pulumi.String("id"),
//						Type: pulumi.String("S"),
//					},
//				},
//			})
//			if err != nil {
//				return err
//			}
//			exampleStream, err := kinesis.NewStream(ctx, "example", &kinesis.StreamArgs{
//				Name:       pulumi.String("order_item_changes"),
//				ShardCount: pulumi.Int(1),
//			})
//			if err != nil {
//				return err
//			}
//			_, err = dynamodb.NewKinesisStreamingDestination(ctx, "example", &dynamodb.KinesisStreamingDestinationArgs{
//				StreamArn: exampleStream.Arn,
//				TableName: example.Name,
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
//
// ## Import
//
// Using `pulumi import`, import DynamoDB Kinesis Streaming Destinations using the `table_name` and `stream_arn` separated by `,`. For example:
//
// ```sh
// $ pulumi import aws:dynamodb/kinesisStreamingDestination:KinesisStreamingDestination example example,arn:aws:kinesis:us-east-1:111122223333:exampleStreamName
// ```
type KinesisStreamingDestination struct {
	pulumi.CustomResourceState

	// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
	StreamArn pulumi.StringOutput `pulumi:"streamArn"`
	// The name of the DynamoDB table. There
	// can only be one Kinesis streaming destination for a given DynamoDB table.
	TableName pulumi.StringOutput `pulumi:"tableName"`
}

// NewKinesisStreamingDestination registers a new resource with the given unique name, arguments, and options.
func NewKinesisStreamingDestination(ctx *pulumi.Context,
	name string, args *KinesisStreamingDestinationArgs, opts ...pulumi.ResourceOption) (*KinesisStreamingDestination, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.StreamArn == nil {
		return nil, errors.New("invalid value for required argument 'StreamArn'")
	}
	if args.TableName == nil {
		return nil, errors.New("invalid value for required argument 'TableName'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource KinesisStreamingDestination
	err := ctx.RegisterResource("aws:dynamodb/kinesisStreamingDestination:KinesisStreamingDestination", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetKinesisStreamingDestination gets an existing KinesisStreamingDestination 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 GetKinesisStreamingDestination(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *KinesisStreamingDestinationState, opts ...pulumi.ResourceOption) (*KinesisStreamingDestination, error) {
	var resource KinesisStreamingDestination
	err := ctx.ReadResource("aws:dynamodb/kinesisStreamingDestination:KinesisStreamingDestination", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering KinesisStreamingDestination resources.
type kinesisStreamingDestinationState struct {
	// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
	StreamArn *string `pulumi:"streamArn"`
	// The name of the DynamoDB table. There
	// can only be one Kinesis streaming destination for a given DynamoDB table.
	TableName *string `pulumi:"tableName"`
}

type KinesisStreamingDestinationState struct {
	// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
	StreamArn pulumi.StringPtrInput
	// The name of the DynamoDB table. There
	// can only be one Kinesis streaming destination for a given DynamoDB table.
	TableName pulumi.StringPtrInput
}

func (KinesisStreamingDestinationState) ElementType() reflect.Type {
	return reflect.TypeOf((*kinesisStreamingDestinationState)(nil)).Elem()
}

type kinesisStreamingDestinationArgs struct {
	// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
	StreamArn string `pulumi:"streamArn"`
	// The name of the DynamoDB table. There
	// can only be one Kinesis streaming destination for a given DynamoDB table.
	TableName string `pulumi:"tableName"`
}

// The set of arguments for constructing a KinesisStreamingDestination resource.
type KinesisStreamingDestinationArgs struct {
	// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
	StreamArn pulumi.StringInput
	// The name of the DynamoDB table. There
	// can only be one Kinesis streaming destination for a given DynamoDB table.
	TableName pulumi.StringInput
}

func (KinesisStreamingDestinationArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*kinesisStreamingDestinationArgs)(nil)).Elem()
}

type KinesisStreamingDestinationInput interface {
	pulumi.Input

	ToKinesisStreamingDestinationOutput() KinesisStreamingDestinationOutput
	ToKinesisStreamingDestinationOutputWithContext(ctx context.Context) KinesisStreamingDestinationOutput
}

func (*KinesisStreamingDestination) ElementType() reflect.Type {
	return reflect.TypeOf((**KinesisStreamingDestination)(nil)).Elem()
}

func (i *KinesisStreamingDestination) ToKinesisStreamingDestinationOutput() KinesisStreamingDestinationOutput {
	return i.ToKinesisStreamingDestinationOutputWithContext(context.Background())
}

func (i *KinesisStreamingDestination) ToKinesisStreamingDestinationOutputWithContext(ctx context.Context) KinesisStreamingDestinationOutput {
	return pulumi.ToOutputWithContext(ctx, i).(KinesisStreamingDestinationOutput)
}

// KinesisStreamingDestinationArrayInput is an input type that accepts KinesisStreamingDestinationArray and KinesisStreamingDestinationArrayOutput values.
// You can construct a concrete instance of `KinesisStreamingDestinationArrayInput` via:
//
//	KinesisStreamingDestinationArray{ KinesisStreamingDestinationArgs{...} }
type KinesisStreamingDestinationArrayInput interface {
	pulumi.Input

	ToKinesisStreamingDestinationArrayOutput() KinesisStreamingDestinationArrayOutput
	ToKinesisStreamingDestinationArrayOutputWithContext(context.Context) KinesisStreamingDestinationArrayOutput
}

type KinesisStreamingDestinationArray []KinesisStreamingDestinationInput

func (KinesisStreamingDestinationArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*KinesisStreamingDestination)(nil)).Elem()
}

func (i KinesisStreamingDestinationArray) ToKinesisStreamingDestinationArrayOutput() KinesisStreamingDestinationArrayOutput {
	return i.ToKinesisStreamingDestinationArrayOutputWithContext(context.Background())
}

func (i KinesisStreamingDestinationArray) ToKinesisStreamingDestinationArrayOutputWithContext(ctx context.Context) KinesisStreamingDestinationArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(KinesisStreamingDestinationArrayOutput)
}

// KinesisStreamingDestinationMapInput is an input type that accepts KinesisStreamingDestinationMap and KinesisStreamingDestinationMapOutput values.
// You can construct a concrete instance of `KinesisStreamingDestinationMapInput` via:
//
//	KinesisStreamingDestinationMap{ "key": KinesisStreamingDestinationArgs{...} }
type KinesisStreamingDestinationMapInput interface {
	pulumi.Input

	ToKinesisStreamingDestinationMapOutput() KinesisStreamingDestinationMapOutput
	ToKinesisStreamingDestinationMapOutputWithContext(context.Context) KinesisStreamingDestinationMapOutput
}

type KinesisStreamingDestinationMap map[string]KinesisStreamingDestinationInput

func (KinesisStreamingDestinationMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*KinesisStreamingDestination)(nil)).Elem()
}

func (i KinesisStreamingDestinationMap) ToKinesisStreamingDestinationMapOutput() KinesisStreamingDestinationMapOutput {
	return i.ToKinesisStreamingDestinationMapOutputWithContext(context.Background())
}

func (i KinesisStreamingDestinationMap) ToKinesisStreamingDestinationMapOutputWithContext(ctx context.Context) KinesisStreamingDestinationMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(KinesisStreamingDestinationMapOutput)
}

type KinesisStreamingDestinationOutput struct{ *pulumi.OutputState }

func (KinesisStreamingDestinationOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**KinesisStreamingDestination)(nil)).Elem()
}

func (o KinesisStreamingDestinationOutput) ToKinesisStreamingDestinationOutput() KinesisStreamingDestinationOutput {
	return o
}

func (o KinesisStreamingDestinationOutput) ToKinesisStreamingDestinationOutputWithContext(ctx context.Context) KinesisStreamingDestinationOutput {
	return o
}

// The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table.
func (o KinesisStreamingDestinationOutput) StreamArn() pulumi.StringOutput {
	return o.ApplyT(func(v *KinesisStreamingDestination) pulumi.StringOutput { return v.StreamArn }).(pulumi.StringOutput)
}

// The name of the DynamoDB table. There
// can only be one Kinesis streaming destination for a given DynamoDB table.
func (o KinesisStreamingDestinationOutput) TableName() pulumi.StringOutput {
	return o.ApplyT(func(v *KinesisStreamingDestination) pulumi.StringOutput { return v.TableName }).(pulumi.StringOutput)
}

type KinesisStreamingDestinationArrayOutput struct{ *pulumi.OutputState }

func (KinesisStreamingDestinationArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*KinesisStreamingDestination)(nil)).Elem()
}

func (o KinesisStreamingDestinationArrayOutput) ToKinesisStreamingDestinationArrayOutput() KinesisStreamingDestinationArrayOutput {
	return o
}

func (o KinesisStreamingDestinationArrayOutput) ToKinesisStreamingDestinationArrayOutputWithContext(ctx context.Context) KinesisStreamingDestinationArrayOutput {
	return o
}

func (o KinesisStreamingDestinationArrayOutput) Index(i pulumi.IntInput) KinesisStreamingDestinationOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *KinesisStreamingDestination {
		return vs[0].([]*KinesisStreamingDestination)[vs[1].(int)]
	}).(KinesisStreamingDestinationOutput)
}

type KinesisStreamingDestinationMapOutput struct{ *pulumi.OutputState }

func (KinesisStreamingDestinationMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*KinesisStreamingDestination)(nil)).Elem()
}

func (o KinesisStreamingDestinationMapOutput) ToKinesisStreamingDestinationMapOutput() KinesisStreamingDestinationMapOutput {
	return o
}

func (o KinesisStreamingDestinationMapOutput) ToKinesisStreamingDestinationMapOutputWithContext(ctx context.Context) KinesisStreamingDestinationMapOutput {
	return o
}

func (o KinesisStreamingDestinationMapOutput) MapIndex(k pulumi.StringInput) KinesisStreamingDestinationOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *KinesisStreamingDestination {
		return vs[0].(map[string]*KinesisStreamingDestination)[vs[1].(string)]
	}).(KinesisStreamingDestinationOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*KinesisStreamingDestinationInput)(nil)).Elem(), &KinesisStreamingDestination{})
	pulumi.RegisterInputType(reflect.TypeOf((*KinesisStreamingDestinationArrayInput)(nil)).Elem(), KinesisStreamingDestinationArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*KinesisStreamingDestinationMapInput)(nil)).Elem(), KinesisStreamingDestinationMap{})
	pulumi.RegisterOutputType(KinesisStreamingDestinationOutput{})
	pulumi.RegisterOutputType(KinesisStreamingDestinationArrayOutput{})
	pulumi.RegisterOutputType(KinesisStreamingDestinationMapOutput{})
}