awskinesisvideo

Documentation

Index

• func CfnSignalingChannel_CFN_RESOURCE_TYPE_NAME() *string
• func CfnSignalingChannel_IsCfnElement(x interface{}) *bool
• func CfnSignalingChannel_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnSignalingChannel_IsConstruct(x interface{}) *bool
• func CfnStream_CFN_RESOURCE_TYPE_NAME() *string
• func CfnStream_IsCfnElement(x interface{}) *bool
• func CfnStream_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnStream_IsConstruct(x interface{}) *bool
• func NewCfnSignalingChannel_Override(c CfnSignalingChannel, scope constructs.Construct, id *string, ...)
• func NewCfnStream_Override(c CfnStream, scope constructs.Construct, id *string, props *CfnStreamProps)
• type CfnSignalingChannel
  • func NewCfnSignalingChannel(scope constructs.Construct, id *string, props *CfnSignalingChannelProps) CfnSignalingChannel
• type CfnSignalingChannelProps
• type CfnStream
  • func NewCfnStream(scope constructs.Construct, id *string, props *CfnStreamProps) CfnStream
• type CfnStreamProps

Functions

func CfnSignalingChannel_CFN_RESOURCE_TYPE_NAME

func CfnSignalingChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnSignalingChannel_IsCfnElement

func CfnSignalingChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSignalingChannel_IsCfnResource

func CfnSignalingChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSignalingChannel_IsConstruct

func CfnSignalingChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnStream_CFN_RESOURCE_TYPE_NAME

func CfnStream_CFN_RESOURCE_TYPE_NAME() *string

func CfnStream_IsCfnElement

func CfnStream_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnStream_IsCfnResource

func CfnStream_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnStream_IsConstruct

func CfnStream_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnSignalingChannel_Override

func NewCfnSignalingChannel_Override(c CfnSignalingChannel, scope constructs.Construct, id *string, props *CfnSignalingChannelProps)

Create a new `AWS::KinesisVideo::SignalingChannel`.

func NewCfnStream_Override

func NewCfnStream_Override(c CfnStream, scope constructs.Construct, id *string, props *CfnStreamProps)

Create a new `AWS::KinesisVideo::Stream`.

Types

type CfnSignalingChannel

type CfnSignalingChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	MessageTtlSeconds() *float64
	SetMessageTtlSeconds(val *float64)
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::KinesisVideo::SignalingChannel`.

TODO: EXAMPLE

func NewCfnSignalingChannel

func NewCfnSignalingChannel(scope constructs.Construct, id *string, props *CfnSignalingChannelProps) CfnSignalingChannel

Create a new `AWS::KinesisVideo::SignalingChannel`.

type CfnSignalingChannelProps

type CfnSignalingChannelProps struct {
	// `AWS::KinesisVideo::SignalingChannel.MessageTtlSeconds`.
	MessageTtlSeconds *float64 `json:"messageTtlSeconds" yaml:"messageTtlSeconds"`
	// `AWS::KinesisVideo::SignalingChannel.Name`.
	Name *string `json:"name" yaml:"name"`
	// `AWS::KinesisVideo::SignalingChannel.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// `AWS::KinesisVideo::SignalingChannel.Type`.
	Type *string `json:"type" yaml:"type"`
}

Properties for defining a `CfnSignalingChannel`.

TODO: EXAMPLE

type CfnStream

type CfnStream interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataRetentionInHours() *float64
	SetDataRetentionInHours(val *float64)
	DeviceName() *string
	SetDeviceName(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	MediaType() *string
	SetMediaType(val *string)
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::KinesisVideo::Stream`.

TODO: EXAMPLE

func NewCfnStream

func NewCfnStream(scope constructs.Construct, id *string, props *CfnStreamProps) CfnStream

Create a new `AWS::KinesisVideo::Stream`.

type CfnStreamProps

type CfnStreamProps struct {
	// `AWS::KinesisVideo::Stream.DataRetentionInHours`.
	DataRetentionInHours *float64 `json:"dataRetentionInHours" yaml:"dataRetentionInHours"`
	// `AWS::KinesisVideo::Stream.DeviceName`.
	DeviceName *string `json:"deviceName" yaml:"deviceName"`
	// `AWS::KinesisVideo::Stream.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
	// `AWS::KinesisVideo::Stream.MediaType`.
	MediaType *string `json:"mediaType" yaml:"mediaType"`
	// `AWS::KinesisVideo::Stream.Name`.
	Name *string `json:"name" yaml:"name"`
	// `AWS::KinesisVideo::Stream.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnStream`.

TODO: EXAMPLE