kinesis

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 15, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FirehoseDeliveryStream 

type FirehoseDeliveryStream struct {
	// contains filtered or unexported fields
}

Provides a Kinesis Firehose Delivery Stream resource. Amazon Kinesis Firehose is a fully managed, elastic service to easily deliver real-time data streams to destinations such as Amazon S3 and Amazon Redshift.

For more details, see the [Amazon Kinesis Firehose Documentation][1].

func GetFirehoseDeliveryStream 

func GetFirehoseDeliveryStream(ctx *pulumi.Context,
	name string, id pulumi.ID, state *FirehoseDeliveryStreamState, opts ...pulumi.ResourceOpt) (*FirehoseDeliveryStream, error)

GetFirehoseDeliveryStream gets an existing FirehoseDeliveryStream 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 NewFirehoseDeliveryStream 

func NewFirehoseDeliveryStream(ctx *pulumi.Context,
	name string, args *FirehoseDeliveryStreamArgs, opts ...pulumi.ResourceOpt) (*FirehoseDeliveryStream, error)

NewFirehoseDeliveryStream registers a new resource with the given unique name, arguments, and options.

func (*FirehoseDeliveryStream) Arn 

func (r *FirehoseDeliveryStream) Arn() *pulumi.StringOutput

The Amazon Resource Name (ARN) specifying the Stream

func (*FirehoseDeliveryStream) Destination 

func (r *FirehoseDeliveryStream) Destination() *pulumi.StringOutput

This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, and `elasticsearch`.

func (*FirehoseDeliveryStream) DestinationId 

func (r *FirehoseDeliveryStream) DestinationId() *pulumi.StringOutput

func (*FirehoseDeliveryStream) ElasticsearchConfiguration 

func (r *FirehoseDeliveryStream) ElasticsearchConfiguration() *pulumi.Output

func (*FirehoseDeliveryStream) ExtendedS3Configuration 

func (r *FirehoseDeliveryStream) ExtendedS3Configuration() *pulumi.Output

Enhanced configuration options for the s3 destination. More details are given below.

func (*FirehoseDeliveryStream) ID 

func (r *FirehoseDeliveryStream) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*FirehoseDeliveryStream) KinesisSourceConfiguration 

func (r *FirehoseDeliveryStream) KinesisSourceConfiguration() *pulumi.Output

Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.

func (*FirehoseDeliveryStream) Name 

func (r *FirehoseDeliveryStream) Name() *pulumi.StringOutput

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

func (*FirehoseDeliveryStream) RedshiftConfiguration 

func (r *FirehoseDeliveryStream) RedshiftConfiguration() *pulumi.Output

Configuration options if redshift is the destination. Using `redshift_configuration` requires the user to also specify a `s3_configuration` block. More details are given below.

func (*FirehoseDeliveryStream) S3Configuration 

func (r *FirehoseDeliveryStream) S3Configuration() *pulumi.Output

Configuration options for the s3 destination (or the intermediate bucket if the destination is redshift). More details are given below.

func (*FirehoseDeliveryStream) SplunkConfiguration 

func (r *FirehoseDeliveryStream) SplunkConfiguration() *pulumi.Output

func (*FirehoseDeliveryStream) URN 

func (r *FirehoseDeliveryStream) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*FirehoseDeliveryStream) VersionId 

func (r *FirehoseDeliveryStream) VersionId() *pulumi.StringOutput

type FirehoseDeliveryStreamArgs 

type FirehoseDeliveryStreamArgs struct {
	// The Amazon Resource Name (ARN) specifying the Stream
	Arn interface{}
	// This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, and `elasticsearch`.
	Destination                interface{}
	DestinationId              interface{}
	ElasticsearchConfiguration interface{}
	// Enhanced configuration options for the s3 destination. More details are given below.
	ExtendedS3Configuration interface{}
	// Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.
	KinesisSourceConfiguration interface{}
	// A name to identify the stream. This is unique to the
	// AWS account and region the Stream is created in.
	Name interface{}
	// Configuration options if redshift is the destination.
	// Using `redshift_configuration` requires the user to also specify a
	// `s3_configuration` block. More details are given below.
	RedshiftConfiguration interface{}
	// Configuration options for the s3 destination (or the intermediate bucket if the destination
	// is redshift). More details are given below.
	S3Configuration     interface{}
	SplunkConfiguration interface{}
	VersionId           interface{}
}

The set of arguments for constructing a FirehoseDeliveryStream resource.

type FirehoseDeliveryStreamState 

