Documentation
¶
Index ¶
- func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannel_IsCfnElement(x interface{}) *bool
- func CfnChannel_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnChannel_IsConstruct(x interface{}) *bool
- func CfnPlaybackKeyPair_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPlaybackKeyPair_IsCfnElement(x interface{}) *bool
- func CfnPlaybackKeyPair_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPlaybackKeyPair_IsConstruct(x interface{}) *bool
- func CfnRecordingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRecordingConfiguration_IsCfnElement(x interface{}) *bool
- func CfnRecordingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRecordingConfiguration_IsConstruct(x interface{}) *bool
- func CfnStreamKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStreamKey_IsCfnElement(x interface{}) *bool
- func CfnStreamKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnStreamKey_IsConstruct(x interface{}) *bool
- func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
- func NewCfnPlaybackKeyPair_Override(c CfnPlaybackKeyPair, scope constructs.Construct, id *string, ...)
- func NewCfnRecordingConfiguration_Override(c CfnRecordingConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnStreamKey_Override(c CfnStreamKey, scope constructs.Construct, id *string, ...)
- type CfnChannel
- type CfnChannelProps
- type CfnPlaybackKeyPair
- type CfnPlaybackKeyPairProps
- type CfnRecordingConfiguration
- type CfnRecordingConfigurationProps
- type CfnRecordingConfiguration_DestinationConfigurationProperty
- type CfnRecordingConfiguration_S3DestinationConfigurationProperty
- type CfnRecordingConfiguration_ThumbnailConfigurationProperty
- type CfnStreamKey
- type CfnStreamKeyProps
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.
func CfnChannel_IsCfnResource ¶
func CfnChannel_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnChannel_IsConstruct ¶
func CfnChannel_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 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.
func CfnPlaybackKeyPair_IsCfnResource ¶
func CfnPlaybackKeyPair_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPlaybackKeyPair_IsConstruct ¶
func CfnPlaybackKeyPair_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 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.
func CfnRecordingConfiguration_IsCfnResource ¶
func CfnRecordingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRecordingConfiguration_IsConstruct ¶
func CfnRecordingConfiguration_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 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.
func CfnStreamKey_IsCfnResource ¶
func CfnStreamKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnStreamKey_IsConstruct ¶
func CfnStreamKey_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 NewCfnChannel_Override ¶
func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
Create a new `AWS::IVS::Channel`.
func NewCfnPlaybackKeyPair_Override ¶
func NewCfnPlaybackKeyPair_Override(c CfnPlaybackKeyPair, scope constructs.Construct, id *string, props *CfnPlaybackKeyPairProps)
Create a new `AWS::IVS::PlaybackKeyPair`.
func NewCfnRecordingConfiguration_Override ¶
func NewCfnRecordingConfiguration_Override(c CfnRecordingConfiguration, scope constructs.Construct, id *string, props *CfnRecordingConfigurationProps)
Create a new `AWS::IVS::RecordingConfiguration`.
func NewCfnStreamKey_Override ¶
func NewCfnStreamKey_Override(c CfnStreamKey, scope constructs.Construct, id *string, props *CfnStreamKeyProps)
Create a new `AWS::IVS::StreamKey`.
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() constructs.Node 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IVS::Channel`.
The `AWS::IVS::Channel` resource specifies an channel. A channel stores configuration information related to your live stream. For more information, see [CreateChannel](https://docs.aws.amazon.com/ivs/latest/APIReference/API_CreateChannel.html) in the *Amazon Interactive Video Service API Reference* .
> By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The Channel resource *does not* create a stream key; to create a stream key, use the StreamKey resource instead.
TODO: EXAMPLE
func NewCfnChannel ¶
func NewCfnChannel(scope constructs.Construct, id *string, props *CfnChannelProps) CfnChannel
Create a new `AWS::IVS::Channel`.
type CfnChannelProps ¶
type CfnChannelProps struct { // Whether the channel is authorized. // // *Default* : `false` Authorized interface{} `json:"authorized" yaml:"authorized"` // Channel latency mode. Valid values:. // // - `NORMAL` : Use NORMAL to broadcast and deliver live video up to Full HD. // - `LOW` : Use LOW for near real-time interactions with viewers. // // > In the console, `LOW` and `NORMAL` correspond to `Ultra-low` and `Standard` , respectively. // // *Default* : `LOW` LatencyMode *string `json:"latencyMode" yaml:"latencyMode"` // Channel name. Name *string `json:"name" yaml:"name"` // The ARN of a RecordingConfiguration resource. // // An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the [RecordingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html) resource for more information and an example. // // *Default* : "" (empty string, recording is disabled) RecordingConfigurationArn *string `json:"recordingConfigurationArn" yaml:"recordingConfigurationArn"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The channel type, which determines the allowable resolution and bitrate. // // *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.* Valid values: // // - `STANDARD` : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. // - `BASIC` : delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps. // // *Default* : `STANDARD` Type *string `json:"type" yaml:"type"` }
Properties for defining a `CfnChannel`.
TODO: EXAMPLE
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() constructs.Node 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IVS::PlaybackKeyPair`.
The `AWS::IVS::PlaybackKeyPair` resource specifies an playback key pair. uses a public playback key to validate playback tokens that have been signed with the corresponding private key. For more information, see [Setting Up Private Channels](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the *Amazon Interactive Video Service User Guide* .
TODO: EXAMPLE
func NewCfnPlaybackKeyPair ¶
func NewCfnPlaybackKeyPair(scope constructs.Construct, id *string, props *CfnPlaybackKeyPairProps) CfnPlaybackKeyPair
Create a new `AWS::IVS::PlaybackKeyPair`.
type CfnPlaybackKeyPairProps ¶
type CfnPlaybackKeyPairProps struct { // The public portion of a customer-generated key pair. PublicKeyMaterial *string `json:"publicKeyMaterial" yaml:"publicKeyMaterial"` // Playback-key-pair name. // // The value does not need to be unique. Name *string `json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnPlaybackKeyPair`.
TODO: EXAMPLE
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() constructs.Node Ref() *string Stack() awscdk.Stack Tags() awscdk.TagManager ThumbnailConfiguration() interface{} SetThumbnailConfiguration(val interface{}) 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::IVS::RecordingConfiguration`.
The `AWS::IVS::RecordingConfiguration` resource specifies an recording configuration. A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see [RecordingConfiguration](https://docs.aws.amazon.com/ivs/latest/APIReference/API_RecordingConfiguration.html) in the *Amazon Interactive Video Service API Reference* .
TODO: EXAMPLE
func NewCfnRecordingConfiguration ¶
func NewCfnRecordingConfiguration(scope constructs.Construct, id *string, props *CfnRecordingConfigurationProps) CfnRecordingConfiguration
Create a new `AWS::IVS::RecordingConfiguration`.
type CfnRecordingConfigurationProps ¶
type CfnRecordingConfigurationProps struct { // A destination configuration contains information about where recorded video will be stored. // // See the [DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html) property type for more information. DestinationConfiguration interface{} `json:"destinationConfiguration" yaml:"destinationConfiguration"` // Recording-configuration name. // // The value does not need to be unique. Name *string `json:"name" yaml:"name"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. // // See the [ThumbnailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thunbnailconfiguration.html) property type for more information. ThumbnailConfiguration interface{} `json:"thumbnailConfiguration" yaml:"thumbnailConfiguration"` }
Properties for defining a `CfnRecordingConfiguration`.
TODO: EXAMPLE
type CfnRecordingConfiguration_DestinationConfigurationProperty ¶
type CfnRecordingConfiguration_DestinationConfigurationProperty struct { // An S3 destination configuration where recorded videos will be stored. // // See the [S3DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.html) property type for more information. S3 interface{} `json:"s3" yaml:"s3"` }
The DestinationConfiguration property type describes the location where recorded videos will be stored.
Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
TODO: EXAMPLE
type CfnRecordingConfiguration_S3DestinationConfigurationProperty ¶
type CfnRecordingConfiguration_S3DestinationConfigurationProperty struct { // Location (S3 bucket name) where recorded videos will be stored. BucketName *string `json:"bucketName" yaml:"bucketName"` }
The S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.
TODO: EXAMPLE
type CfnRecordingConfiguration_ThumbnailConfigurationProperty ¶ added in v2.11.0
type CfnRecordingConfiguration_ThumbnailConfigurationProperty struct { // Thumbnail recording mode. Valid values:. // // - `DISABLED` : Use DISABLED to disable the generation of thumbnails for recorded video. // - `INTERVAL` : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the [TargetIntervalSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds) property. // // *Default* : `INTERVAL` RecordingMode *string `json:"recordingMode" yaml:"recordingMode"` // The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if [RecordingMode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode) is `INTERVAL` . // // > Setting a value for `TargetIntervalSeconds` does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the `TargetIntervalSeconds` interval, the `IDR/Keyframe` value for the input video must be less than the `TargetIntervalSeconds` value. See [Amazon IVS Streaming Configuration](https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html) for information on setting `IDR/Keyframe` to the recommended value in video-encoder settings. // // *Default* : 60 // // *Valid Range* : Minumum value of 5. Maximum value of 60. TargetIntervalSeconds *float64 `json:"targetIntervalSeconds" yaml:"targetIntervalSeconds"` }
The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.
TODO: EXAMPLE
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() 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::IVS::StreamKey`.
The `AWS::IVS::StreamKey` resource specifies an stream key associated with the referenced channel. Use a stream key to initiate a live stream.
TODO: EXAMPLE
func NewCfnStreamKey ¶
func NewCfnStreamKey(scope constructs.Construct, id *string, props *CfnStreamKeyProps) CfnStreamKey
Create a new `AWS::IVS::StreamKey`.
type CfnStreamKeyProps ¶
type CfnStreamKeyProps struct { // Channel ARN for the stream. ChannelArn *string `json:"channelArn" yaml:"channelArn"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnStreamKey`.
TODO: EXAMPLE