kinesis

package
v0.0.1-alpha.101 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StreamModeDetailsStreamModeOnDemand    = StreamModeDetailsStreamMode("ON_DEMAND")
	StreamModeDetailsStreamModeProvisioned = StreamModeDetailsStreamMode("PROVISIONED")
)
View Source 
const (
	StreamEncryptionEncryptionTypeKms = StreamEncryptionEncryptionType("KMS")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupResourcePolicyArgs added in v1.1.0 

type LookupResourcePolicyArgs struct {
	// The ARN of the AWS Kinesis resource to which the policy applies.
	ResourceArn string `pulumi:"resourceArn"`
}

type LookupResourcePolicyOutputArgs added in v1.1.0 

type LookupResourcePolicyOutputArgs struct {
	// The ARN of the AWS Kinesis resource to which the policy applies.
	ResourceArn pulumi.StringInput `pulumi:"resourceArn"`
}

func (LookupResourcePolicyOutputArgs) ElementType added in v1.1.0 

func (LookupResourcePolicyOutputArgs) ElementType() reflect.Type

type LookupResourcePolicyResult added in v1.1.0 

type LookupResourcePolicyResult struct {
	// A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Kinesis::ResourcePolicy` for more information about the expected schema for this property.
	ResourcePolicy interface{} `pulumi:"resourcePolicy"`
}

func LookupResourcePolicy added in v1.1.0 

func LookupResourcePolicy(ctx *pulumi.Context, args *LookupResourcePolicyArgs, opts ...pulumi.InvokeOption) (*LookupResourcePolicyResult, error)

Resource Type definition for AWS::Kinesis::ResourcePolicy

type LookupResourcePolicyResultOutput added in v1.1.0 

type LookupResourcePolicyResultOutput struct{ *pulumi.OutputState }

func LookupResourcePolicyOutput added in v1.1.0 

func LookupResourcePolicyOutput(ctx *pulumi.Context, args LookupResourcePolicyOutputArgs, opts ...pulumi.InvokeOption) LookupResourcePolicyResultOutput

func (LookupResourcePolicyResultOutput) ElementType added in v1.1.0 

func (LookupResourcePolicyResultOutput) ElementType() reflect.Type

func (LookupResourcePolicyResultOutput) ResourcePolicy added in v1.1.0 

func (o LookupResourcePolicyResultOutput) ResourcePolicy() pulumi.AnyOutput

A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Kinesis::ResourcePolicy` for more information about the expected schema for this property.

func (LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutput added in v1.1.0 

func (o LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutput() LookupResourcePolicyResultOutput

func (LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutputWithContext added in v1.1.0 

func (o LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutputWithContext(ctx context.Context) LookupResourcePolicyResultOutput

type LookupStreamArgs added in v0.12.0 

type LookupStreamArgs struct {
	// The name of the Kinesis stream.
	Name string `pulumi:"name"`
}

type LookupStreamOutputArgs added in v0.12.0 

type LookupStreamOutputArgs struct {
	// The name of the Kinesis stream.
	Name pulumi.StringInput `pulumi:"name"`
}

func (LookupStreamOutputArgs) ElementType added in v0.12.0 

func (LookupStreamOutputArgs) ElementType() reflect.Type

type LookupStreamResult added in v0.12.0 

type LookupStreamResult struct {
	// The Amazon resource name (ARN) of the Kinesis stream
	Arn *string `pulumi:"arn"`
	// The number of hours for the data records that are stored in shards to remain accessible.
	RetentionPeriodHours *int `pulumi:"retentionPeriodHours"`
	// The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
	ShardCount *int `pulumi:"shardCount"`
	// When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
	StreamEncryption *StreamEncryption `pulumi:"streamEncryption"`
	// The mode in which the stream is running.
	StreamModeDetails *StreamModeDetails `pulumi:"streamModeDetails"`
	// An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupStream added in v0.12.0 

func LookupStream(ctx *pulumi.Context, args *LookupStreamArgs, opts ...pulumi.InvokeOption) (*LookupStreamResult, error)

Resource Type definition for AWS::Kinesis::Stream

type LookupStreamResultOutput added in v0.12.0 

type LookupStreamResultOutput struct{ *pulumi.OutputState }

func LookupStreamOutput added in v0.12.0 

func LookupStreamOutput(ctx *pulumi.Context, args LookupStreamOutputArgs, opts ...pulumi.InvokeOption) LookupStreamResultOutput

func (LookupStreamResultOutput) Arn added in v0.12.0 

func (o LookupStreamResultOutput) Arn() pulumi.StringPtrOutput

The Amazon resource name (ARN) of the Kinesis stream

func (LookupStreamResultOutput) ElementType added in v0.12.0 

func (LookupStreamResultOutput) ElementType() reflect.Type

func (LookupStreamResultOutput) RetentionPeriodHours added in v0.12.0 

func (o LookupStreamResultOutput) RetentionPeriodHours() pulumi.IntPtrOutput

The number of hours for the data records that are stored in shards to remain accessible.

func (LookupStreamResultOutput) ShardCount added in v0.12.0 

func (o LookupStreamResultOutput) ShardCount() pulumi.IntPtrOutput

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

func (LookupStreamResultOutput) StreamEncryption added in v0.12.0 

func (o LookupStreamResultOutput) StreamEncryption() StreamEncryptionPtrOutput

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

func (LookupStreamResultOutput) StreamModeDetails added in v0.12.0 

func (o LookupStreamResultOutput) StreamModeDetails() StreamModeDetailsPtrOutput

The mode in which the stream is running.

func (LookupStreamResultOutput) Tags added in v0.12.0 

func (o LookupStreamResultOutput) Tags() aws.TagArrayOutput

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

func (LookupStreamResultOutput) ToLookupStreamResultOutput added in v0.12.0 

func (o LookupStreamResultOutput) ToLookupStreamResultOutput() LookupStreamResultOutput

func (LookupStreamResultOutput) ToLookupStreamResultOutputWithContext added in v0.12.0 

func (o LookupStreamResultOutput) ToLookupStreamResultOutputWithContext(ctx context.Context) LookupStreamResultOutput

type ResourcePolicy added in v1.1.0 

type ResourcePolicy struct {
	pulumi.CustomResourceState

	// The ARN of the AWS Kinesis resource to which the policy applies.
	ResourceArn pulumi.StringOutput `pulumi:"resourceArn"`
	// A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Kinesis::ResourcePolicy` for more information about the expected schema for this property.
	ResourcePolicy pulumi.AnyOutput `pulumi:"resourcePolicy"`
}