type FirehoseDeliveryStreamState struct {
	// The Amazon Resource Name (ARN) specifying the Stream
	Arn interface{}
	// This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, and `elasticsearch`.
	Destination                interface{}
	DestinationId              interface{}
	ElasticsearchConfiguration interface{}
	// Enhanced configuration options for the s3 destination. More details are given below.
	ExtendedS3Configuration interface{}
	// Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.
	KinesisSourceConfiguration interface{}
	// A name to identify the stream. This is unique to the
	// AWS account and region the Stream is created in.
	Name interface{}
	// Configuration options if redshift is the destination.
	// Using `redshift_configuration` requires the user to also specify a
	// `s3_configuration` block. More details are given below.
	RedshiftConfiguration interface{}
	// Configuration options for the s3 destination (or the intermediate bucket if the destination
	// is redshift). More details are given below.
	S3Configuration     interface{}
	SplunkConfiguration interface{}
	VersionId           interface{}
}

Input properties used for looking up and filtering FirehoseDeliveryStream resources.

type GetStreamArgs 

type GetStreamArgs struct {
	// The name of the Kinesis Stream.
	Name interface{}
}

A collection of arguments for invoking getStream.

type GetStreamResult 

type GetStreamResult struct {
	// The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
	Arn interface{}
	// The list of shard ids in the CLOSED state. See [Shard State][2] for more.
	ClosedShards interface{}
	// The approximate UNIX timestamp that the stream was created.
	CreationTimestamp interface{}
	// The list of shard ids in the OPEN state. See [Shard State][2] for more.
	OpenShards interface{}
	// Length of time (in hours) data records are accessible after they are added to the stream.
	RetentionPeriod interface{}
	// A list of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch][3] for more.
	ShardLevelMetrics interface{}
	// The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
	Status interface{}
	// A mapping of tags to assigned to the stream.
	Tags interface{}
}

A collection of values returned by getStream.

func LookupStream 

func LookupStream(ctx *pulumi.Context, args *GetStreamArgs) (*GetStreamResult, error)

Use this data source to get information about a Kinesis Stream for use in other resources.

For more details, see the [Amazon Kinesis Documentation][1].

type Stream 

type Stream struct {
	// contains filtered or unexported fields
}

Provides a Kinesis Stream resource. Amazon Kinesis is a managed service that scales elastically for real-time processing of streaming big data.

For more details, see the [Amazon Kinesis Documentation][1].

func GetStream 

func GetStream(ctx *pulumi.Context,
	name string, id pulumi.ID, state *StreamState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*Stream, error)

NewStream registers a new resource with the given unique name, arguments, and options.

func (*Stream) Arn 

func (r *Stream) Arn() *pulumi.StringOutput

The Amazon Resource Name (ARN) specifying the Stream (same as `id`)

func (*Stream) EncryptionType 

func (r *Stream) EncryptionType() *pulumi.StringOutput

The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.

func (*Stream) ID 

func (r *Stream) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Stream) KmsKeyId 

func (r *Stream) KmsKeyId() *pulumi.StringOutput

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.

func (*Stream) Name 

func (r *Stream) Name() *pulumi.StringOutput

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

func (*Stream) RetentionPeriod 

func (r *Stream) RetentionPeriod() *pulumi.IntOutput

Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours. Minimum value is 24. Default is 24.

func (*Stream) ShardCount 

func (r *Stream) ShardCount() *pulumi.IntOutput

The number of shards that the stream will use. Amazon has guidlines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.

func (*Stream) ShardLevelMetrics 

func (r *Stream) ShardLevelMetrics() *pulumi.ArrayOutput

A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

func (*Stream) Tags 

func (r *Stream) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Stream) URN 

func (r *Stream) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type StreamArgs 

type StreamArgs struct {
	// The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
	Arn interface{}
	// The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
	EncryptionType interface{}
	// The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.
	KmsKeyId interface{}
	// A name to identify the stream. This is unique to the
	// AWS account and region the Stream is created in.
	Name interface{}
	// Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours. Minimum value is 24. Default is 24.
	RetentionPeriod interface{}
	// The number of shards that the stream will use.
	// Amazon has guidlines for specifying the Stream size that should be referenced
	// when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.
	ShardCount interface{}
	// A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
	ShardLevelMetrics interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a Stream resource.

type StreamState 

type StreamState struct {
	// The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
	Arn interface{}
	// The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
	EncryptionType interface{}
	// The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.
	KmsKeyId interface{}
	// A name to identify the stream. This is unique to the
	// AWS account and region the Stream is created in.
	Name interface{}
	// Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours. Minimum value is 24. Default is 24.
	RetentionPeriod interface{}
	// The number of shards that the stream will use.
	// Amazon has guidlines for specifying the Stream size that should be referenced
	// when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.
	ShardCount interface{}
	// A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
	ShardLevelMetrics interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering Stream resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.