kinesisvideo

package
v0.104.0 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SignalingChannelTypeSingleMaster = SignalingChannelType("SINGLE_MASTER")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupSignalingChannelArgs added in v0.12.0

type LookupSignalingChannelArgs struct {
	// The name of the Kinesis Video Signaling Channel.
	Name string `pulumi:"name"`
}

type LookupSignalingChannelOutputArgs added in v0.12.0

type LookupSignalingChannelOutputArgs struct {
	// The name of the Kinesis Video Signaling Channel.
	Name pulumi.StringInput `pulumi:"name"`
}

func (LookupSignalingChannelOutputArgs) ElementType added in v0.12.0

type LookupSignalingChannelResult added in v0.12.0

type LookupSignalingChannelResult struct {
	// The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
	Arn *string `pulumi:"arn"`
	// The period of time a signaling channel retains undelivered messages before they are discarded.
	MessageTtlSeconds *int `pulumi:"messageTtlSeconds"`
	// An array of key-value pairs to apply to this resource.
	Tags []aws.Tag `pulumi:"tags"`
	// The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
	Type *SignalingChannelType `pulumi:"type"`
}

func LookupSignalingChannel added in v0.12.0

func LookupSignalingChannel(ctx *pulumi.Context, args *LookupSignalingChannelArgs, opts ...pulumi.InvokeOption) (*LookupSignalingChannelResult, error)

Resource Type Definition for AWS::KinesisVideo::SignalingChannel

type LookupSignalingChannelResultOutput added in v0.12.0

type LookupSignalingChannelResultOutput struct{ *pulumi.OutputState }

func LookupSignalingChannelOutput added in v0.12.0

func (LookupSignalingChannelResultOutput) Arn added in v0.12.0

The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.

func (LookupSignalingChannelResultOutput) ElementType added in v0.12.0

func (LookupSignalingChannelResultOutput) MessageTtlSeconds added in v0.12.0

The period of time a signaling channel retains undelivered messages before they are discarded.

func (LookupSignalingChannelResultOutput) Tags added in v0.12.0

An array of key-value pairs to apply to this resource.

func (LookupSignalingChannelResultOutput) ToLookupSignalingChannelResultOutput added in v0.12.0

func (o LookupSignalingChannelResultOutput) ToLookupSignalingChannelResultOutput() LookupSignalingChannelResultOutput

func (LookupSignalingChannelResultOutput) ToLookupSignalingChannelResultOutputWithContext added in v0.12.0

func (o LookupSignalingChannelResultOutput) ToLookupSignalingChannelResultOutputWithContext(ctx context.Context) LookupSignalingChannelResultOutput

func (LookupSignalingChannelResultOutput) Type added in v0.12.0

The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.

type LookupStreamArgs added in v0.12.0

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

type LookupStreamOutputArgs added in v0.12.0

type LookupStreamOutputArgs struct {
	// The name of the Kinesis Video 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 Video stream.
	Arn *string `pulumi:"arn"`
	// The number of hours till which Kinesis Video will retain the data in the stream
	DataRetentionInHours *int `pulumi:"dataRetentionInHours"`
	// The name of the device that is writing to the stream.
	DeviceName *string `pulumi:"deviceName"`
	// AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
	KmsKeyId *string `pulumi:"kmsKeyId"`
	// The media type of the stream. Consumers of the stream can use this information when processing the stream.
	MediaType *string `pulumi:"mediaType"`
	// An array of key-value pairs associated with the Kinesis Video 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::KinesisVideo::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

The Amazon Resource Name (ARN) of the Kinesis Video stream.

func (LookupStreamResultOutput) DataRetentionInHours added in v0.12.0

func (o LookupStreamResultOutput) DataRetentionInHours() pulumi.IntPtrOutput

The number of hours till which Kinesis Video will retain the data in the stream

func (LookupStreamResultOutput) DeviceName added in v0.12.0

The name of the device that is writing to the stream.

func (LookupStreamResultOutput) ElementType added in v0.12.0

func (LookupStreamResultOutput) ElementType() reflect.Type

func (LookupStreamResultOutput) KmsKeyId added in v0.12.0

AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.

func (LookupStreamResultOutput) MediaType added in v0.12.0

The media type of the stream. Consumers of the stream can use this information when processing the stream.

func (LookupStreamResultOutput) Tags added in v0.12.0

An array of key-value pairs associated with the Kinesis Video 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 SignalingChannel

type SignalingChannel struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The period of time a signaling channel retains undelivered messages before they are discarded.
	MessageTtlSeconds pulumi.IntPtrOutput `pulumi:"messageTtlSeconds"`
	// The name of the Kinesis Video Signaling Channel.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// An array of key-value pairs to apply to this resource.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
	Type SignalingChannelTypePtrOutput `pulumi:"type"`
}

Resource Type Definition for AWS::KinesisVideo::SignalingChannel

func GetSignalingChannel

func GetSignalingChannel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SignalingChannelState, opts ...pulumi.ResourceOption) (*SignalingChannel, error)

GetSignalingChannel gets an existing SignalingChannel 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 NewSignalingChannel

