Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. ivs
  5. EncoderConfiguration

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivs.EncoderConfiguration

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IVS::EncoderConfiguration.

    Create EncoderConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EncoderConfiguration(name: string, args?: EncoderConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def EncoderConfiguration(resource_name: str,
                         args: Optional[EncoderConfigurationArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def EncoderConfiguration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         video: Optional[VideoPropertiesArgs] = None)
    func NewEncoderConfiguration(ctx *Context, name string, args *EncoderConfigurationArgs, opts ...ResourceOption) (*EncoderConfiguration, error)
    public EncoderConfiguration(string name, EncoderConfigurationArgs? args = null, CustomResourceOptions? opts = null)
    public EncoderConfiguration(String name, EncoderConfigurationArgs args)
public EncoderConfiguration(String name, EncoderConfigurationArgs args, CustomResourceOptions options)

    type: aws-native:ivs:EncoderConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EncoderConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EncoderConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EncoderConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EncoderConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EncoderConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const encoderConfigurationResource = new aws_native.ivs.EncoderConfiguration("encoderConfigurationResource", {
    name: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    video: {
        bitrate: 0,
        framerate: 0,
        height: 0,
        width: 0,
    },
});

    Coming soon!

    EncoderConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EncoderConfiguration resource accepts the following input properties:

    Name string
    Encoder configuration name.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Video Pulumi.AwsNative.Ivs.Inputs.VideoProperties
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
    Name string
    Encoder configuration name.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    Video VideoPropertiesArgs
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
    name String
    Encoder configuration name.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    video VideoProperties
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
    name string
    Encoder configuration name.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    video VideoProperties
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
    name str
    Encoder configuration name.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    video VideoPropertiesArgs
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
    name String
    Encoder configuration name.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    video Property Map
    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EncoderConfiguration resource produces the following output properties:

    Arn string
    Encoder configuration identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Encoder configuration identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Encoder configuration identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Encoder configuration identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Encoder configuration identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Encoder configuration identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    VideoProperties, VideoPropertiesArgs

    Bitrate int
    Bitrate for generated output, in bps. Default: 2500000.
    Framerate double
    Video frame rate, in fps. Default: 30.
    Height int
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    Width int
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
    Bitrate int
    Bitrate for generated output, in bps. Default: 2500000.
    Framerate float64
    Video frame rate, in fps. Default: 30.
    Height int
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    Width int
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
    bitrate Integer
    Bitrate for generated output, in bps. Default: 2500000.
    framerate Double
    Video frame rate, in fps. Default: 30.
    height Integer
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    width Integer
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
    bitrate number
    Bitrate for generated output, in bps. Default: 2500000.
    framerate number
    Video frame rate, in fps. Default: 30.
    height number
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    width number
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
    bitrate int
    Bitrate for generated output, in bps. Default: 2500000.
    framerate float
    Video frame rate, in fps. Default: 30.
    height int
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    width int
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
    bitrate Number
    Bitrate for generated output, in bps. Default: 2500000.
    framerate Number
    Video frame rate, in fps. Default: 30.
    height Number
    Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    width Number
    Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native