Package software.amazon.awscdk.services.ivs

Class CfnEncoderConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ivs.CfnEncoderConfiguration
All Implemented Interfaces:
IInspectable, ITaggableV2, IEncoderConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:41.935Z") @Stability(Stable) public class CfnEncoderConfiguration extends CfnResource implements IInspectable, IEncoderConfigurationRef, ITaggableV2
The AWS::IVS::EncoderConfiguration resource specifies an 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnEncoderConfiguration cfnEncoderConfiguration = CfnEncoderConfiguration.Builder.create(this, "MyCfnEncoderConfiguration")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .video(VideoProperty.builder()
                 .bitrate(123)
                 .framerate(123)
                 .height(123)
                 .width(123)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEncoderConfiguration

      protected CfnEncoderConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEncoderConfiguration

      protected CfnEncoderConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEncoderConfiguration

      @Stability(Stable) public CfnEncoderConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnEncoderConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnEncoderConfiguration

      @Stability(Stable) public CfnEncoderConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The encoder-configuration ARN.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEncoderConfigurationRef

      @Stability(Stable) @NotNull public EncoderConfigurationReference getEncoderConfigurationRef()
      A reference to a EncoderConfiguration resource.
      Specified by:
      getEncoderConfigurationRef in interface IEncoderConfigurationRef

    • getName

      @Stability(Stable) @Nullable public String getName()
      Encoder cnfiguration name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Encoder cnfiguration name.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getVideo

      @Stability(Stable) @Nullable public Object getVideo()
      Video configuration.

      Returns union: either IResolvable or CfnEncoderConfiguration.VideoProperty

    • setVideo

      @Stability(Stable) public void setVideo(@Nullable IResolvable value)
      Video configuration.

    • setVideo

      @Stability(Stable) public void setVideo(@Nullable CfnEncoderConfiguration.VideoProperty value)
      Video configuration.