func NewSignalingChannel(ctx *pulumi.Context,
	name string, args *SignalingChannelArgs, opts ...pulumi.ResourceOption) (*SignalingChannel, error)

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

func (*SignalingChannel) ElementType

func (*SignalingChannel) ElementType() reflect.Type

func (*SignalingChannel) ToSignalingChannelOutput

func (i *SignalingChannel) ToSignalingChannelOutput() SignalingChannelOutput

func (*SignalingChannel) ToSignalingChannelOutputWithContext

func (i *SignalingChannel) ToSignalingChannelOutputWithContext(ctx context.Context) SignalingChannelOutput

type SignalingChannelArgs

type SignalingChannelArgs struct {
	// The period of time a signaling channel retains undelivered messages before they are discarded.
	MessageTtlSeconds pulumi.IntPtrInput
	// The name of the Kinesis Video Signaling Channel.
	Name pulumi.StringPtrInput
	// An array of key-value pairs to apply to this resource.
	Tags aws.TagArrayInput
	// The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
	Type SignalingChannelTypePtrInput
}

The set of arguments for constructing a SignalingChannel resource.

func (SignalingChannelArgs) ElementType

func (SignalingChannelArgs) ElementType() reflect.Type

type SignalingChannelInput

type SignalingChannelInput interface {
	pulumi.Input

	ToSignalingChannelOutput() SignalingChannelOutput
	ToSignalingChannelOutputWithContext(ctx context.Context) SignalingChannelOutput
}

type SignalingChannelOutput

type SignalingChannelOutput struct{ *pulumi.OutputState }

func (SignalingChannelOutput) Arn added in v0.17.0

The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.

func (SignalingChannelOutput) ElementType

func (SignalingChannelOutput) ElementType() reflect.Type

func (SignalingChannelOutput) MessageTtlSeconds added in v0.17.0

func (o SignalingChannelOutput) MessageTtlSeconds() pulumi.IntPtrOutput

The period of time a signaling channel retains undelivered messages before they are discarded.

func (SignalingChannelOutput) Name added in v0.17.0

The name of the Kinesis Video Signaling Channel.

func (SignalingChannelOutput) Tags added in v0.17.0

An array of key-value pairs to apply to this resource.

func (SignalingChannelOutput) ToSignalingChannelOutput

func (o SignalingChannelOutput) ToSignalingChannelOutput() SignalingChannelOutput

func (SignalingChannelOutput) ToSignalingChannelOutputWithContext

func (o SignalingChannelOutput) ToSignalingChannelOutputWithContext(ctx context.Context) SignalingChannelOutput

func (SignalingChannelOutput) Type added in v0.17.0

The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.

type SignalingChannelState

type SignalingChannelState struct {
}

func (SignalingChannelState) ElementType

func (SignalingChannelState) ElementType() reflect.Type

type SignalingChannelTag

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

A key-value pair to associate with a resource.

type SignalingChannelType

type SignalingChannelType string

The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.

func (SignalingChannelType) ElementType

func (SignalingChannelType) ElementType() reflect.Type

func (SignalingChannelType) ToSignalingChannelTypeOutput

func (e SignalingChannelType) ToSignalingChannelTypeOutput() SignalingChannelTypeOutput

func (SignalingChannelType) ToSignalingChannelTypeOutputWithContext

func (e SignalingChannelType) ToSignalingChannelTypeOutputWithContext(ctx context.Context) SignalingChannelTypeOutput

func (SignalingChannelType) ToSignalingChannelTypePtrOutput

func (e SignalingChannelType) ToSignalingChannelTypePtrOutput() SignalingChannelTypePtrOutput

func (SignalingChannelType) ToSignalingChannelTypePtrOutputWithContext

func (e SignalingChannelType) ToSignalingChannelTypePtrOutputWithContext(ctx context.Context) SignalingChannelTypePtrOutput

func (SignalingChannelType) ToStringOutput

func (e SignalingChannelType) ToStringOutput() pulumi.StringOutput

func (SignalingChannelType) ToStringOutputWithContext

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

func (SignalingChannelType) ToStringPtrOutput

func (e SignalingChannelType) ToStringPtrOutput() pulumi.StringPtrOutput

func (SignalingChannelType) ToStringPtrOutputWithContext

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

type SignalingChannelTypeInput

type SignalingChannelTypeInput interface {
	pulumi.Input

	ToSignalingChannelTypeOutput() SignalingChannelTypeOutput
	ToSignalingChannelTypeOutputWithContext(context.Context) SignalingChannelTypeOutput
}

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

SignalingChannelTypeSingleMaster

type SignalingChannelTypeOutput

type SignalingChannelTypeOutput struct{ *pulumi.OutputState }

func (SignalingChannelTypeOutput) ElementType

func (SignalingChannelTypeOutput) ElementType() reflect.Type

func (SignalingChannelTypeOutput) ToSignalingChannelTypeOutput

func (o SignalingChannelTypeOutput) ToSignalingChannelTypeOutput() SignalingChannelTypeOutput

func (SignalingChannelTypeOutput) ToSignalingChannelTypeOutputWithContext