Resource Type definition for AWS::Kinesis::ResourcePolicy

func GetResourcePolicy added in v1.1.0 

func GetResourcePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourcePolicyState, opts ...pulumi.ResourceOption) (*ResourcePolicy, error)

GetResourcePolicy gets an existing ResourcePolicy 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 NewResourcePolicy added in v1.1.0 

func NewResourcePolicy(ctx *pulumi.Context,
	name string, args *ResourcePolicyArgs, opts ...pulumi.ResourceOption) (*ResourcePolicy, error)

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

func (*ResourcePolicy) ElementType added in v1.1.0 

func (*ResourcePolicy) ElementType() reflect.Type

func (*ResourcePolicy) ToResourcePolicyOutput added in v1.1.0 

func (i *ResourcePolicy) ToResourcePolicyOutput() ResourcePolicyOutput

func (*ResourcePolicy) ToResourcePolicyOutputWithContext added in v1.1.0 

func (i *ResourcePolicy) ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput

type ResourcePolicyArgs added in v1.1.0 

type ResourcePolicyArgs struct {
	// The ARN of the AWS Kinesis resource to which the policy applies.
	ResourceArn pulumi.StringInput
	// A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Kinesis::ResourcePolicy` for more information about the expected schema for this property.
	ResourcePolicy pulumi.Input
}

The set of arguments for constructing a ResourcePolicy resource.

func (ResourcePolicyArgs) ElementType added in v1.1.0 

func (ResourcePolicyArgs) ElementType() reflect.Type

type ResourcePolicyInput added in v1.1.0 

type ResourcePolicyInput interface {
	pulumi.Input

	ToResourcePolicyOutput() ResourcePolicyOutput
	ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput
}

type ResourcePolicyOutput added in v1.1.0 

type ResourcePolicyOutput struct{ *pulumi.OutputState }

