AWS::IVS::EncoderConfiguration - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::IVS::EncoderConfiguration

The AWS::IVS::EncoderConfiguration resource specifies an Amazon IVS encoder configuration. An encoder configuration describes a stream’s video configuration. For more information, see Streaming Configuration in the Amazon IVS Low-Latency Streaming User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IVS::EncoderConfiguration",
  "Properties" : {
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "Video" : Video
    }
}

YAML

Type: AWS::IVS::EncoderConfiguration
Properties:
  Name: String
  Tags: 
    - Tag
  Video: 
    Video

Properties

Name

Encoder cnfiguration name.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Video

Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps. See the Video property type for more information.

Required: No

Type: Video

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the encoder-configuration ARN. For example:

{ "Ref": "myEncoderConfiguration" }

For the Amazon IVS encoder configuration "myEncoderConfiguration", Ref returns the encoder-configuration ARN.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The encoder-configuration ARN. For example: arn:aws:ivs:us-west-2:123456789012:encoder-configuration/abcdABCDefgh

Examples

EncoderConfiguration Template Examples

The following examples specify an Amazon IVS encoder configuration.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "EncoderConfiguration": {
            "Type": "AWS::IVS::EncoderConfiguration",
            "Properties": {
                "Name": "myEncoderConfiguration",
                "Video": {
                    "Bitrate": 1500000,
                    "Framerate": 1.5,
                    "Height": 100,
                    "Width": 100
                },
                "Tags": [
                    {
                        "Key": "MyKey",
                        "Value": "MyValue"
                    }
                ]
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources:
  EncoderConfiguration
    Type: AWS::IVS::EncoderConfiguration
    Properties:
      Video:
        Bitrate: 1500000
        Framerate: 1.5
        Height: 100
        Width: 100
      Name: myEncoderConfiguration
      Tags: 
        - Key: myKey
          Value: myValue

See also