func (o SignalingChannelTypeOutput) ToSignalingChannelTypeOutputWithContext(ctx context.Context) SignalingChannelTypeOutput

func (SignalingChannelTypeOutput) ToSignalingChannelTypePtrOutput

func (o SignalingChannelTypeOutput) ToSignalingChannelTypePtrOutput() SignalingChannelTypePtrOutput

func (SignalingChannelTypeOutput) ToSignalingChannelTypePtrOutputWithContext

func (o SignalingChannelTypeOutput) ToSignalingChannelTypePtrOutputWithContext(ctx context.Context) SignalingChannelTypePtrOutput

func (SignalingChannelTypeOutput) ToStringOutput

func (o SignalingChannelTypeOutput) ToStringOutput() pulumi.StringOutput

func (SignalingChannelTypeOutput) ToStringOutputWithContext

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

func (SignalingChannelTypeOutput) ToStringPtrOutput

func (o SignalingChannelTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SignalingChannelTypeOutput) ToStringPtrOutputWithContext

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

type SignalingChannelTypePtrInput

type SignalingChannelTypePtrInput interface {
	pulumi.Input

	ToSignalingChannelTypePtrOutput() SignalingChannelTypePtrOutput
	ToSignalingChannelTypePtrOutputWithContext(context.Context) SignalingChannelTypePtrOutput
}

func SignalingChannelTypePtr

func SignalingChannelTypePtr(v string) SignalingChannelTypePtrInput

type SignalingChannelTypePtrOutput

type SignalingChannelTypePtrOutput struct{ *pulumi.OutputState }

func (SignalingChannelTypePtrOutput) Elem

func (SignalingChannelTypePtrOutput) ElementType

func (SignalingChannelTypePtrOutput) ToSignalingChannelTypePtrOutput

func (o SignalingChannelTypePtrOutput) ToSignalingChannelTypePtrOutput() SignalingChannelTypePtrOutput

func (SignalingChannelTypePtrOutput) ToSignalingChannelTypePtrOutputWithContext

func (o SignalingChannelTypePtrOutput) ToSignalingChannelTypePtrOutputWithContext(ctx context.Context) SignalingChannelTypePtrOutput

func (SignalingChannelTypePtrOutput) ToStringPtrOutput

func (SignalingChannelTypePtrOutput) ToStringPtrOutputWithContext

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

type Stream

type Stream struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the Kinesis Video stream.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The number of hours till which Kinesis Video will retain the data in the stream
	DataRetentionInHours pulumi.IntPtrOutput `pulumi:"dataRetentionInHours"`
	// The name of the device that is writing to the stream.
	DeviceName pulumi.StringPtrOutput `pulumi:"deviceName"`
	// AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
	KmsKeyId pulumi.StringPtrOutput `pulumi:"kmsKeyId"`
	// The media type of the stream. Consumers of the stream can use this information when processing the stream.
	MediaType pulumi.StringPtrOutput `pulumi:"mediaType"`
	// The name of the Kinesis Video stream.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// An array of key-value pairs associated with the Kinesis Video Stream.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource Type Definition for AWS::KinesisVideo::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 number of hours till which Kinesis Video will retain the data in the stream
	DataRetentionInHours pulumi.IntPtrInput
	// The name of the device that is writing to the stream.
	DeviceName pulumi.StringPtrInput
	// AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
	KmsKeyId pulumi.StringPtrInput
	// The media type of the stream. Consumers of the stream can use this information when processing the stream.
	MediaType pulumi.StringPtrInput
	// The name of the Kinesis Video stream.
	Name pulumi.StringPtrInput
	// An array of key-value pairs associated with the Kinesis Video Stream.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Stream resource.

func (StreamArgs) ElementType

func (StreamArgs) ElementType() reflect.Type

type StreamInput

type StreamInput interface {
	pulumi.Input

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

type StreamOutput

type StreamOutput struct{ *pulumi.OutputState }

func (StreamOutput) Arn added in v0.17.0

The Amazon Resource Name (ARN) of the Kinesis Video stream.

func (StreamOutput) DataRetentionInHours added in v0.17.0

func (o StreamOutput) DataRetentionInHours() pulumi.IntPtrOutput

The number of hours till which Kinesis Video will retain the data in the stream

func (StreamOutput) DeviceName added in v0.17.0

func (o StreamOutput) DeviceName() pulumi.StringPtrOutput

The name of the device that is writing to the stream.

func (StreamOutput) ElementType

func (StreamOutput) ElementType() reflect.Type

func (StreamOutput) KmsKeyId added in v0.17.0

func (o StreamOutput) KmsKeyId() pulumi.StringPtrOutput

AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.

func (StreamOutput) MediaType added in v0.17.0

func (o StreamOutput) MediaType() pulumi.StringPtrOutput

The media type of the stream. Consumers of the stream can use this information when processing the stream.

func (StreamOutput) Name added in v0.17.0

The name of the Kinesis Video stream.

func (StreamOutput) Tags added in v0.17.0

func (o StreamOutput) Tags() aws.TagArrayOutput

An array of key-value pairs associated with the Kinesis Video 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. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

A key-value pair to associated with the Kinesis Video Stream.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL