awsivs

package
v1.115.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Jul 21, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnChannel_CFN_RESOURCE_TYPE_NAME 

func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnChannel_IsCfnElement 

func CfnChannel_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. Experimental.

func CfnChannel_IsCfnResource 

func CfnChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnChannel_IsConstruct 

func CfnChannel_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPlaybackKeyPair_CFN_RESOURCE_TYPE_NAME 

func CfnPlaybackKeyPair_CFN_RESOURCE_TYPE_NAME() *string

func CfnPlaybackKeyPair_IsCfnElement 

func CfnPlaybackKeyPair_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. Experimental.

func CfnPlaybackKeyPair_IsCfnResource 

func CfnPlaybackKeyPair_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPlaybackKeyPair_IsConstruct 

func CfnPlaybackKeyPair_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRecordingConfiguration_CFN_RESOURCE_TYPE_NAME 

func CfnRecordingConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnRecordingConfiguration_IsCfnElement 

func CfnRecordingConfiguration_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. Experimental.

func CfnRecordingConfiguration_IsCfnResource 

func CfnRecordingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRecordingConfiguration_IsConstruct 

func CfnRecordingConfiguration_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnStreamKey_CFN_RESOURCE_TYPE_NAME 

func CfnStreamKey_CFN_RESOURCE_TYPE_NAME() *string

func CfnStreamKey_IsCfnElement 

func CfnStreamKey_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. Experimental.

func CfnStreamKey_IsCfnResource 

func CfnStreamKey_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnStreamKey_IsConstruct 

func CfnStreamKey_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Channel_IsConstruct 

func Channel_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Channel_IsResource 

func Channel_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewCfnChannel_Override 

func NewCfnChannel_Override(c CfnChannel, scope awscdk.Construct, id *string, props *CfnChannelProps)

Create a new `AWS::IVS::Channel`.

func NewCfnPlaybackKeyPair_Override 

func NewCfnPlaybackKeyPair_Override(c CfnPlaybackKeyPair, scope awscdk.Construct, id *string, props *CfnPlaybackKeyPairProps)

Create a new `AWS::IVS::PlaybackKeyPair`.

func NewCfnRecordingConfiguration_Override 

func NewCfnRecordingConfiguration_Override(c CfnRecordingConfiguration, scope awscdk.Construct, id *string, props *CfnRecordingConfigurationProps)

Create a new `AWS::IVS::RecordingConfiguration`.

func NewCfnStreamKey_Override 

func NewCfnStreamKey_Override(c CfnStreamKey, scope awscdk.Construct, id *string, props *CfnStreamKeyProps)

Create a new `AWS::IVS::StreamKey`.

func NewChannel_Override 

func NewChannel_Override(c Channel, scope constructs.Construct, id *string, props *ChannelProps)

Experimental.

func NewPlaybackKeyPair_Override 

func NewPlaybackKeyPair_Override(p PlaybackKeyPair, scope constructs.Construct, id *string, props *PlaybackKeyPairProps)

Experimental.

func NewStreamKey_Override 

func NewStreamKey_Override(s StreamKey, scope constructs.Construct, id *string, props *StreamKeyProps)

Experimental.

func PlaybackKeyPair_IsConstruct 

func PlaybackKeyPair_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func PlaybackKeyPair_IsResource 

func PlaybackKeyPair_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func StreamKey_IsConstruct 

func StreamKey_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func StreamKey_IsResource 

func StreamKey_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type CfnChannel 

type CfnChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrIngestEndpoint() *string
	AttrPlaybackUrl() *string
	Authorized() interface{}
	SetAuthorized(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LatencyMode() *string
	SetLatencyMode(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	RecordingConfigurationArn() *string
	SetRecordingConfigurationArn(val *string)
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IVS::Channel`.

func NewCfnChannel 

func NewCfnChannel(scope awscdk.Construct, id *string, props *CfnChannelProps) CfnChannel

Create a new `AWS::IVS::Channel`.

type CfnChannelProps 

type CfnChannelProps struct {
	// `AWS::IVS::Channel.Authorized`.
	Authorized interface{} `json:"authorized"`
	// `AWS::IVS::Channel.LatencyMode`.
	LatencyMode *string `json:"latencyMode"`
	// `AWS::IVS::Channel.Name`.
	Name *string `json:"name"`
	// `AWS::IVS::Channel.RecordingConfigurationArn`.
	RecordingConfigurationArn *string `json:"recordingConfigurationArn"`
	// `AWS::IVS::Channel.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::IVS::Channel.Type`.
	Type *string `json:"type"`
}

Properties for defining a `AWS::IVS::Channel`.

type CfnPlaybackKeyPair 

type CfnPlaybackKeyPair interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrFingerprint() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	PublicKeyMaterial() *string
	SetPublicKeyMaterial(val *string)
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IVS::PlaybackKeyPair`.

func NewCfnPlaybackKeyPair 

func NewCfnPlaybackKeyPair(scope awscdk.Construct, id *string, props *CfnPlaybackKeyPairProps) CfnPlaybackKeyPair

Create a new `AWS::IVS::PlaybackKeyPair`.

type CfnPlaybackKeyPairProps 

type CfnPlaybackKeyPairProps struct {
	// `AWS::IVS::PlaybackKeyPair.PublicKeyMaterial`.
	PublicKeyMaterial *string `json:"publicKeyMaterial"`
	// `AWS::IVS::PlaybackKeyPair.Name`.
	Name *string `json:"name"`
	// `AWS::IVS::PlaybackKeyPair.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::IVS::PlaybackKeyPair`.

type CfnRecordingConfiguration 

type CfnRecordingConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrState() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DestinationConfiguration() interface{}
	SetDestinationConfiguration(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IVS::RecordingConfiguration`.

func NewCfnRecordingConfiguration 

func NewCfnRecordingConfiguration(scope awscdk.Construct, id *string, props *CfnRecordingConfigurationProps) CfnRecordingConfiguration

Create a new `AWS::IVS::RecordingConfiguration`.

type CfnRecordingConfigurationProps 

type CfnRecordingConfigurationProps struct {
	// `AWS::IVS::RecordingConfiguration.DestinationConfiguration`.
	DestinationConfiguration interface{} `json:"destinationConfiguration"`
	// `AWS::IVS::RecordingConfiguration.Name`.
	Name *string `json:"name"`
	// `AWS::IVS::RecordingConfiguration.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::IVS::RecordingConfiguration`.

type CfnRecordingConfiguration_DestinationConfigurationProperty 

type CfnRecordingConfiguration_DestinationConfigurationProperty struct {
	// `CfnRecordingConfiguration.DestinationConfigurationProperty.S3`.
	S3 interface{} `json:"s3"`
}

type CfnRecordingConfiguration_S3DestinationConfigurationProperty 

type CfnRecordingConfiguration_S3DestinationConfigurationProperty struct {
	// `CfnRecordingConfiguration.S3DestinationConfigurationProperty.BucketName`.
	BucketName *string `json:"bucketName"`
}

type CfnStreamKey 

type CfnStreamKey interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrValue() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ChannelArn() *string
	SetChannelArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IVS::StreamKey`.

func NewCfnStreamKey 

func NewCfnStreamKey(scope awscdk.Construct, id *string, props *CfnStreamKeyProps) CfnStreamKey

Create a new `AWS::IVS::StreamKey`.

type CfnStreamKeyProps 

type CfnStreamKeyProps struct {
	// `AWS::IVS::StreamKey.ChannelArn`.
	ChannelArn *string `json:"channelArn"`
	// `AWS::IVS::StreamKey.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::IVS::StreamKey`.

type Channel 

type Channel interface {
	awscdk.Resource
	IChannel
	ChannelArn() *string
	ChannelIngestEndpoint() *string
	ChannelPlaybackUrl() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	AddStreamKey(id *string) StreamKey
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A new IVS channel. Experimental.

func NewChannel 

func NewChannel(scope constructs.Construct, id *string, props *ChannelProps) Channel

Experimental.

type ChannelProps 

type ChannelProps struct {
	// Whether the channel is authorized.
	//
	// If you wish to make an authorized channel, you will need to ensure that
	// a PlaybackKeyPair has been uploaded to your account as this is used to
	// validate the signed JWT that is required for authorization
	// Experimental.
	Authorized *bool `json:"authorized"`
	// Channel latency mode.
	// Experimental.
	LatencyMode LatencyMode `json:"latencyMode"`
	// Channel name.
	// Experimental.
	Name *string `json:"name"`
	// The channel type, which determines the allowable resolution and bitrate.
	//
	// If you exceed the allowable resolution or bitrate, the stream will disconnect immediately
	// Experimental.
	Type ChannelType `json:"type"`
}

Properties for creating a new Channel. Experimental.

type ChannelType 

type ChannelType string

The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Experimental. 

const (
	ChannelType_STANDARD ChannelType = "STANDARD"
	ChannelType_BASIC    ChannelType = "BASIC"
)

type IChannel 

type IChannel interface {
	awscdk.IResource
	// Adds a stream key for this IVS Channel.
	// Experimental.
	AddStreamKey(id *string) StreamKey
	// The channel ARN.
	//
	// For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
	// Experimental.
	ChannelArn() *string
}

Represents an IVS Channel. Experimental.

func Channel_FromChannelArn 

func Channel_FromChannelArn(scope constructs.Construct, id *string, channelArn *string) IChannel

Import an existing channel. Experimental.

type IPlaybackKeyPair 

type IPlaybackKeyPair interface {
	awscdk.IResource
	// Key-pair ARN.
	//
	// For example: arn:aws:ivs:us-west-2:693991300569:playback-key/f99cde61-c2b0-4df3-8941-ca7d38acca1a
	// Experimental.
	PlaybackKeyPairArn() *string
}

Represents an IVS Playback Key Pair. Experimental.

type IStreamKey 

type IStreamKey interface {
	awscdk.IResource
	// The stream-key ARN.
	//
	// For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6
	// Experimental.
	StreamKeyArn() *string
}

Represents an IVS Stream Key. Experimental.

type LatencyMode 

type LatencyMode string

Channel latency mode. Experimental. 

const (
	LatencyMode_LOW    LatencyMode = "LOW"
	LatencyMode_NORMAL LatencyMode = "NORMAL"
)

type PlaybackKeyPair 

type PlaybackKeyPair interface {
	awscdk.Resource
	IPlaybackKeyPair
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	PlaybackKeyPairArn() *string
	PlaybackKeyPairFingerprint() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A new IVS Playback Key Pair. Experimental.

func NewPlaybackKeyPair 

func NewPlaybackKeyPair(scope constructs.Construct, id *string, props *PlaybackKeyPairProps) PlaybackKeyPair

Experimental.

type PlaybackKeyPairProps 

type PlaybackKeyPairProps struct {
	// The public portion of a customer-generated key pair.
	// Experimental.
	PublicKeyMaterial *string `json:"publicKeyMaterial"`
	// An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource.
	//
	// The value does not need to be unique.
	// Experimental.
	Name *string `json:"name"`
}

Properties for creating a new Playback Key Pair. Experimental.

type StreamKey 

type StreamKey interface {
	awscdk.Resource
	IStreamKey
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	StreamKeyArn() *string
	StreamKeyValue() *string
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A new IVS Stream Key. Experimental.

func NewStreamKey 

func NewStreamKey(scope constructs.Construct, id *string, props *StreamKeyProps) StreamKey

Experimental.

type StreamKeyProps 

type StreamKeyProps struct {
	// Channel ARN for the stream.
	// Experimental.
	Channel IChannel `json:"channel"`
}

Properties for creating a new Stream Key. Experimental.

Source Files

View all Source files

Directories

Path Synopsis

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.