func (ResourcePolicyOutput) ElementType added in v1.1.0 

func (ResourcePolicyOutput) ElementType() reflect.Type

func (ResourcePolicyOutput) ResourceArn added in v1.1.0 

func (o ResourcePolicyOutput) ResourceArn() pulumi.StringOutput

The ARN of the AWS Kinesis resource to which the policy applies.

func (ResourcePolicyOutput) ResourcePolicy added in v1.1.0 

func (o ResourcePolicyOutput) ResourcePolicy() pulumi.AnyOutput

A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Kinesis::ResourcePolicy` for more information about the expected schema for this property.

func (ResourcePolicyOutput) ToResourcePolicyOutput added in v1.1.0 

func (o ResourcePolicyOutput) ToResourcePolicyOutput() ResourcePolicyOutput

func (ResourcePolicyOutput) ToResourcePolicyOutputWithContext added in v1.1.0 

func (o ResourcePolicyOutput) ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput

type ResourcePolicyState added in v1.1.0 

type ResourcePolicyState struct {
}

func (ResourcePolicyState) ElementType added in v1.1.0 

func (ResourcePolicyState) ElementType() reflect.Type

type Stream 

type Stream struct {
	pulumi.CustomResourceState

	// The Amazon resource name (ARN) of the Kinesis stream
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name of the Kinesis stream.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// The number of hours for the data records that are stored in shards to remain accessible.
	RetentionPeriodHours pulumi.IntPtrOutput `pulumi:"retentionPeriodHours"`
	// The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
	ShardCount pulumi.IntPtrOutput `pulumi:"shardCount"`
	// When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
	StreamEncryption StreamEncryptionPtrOutput `pulumi:"streamEncryption"`
	// The mode in which the stream is running.
	StreamModeDetails StreamModeDetailsPtrOutput `pulumi:"streamModeDetails"`
	// An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource Type definition for AWS::Kinesis::Stream

func GetStream 

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

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

func (*Stream) ElementType 

func (*Stream) ElementType() reflect.Type

func (*Stream) ToStreamOutput 

func (i *Stream) ToStreamOutput() StreamOutput

func (*Stream) ToStreamOutputWithContext 

func (i *Stream) ToStreamOutputWithContext(ctx context.Context) StreamOutput

type StreamArgs 

type StreamArgs struct {
	// The name of the Kinesis stream.
	Name pulumi.StringPtrInput
	// The number of hours for the data records that are stored in shards to remain accessible.
	RetentionPeriodHours pulumi.IntPtrInput
	// The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
	ShardCount pulumi.IntPtrInput
	// When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
	StreamEncryption StreamEncryptionPtrInput
	// The mode in which the stream is running.
	StreamModeDetails StreamModeDetailsPtrInput
	// An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Stream resource.

func (StreamArgs) ElementType 

func (StreamArgs) ElementType() reflect.Type

type StreamEncryption added in v0.2.0 

type StreamEncryption struct {
	// The encryption type to use. The only valid value is KMS.
	EncryptionType StreamEncryptionEncryptionType `pulumi:"encryptionType"`
	// The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
	KeyId string `pulumi:"keyId"`
}

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.

type StreamEncryptionArgs added in v0.2.0 

type StreamEncryptionArgs struct {
	// The encryption type to use. The only valid value is KMS.
	EncryptionType StreamEncryptionEncryptionTypeInput `pulumi:"encryptionType"`
	// The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
	KeyId pulumi.StringInput `pulumi:"keyId"`
}

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.

func (StreamEncryptionArgs) ElementType added in v0.2.0 

func (StreamEncryptionArgs) ElementType() reflect.Type

func (StreamEncryptionArgs) ToStreamEncryptionOutput added in v0.2.0 

func (i StreamEncryptionArgs) ToStreamEncryptionOutput() StreamEncryptionOutput

func (StreamEncryptionArgs) ToStreamEncryptionOutputWithContext added in v0.2.0 

func (i StreamEncryptionArgs) ToStreamEncryptionOutputWithContext(ctx context.Context) StreamEncryptionOutput

func (StreamEncryptionArgs) ToStreamEncryptionPtrOutput added in v0.2.0 

func (i StreamEncryptionArgs) ToStreamEncryptionPtrOutput() StreamEncryptionPtrOutput

func (StreamEncryptionArgs) ToStreamEncryptionPtrOutputWithContext added in v0.2.0 

func (i StreamEncryptionArgs) ToStreamEncryptionPtrOutputWithContext(ctx context.Context) StreamEncryptionPtrOutput

type StreamEncryptionEncryptionType added in v0.2.0 

type StreamEncryptionEncryptionType string

The encryption type to use. The only valid value is KMS.

func (StreamEncryptionEncryptionType) ElementType added in v0.2.0 

func (StreamEncryptionEncryptionType) ElementType() reflect.Type

func (StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypeOutput added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypeOutput() StreamEncryptionEncryptionTypeOutput

func (StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypeOutputWithContext added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypeOutputWithContext(ctx context.Context) StreamEncryptionEncryptionTypeOutput

func (StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypePtrOutput added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypePtrOutput() StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypePtrOutputWithContext added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStreamEncryptionEncryptionTypePtrOutputWithContext(ctx context.Context) StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionType) ToStringOutput added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStringOutput() pulumi.StringOutput

func (StreamEncryptionEncryptionType) ToStringOutputWithContext added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StreamEncryptionEncryptionType) ToStringPtrOutput added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamEncryptionEncryptionType) ToStringPtrOutputWithContext added in v0.2.0 

func (e StreamEncryptionEncryptionType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamEncryptionEncryptionTypeInput added in v0.2.0 

type StreamEncryptionEncryptionTypeInput interface {
	pulumi.Input

	ToStreamEncryptionEncryptionTypeOutput() StreamEncryptionEncryptionTypeOutput
	ToStreamEncryptionEncryptionTypeOutputWithContext(context.Context) StreamEncryptionEncryptionTypeOutput
}

StreamEncryptionEncryptionTypeInput is an input type that accepts values of the StreamEncryptionEncryptionType enum A concrete instance of `StreamEncryptionEncryptionTypeInput` can be one of the following: 

StreamEncryptionEncryptionTypeKms

type StreamEncryptionEncryptionTypeOutput added in v0.2.0 

type StreamEncryptionEncryptionTypeOutput struct{ *pulumi.OutputState }

func (StreamEncryptionEncryptionTypeOutput) ElementType added in v0.2.0 

func (StreamEncryptionEncryptionTypeOutput) ElementType() reflect.Type

func (StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypeOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypeOutput() StreamEncryptionEncryptionTypeOutput

func (StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypeOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypeOutputWithContext(ctx context.Context) StreamEncryptionEncryptionTypeOutput

func (StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypePtrOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypePtrOutput() StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypePtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStreamEncryptionEncryptionTypePtrOutputWithContext(ctx context.Context) StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionTypeOutput) ToStringOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStringOutput() pulumi.StringOutput

func (StreamEncryptionEncryptionTypeOutput) ToStringOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StreamEncryptionEncryptionTypeOutput) ToStringPtrOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamEncryptionEncryptionTypeOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamEncryptionEncryptionTypePtrInput added in v0.2.0 

type StreamEncryptionEncryptionTypePtrInput interface {
	pulumi.Input

	ToStreamEncryptionEncryptionTypePtrOutput() StreamEncryptionEncryptionTypePtrOutput
	ToStreamEncryptionEncryptionTypePtrOutputWithContext(context.Context) StreamEncryptionEncryptionTypePtrOutput
}

func StreamEncryptionEncryptionTypePtr added in v0.2.0 

func StreamEncryptionEncryptionTypePtr(v string) StreamEncryptionEncryptionTypePtrInput

type StreamEncryptionEncryptionTypePtrOutput added in v0.2.0 

type StreamEncryptionEncryptionTypePtrOutput struct{ *pulumi.OutputState }

func (StreamEncryptionEncryptionTypePtrOutput) Elem added in v0.2.0 

func (o StreamEncryptionEncryptionTypePtrOutput) Elem() StreamEncryptionEncryptionTypeOutput

func (StreamEncryptionEncryptionTypePtrOutput) ElementType added in v0.2.0 

func (StreamEncryptionEncryptionTypePtrOutput) ElementType() reflect.Type

func (StreamEncryptionEncryptionTypePtrOutput) ToStreamEncryptionEncryptionTypePtrOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypePtrOutput) ToStreamEncryptionEncryptionTypePtrOutput() StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionTypePtrOutput) ToStreamEncryptionEncryptionTypePtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypePtrOutput) ToStreamEncryptionEncryptionTypePtrOutputWithContext(ctx context.Context) StreamEncryptionEncryptionTypePtrOutput

func (StreamEncryptionEncryptionTypePtrOutput) ToStringPtrOutput added in v0.2.0 

func (o StreamEncryptionEncryptionTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamEncryptionEncryptionTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionEncryptionTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamEncryptionInput added in v0.2.0 

type StreamEncryptionInput interface {
	pulumi.Input

	ToStreamEncryptionOutput() StreamEncryptionOutput
	ToStreamEncryptionOutputWithContext(context.Context) StreamEncryptionOutput
}

StreamEncryptionInput is an input type that accepts StreamEncryptionArgs and StreamEncryptionOutput values. You can construct a concrete instance of `StreamEncryptionInput` via: 

StreamEncryptionArgs{...}

type StreamEncryptionOutput added in v0.2.0 

type StreamEncryptionOutput struct{ *pulumi.OutputState }

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.

func (StreamEncryptionOutput) ElementType added in v0.2.0 

func (StreamEncryptionOutput) ElementType() reflect.Type

func (StreamEncryptionOutput) EncryptionType added in v0.2.0 

func (o StreamEncryptionOutput) EncryptionType() StreamEncryptionEncryptionTypeOutput

The encryption type to use. The only valid value is KMS.

func (StreamEncryptionOutput) KeyId added in v0.2.0 

func (o StreamEncryptionOutput) KeyId() pulumi.StringOutput

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

func (StreamEncryptionOutput) ToStreamEncryptionOutput added in v0.2.0 

func (o StreamEncryptionOutput) ToStreamEncryptionOutput() StreamEncryptionOutput

func (StreamEncryptionOutput) ToStreamEncryptionOutputWithContext added in v0.2.0 

func (o StreamEncryptionOutput) ToStreamEncryptionOutputWithContext(ctx context.Context) StreamEncryptionOutput

func (StreamEncryptionOutput) ToStreamEncryptionPtrOutput added in v0.2.0 

func (o StreamEncryptionOutput) ToStreamEncryptionPtrOutput() StreamEncryptionPtrOutput

func (StreamEncryptionOutput) ToStreamEncryptionPtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionOutput) ToStreamEncryptionPtrOutputWithContext(ctx context.Context) StreamEncryptionPtrOutput

type StreamEncryptionPtrInput added in v0.2.0 

type StreamEncryptionPtrInput interface {
	pulumi.Input

	ToStreamEncryptionPtrOutput() StreamEncryptionPtrOutput
	ToStreamEncryptionPtrOutputWithContext(context.Context) StreamEncryptionPtrOutput
}

StreamEncryptionPtrInput is an input type that accepts StreamEncryptionArgs, StreamEncryptionPtr and StreamEncryptionPtrOutput values. You can construct a concrete instance of `StreamEncryptionPtrInput` via: 

        StreamEncryptionArgs{...}

or:

        nil

func StreamEncryptionPtr added in v0.2.0 

func StreamEncryptionPtr(v *StreamEncryptionArgs) StreamEncryptionPtrInput

type StreamEncryptionPtrOutput added in v0.2.0 

type StreamEncryptionPtrOutput struct{ *pulumi.OutputState }

func (StreamEncryptionPtrOutput) Elem added in v0.2.0 

func (o StreamEncryptionPtrOutput) Elem() StreamEncryptionOutput

func (StreamEncryptionPtrOutput) ElementType added in v0.2.0 

func (StreamEncryptionPtrOutput) ElementType() reflect.Type

func (StreamEncryptionPtrOutput) EncryptionType added in v0.2.0 

func (o StreamEncryptionPtrOutput) EncryptionType() StreamEncryptionEncryptionTypePtrOutput

The encryption type to use. The only valid value is KMS.

func (StreamEncryptionPtrOutput) KeyId added in v0.2.0 

func (o StreamEncryptionPtrOutput) KeyId() pulumi.StringPtrOutput

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

func (StreamEncryptionPtrOutput) ToStreamEncryptionPtrOutput added in v0.2.0 

func (o StreamEncryptionPtrOutput) ToStreamEncryptionPtrOutput() StreamEncryptionPtrOutput

func (StreamEncryptionPtrOutput) ToStreamEncryptionPtrOutputWithContext added in v0.2.0 

func (o StreamEncryptionPtrOutput) ToStreamEncryptionPtrOutputWithContext(ctx context.Context) StreamEncryptionPtrOutput

type StreamInput 

type StreamInput interface {
	pulumi.Input

	ToStreamOutput() StreamOutput
	ToStreamOutputWithContext(ctx context.Context) StreamOutput
}

type StreamModeDetails added in v0.9.0 

type StreamModeDetails struct {
	// The mode of the stream
	StreamMode StreamModeDetailsStreamMode `pulumi:"streamMode"`
}

When specified, enables or updates the mode of stream. Default is PROVISIONED.

type StreamModeDetailsArgs added in v0.9.0 

type StreamModeDetailsArgs struct {
	// The mode of the stream
	StreamMode StreamModeDetailsStreamModeInput `pulumi:"streamMode"`
}

When specified, enables or updates the mode of stream. Default is PROVISIONED.

func (StreamModeDetailsArgs) ElementType added in v0.9.0 

func (StreamModeDetailsArgs) ElementType() reflect.Type

func (StreamModeDetailsArgs) ToStreamModeDetailsOutput added in v0.9.0 

func (i StreamModeDetailsArgs) ToStreamModeDetailsOutput() StreamModeDetailsOutput

func (StreamModeDetailsArgs) ToStreamModeDetailsOutputWithContext added in v0.9.0 

func (i StreamModeDetailsArgs) ToStreamModeDetailsOutputWithContext(ctx context.Context) StreamModeDetailsOutput

func (StreamModeDetailsArgs) ToStreamModeDetailsPtrOutput added in v0.9.0 

func (i StreamModeDetailsArgs) ToStreamModeDetailsPtrOutput() StreamModeDetailsPtrOutput

func (StreamModeDetailsArgs) ToStreamModeDetailsPtrOutputWithContext added in v0.9.0 

func (i StreamModeDetailsArgs) ToStreamModeDetailsPtrOutputWithContext(ctx context.Context) StreamModeDetailsPtrOutput

type StreamModeDetailsInput added in v0.9.0 

type StreamModeDetailsInput interface {
	pulumi.Input

	ToStreamModeDetailsOutput() StreamModeDetailsOutput
	ToStreamModeDetailsOutputWithContext(context.Context) StreamModeDetailsOutput
}

StreamModeDetailsInput is an input type that accepts StreamModeDetailsArgs and StreamModeDetailsOutput values. You can construct a concrete instance of `StreamModeDetailsInput` via: 

StreamModeDetailsArgs{...}

type StreamModeDetailsOutput added in v0.9.0 

type StreamModeDetailsOutput struct{ *pulumi.OutputState }

When specified, enables or updates the mode of stream. Default is PROVISIONED.

func (StreamModeDetailsOutput) ElementType added in v0.9.0 

func (StreamModeDetailsOutput) ElementType() reflect.Type

func (StreamModeDetailsOutput) StreamMode added in v0.9.0 

func (o StreamModeDetailsOutput) StreamMode() StreamModeDetailsStreamModeOutput

The mode of the stream

func (StreamModeDetailsOutput) ToStreamModeDetailsOutput added in v0.9.0 

func (o StreamModeDetailsOutput) ToStreamModeDetailsOutput() StreamModeDetailsOutput

func (StreamModeDetailsOutput) ToStreamModeDetailsOutputWithContext added in v0.9.0 

func (o StreamModeDetailsOutput) ToStreamModeDetailsOutputWithContext(ctx context.Context) StreamModeDetailsOutput

func (StreamModeDetailsOutput) ToStreamModeDetailsPtrOutput added in v0.9.0 

func (o StreamModeDetailsOutput) ToStreamModeDetailsPtrOutput() StreamModeDetailsPtrOutput

func (StreamModeDetailsOutput) ToStreamModeDetailsPtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsOutput) ToStreamModeDetailsPtrOutputWithContext(ctx context.Context) StreamModeDetailsPtrOutput

type StreamModeDetailsPtrInput added in v0.9.0 

type StreamModeDetailsPtrInput interface {
	pulumi.Input

	ToStreamModeDetailsPtrOutput() StreamModeDetailsPtrOutput
	ToStreamModeDetailsPtrOutputWithContext(context.Context) StreamModeDetailsPtrOutput
}

StreamModeDetailsPtrInput is an input type that accepts StreamModeDetailsArgs, StreamModeDetailsPtr and StreamModeDetailsPtrOutput values. You can construct a concrete instance of `StreamModeDetailsPtrInput` via: 

        StreamModeDetailsArgs{...}

or:

        nil

func StreamModeDetailsPtr added in v0.9.0 

func StreamModeDetailsPtr(v *StreamModeDetailsArgs) StreamModeDetailsPtrInput

type StreamModeDetailsPtrOutput added in v0.9.0 

type StreamModeDetailsPtrOutput struct{ *pulumi.OutputState }

func (StreamModeDetailsPtrOutput) Elem added in v0.9.0 

func (o StreamModeDetailsPtrOutput) Elem() StreamModeDetailsOutput

func (StreamModeDetailsPtrOutput) ElementType added in v0.9.0 

func (StreamModeDetailsPtrOutput) ElementType() reflect.Type

func (StreamModeDetailsPtrOutput) StreamMode added in v0.9.0 

func (o StreamModeDetailsPtrOutput) StreamMode() StreamModeDetailsStreamModePtrOutput

The mode of the stream

func (StreamModeDetailsPtrOutput) ToStreamModeDetailsPtrOutput added in v0.9.0 

func (o StreamModeDetailsPtrOutput) ToStreamModeDetailsPtrOutput() StreamModeDetailsPtrOutput

func (StreamModeDetailsPtrOutput) ToStreamModeDetailsPtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsPtrOutput) ToStreamModeDetailsPtrOutputWithContext(ctx context.Context) StreamModeDetailsPtrOutput

type StreamModeDetailsStreamMode added in v0.9.0 

type StreamModeDetailsStreamMode string

The mode of the stream

func (StreamModeDetailsStreamMode) ElementType added in v0.9.0 

func (StreamModeDetailsStreamMode) ElementType() reflect.Type

func (StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModeOutput added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModeOutput() StreamModeDetailsStreamModeOutput

func (StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModeOutputWithContext added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModeOutputWithContext(ctx context.Context) StreamModeDetailsStreamModeOutput

func (StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModePtrOutput added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModePtrOutput() StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModePtrOutputWithContext added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStreamModeDetailsStreamModePtrOutputWithContext(ctx context.Context) StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamMode) ToStringOutput added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStringOutput() pulumi.StringOutput

func (StreamModeDetailsStreamMode) ToStringOutputWithContext added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StreamModeDetailsStreamMode) ToStringPtrOutput added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamModeDetailsStreamMode) ToStringPtrOutputWithContext added in v0.9.0 

func (e StreamModeDetailsStreamMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamModeDetailsStreamModeInput added in v0.9.0 

type StreamModeDetailsStreamModeInput interface {
	pulumi.Input

	ToStreamModeDetailsStreamModeOutput() StreamModeDetailsStreamModeOutput
	ToStreamModeDetailsStreamModeOutputWithContext(context.Context) StreamModeDetailsStreamModeOutput
}

StreamModeDetailsStreamModeInput is an input type that accepts values of the StreamModeDetailsStreamMode enum A concrete instance of `StreamModeDetailsStreamModeInput` can be one of the following: 

StreamModeDetailsStreamModeOnDemand
StreamModeDetailsStreamModeProvisioned

type StreamModeDetailsStreamModeOutput added in v0.9.0 

type StreamModeDetailsStreamModeOutput struct{ *pulumi.OutputState }

func (StreamModeDetailsStreamModeOutput) ElementType added in v0.9.0 

func (StreamModeDetailsStreamModeOutput) ElementType() reflect.Type

func (StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModeOutput added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModeOutput() StreamModeDetailsStreamModeOutput

func (StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModeOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModeOutputWithContext(ctx context.Context) StreamModeDetailsStreamModeOutput

func (StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModePtrOutput added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModePtrOutput() StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModePtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStreamModeDetailsStreamModePtrOutputWithContext(ctx context.Context) StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamModeOutput) ToStringOutput added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStringOutput() pulumi.StringOutput

func (StreamModeDetailsStreamModeOutput) ToStringOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StreamModeDetailsStreamModeOutput) ToStringPtrOutput added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamModeDetailsStreamModeOutput) ToStringPtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamModeDetailsStreamModePtrInput added in v0.9.0 

type StreamModeDetailsStreamModePtrInput interface {
	pulumi.Input

	ToStreamModeDetailsStreamModePtrOutput() StreamModeDetailsStreamModePtrOutput
	ToStreamModeDetailsStreamModePtrOutputWithContext(context.Context) StreamModeDetailsStreamModePtrOutput
}

func StreamModeDetailsStreamModePtr added in v0.9.0 

func StreamModeDetailsStreamModePtr(v string) StreamModeDetailsStreamModePtrInput

type StreamModeDetailsStreamModePtrOutput added in v0.9.0 

type StreamModeDetailsStreamModePtrOutput struct{ *pulumi.OutputState }

func (StreamModeDetailsStreamModePtrOutput) Elem added in v0.9.0 

func (o StreamModeDetailsStreamModePtrOutput) Elem() StreamModeDetailsStreamModeOutput

func (StreamModeDetailsStreamModePtrOutput) ElementType added in v0.9.0 

func (StreamModeDetailsStreamModePtrOutput) ElementType() reflect.Type

func (StreamModeDetailsStreamModePtrOutput) ToStreamModeDetailsStreamModePtrOutput added in v0.9.0 

func (o StreamModeDetailsStreamModePtrOutput) ToStreamModeDetailsStreamModePtrOutput() StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamModePtrOutput) ToStreamModeDetailsStreamModePtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModePtrOutput) ToStreamModeDetailsStreamModePtrOutputWithContext(ctx context.Context) StreamModeDetailsStreamModePtrOutput

func (StreamModeDetailsStreamModePtrOutput) ToStringPtrOutput added in v0.9.0 

func (o StreamModeDetailsStreamModePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (StreamModeDetailsStreamModePtrOutput) ToStringPtrOutputWithContext added in v0.9.0 

func (o StreamModeDetailsStreamModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StreamOutput 

type StreamOutput struct{ *pulumi.OutputState }

func (StreamOutput) Arn added in v0.17.0 

func (o StreamOutput) Arn() pulumi.StringOutput

The Amazon resource name (ARN) of the Kinesis stream

func (StreamOutput) ElementType 

func (StreamOutput) ElementType() reflect.Type

func (StreamOutput) Name added in v0.17.0 

func (o StreamOutput) Name() pulumi.StringPtrOutput

The name of the Kinesis stream.

func (StreamOutput) RetentionPeriodHours added in v0.17.0 

func (o StreamOutput) RetentionPeriodHours() pulumi.IntPtrOutput

The number of hours for the data records that are stored in shards to remain accessible.

func (StreamOutput) ShardCount added in v0.17.0 

func (o StreamOutput) ShardCount() pulumi.IntPtrOutput

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

func (StreamOutput) StreamEncryption added in v0.17.0 

func (o StreamOutput) StreamEncryption() StreamEncryptionPtrOutput

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

func (StreamOutput) StreamModeDetails added in v0.17.0 

func (o StreamOutput) StreamModeDetails() StreamModeDetailsPtrOutput

The mode in which the stream is running.

func (StreamOutput) Tags added in v0.17.0 

func (o StreamOutput) Tags() aws.TagArrayOutput

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

func (StreamOutput) ToStreamOutput 

func (o StreamOutput) ToStreamOutput() StreamOutput

func (StreamOutput) ToStreamOutputWithContext 

func (o StreamOutput) ToStreamOutputWithContext(ctx context.Context) StreamOutput

type StreamState 

type StreamState struct {
}

func (StreamState) ElementType 

func (StreamState) ElementType() reflect.Type

type StreamTag 

type StreamTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.

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.