Package software.amazon.awscdk.services.mediapackage

Class CfnHarvestJob

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.mediapackage.CfnHarvestJob
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IHarvestJobRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:07.043Z") @Stability(Stable) public class CfnHarvestJob extends CfnResource implements IInspectable, IHarvestJobRef
Resource schema for AWS::MediaPackage::HarvestJob.

A HarvestJob extracts a video on demand (VOD) clip from a live content stream.

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.mediapackage.*;
 CfnHarvestJob cfnHarvestJob = CfnHarvestJob.Builder.create(this, "MyCfnHarvestJob")
         .endTime("endTime")
         .id("id")
         .originEndpointId("originEndpointId")
         .s3Destination(S3DestinationProperty.builder()
                 .bucketName("bucketName")
                 .manifestKey("manifestKey")
                 .roleArn("roleArn")
                 .build())
         .startTime("startTime")
         .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

    • CfnHarvestJob

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

    • CfnHarvestJob

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

    • CfnHarvestJob

      @Stability(Stable) public CfnHarvestJob(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHarvestJobProps props)
      Create a new AWS::MediaPackage::HarvestJob.

      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. This parameter is required.

  • Method Details

    • arnForHarvestJob

      @Stability(Stable) @NotNull public static String arnForHarvestJob(@NotNull IHarvestJobRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnHarvestJob

      @Stability(Stable) @NotNull public static Boolean isCfnHarvestJob(@NotNull Object x)
      Checks whether the given object is a CfnHarvestJob.

      Parameters:
      x - This parameter is required.

    • 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 Amazon Resource Name (ARN) assigned to the HarvestJob.

    • getAttrChannelId

      @Stability(Stable) @NotNull public String getAttrChannelId()
      The ID of the Channel that the HarvestJob will harvest from.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time the HarvestJob was submitted.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the HarvestJob.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getHarvestJobRef

      @Stability(Stable) @NotNull public HarvestJobReference getHarvestJobRef()
      A reference to a HarvestJob resource.
      Specified by:
      getHarvestJobRef in interface IHarvestJobRef

    • getEndTime

      @Stability(Stable) @NotNull public String getEndTime()
      The end of the time-window which will be harvested.

    • setEndTime

      @Stability(Stable) public void setEndTime(@NotNull String value)
      The end of the time-window which will be harvested.

    • getId

      @Stability(Stable) @NotNull public String getId()
      The ID of the HarvestJob.

    • setId

      @Stability(Stable) public void setId(@NotNull String value)
      The ID of the HarvestJob.

    • getOriginEndpointId

      @Stability(Stable) @NotNull public String getOriginEndpointId()
      The ID of the OriginEndpoint that the HarvestJob will harvest from.

    • setOriginEndpointId

      @Stability(Stable) public void setOriginEndpointId(@NotNull String value)
      The ID of the OriginEndpoint that the HarvestJob will harvest from.

    • getS3Destination

      @Stability(Stable) @NotNull public Object getS3Destination()
      Configuration parameters for where in an S3 bucket to place the harvested content.

      Returns union: either IResolvable or CfnHarvestJob.S3DestinationProperty

    • setS3Destination

      @Stability(Stable) public void setS3Destination(@NotNull IResolvable value)
      Configuration parameters for where in an S3 bucket to place the harvested content.

    • setS3Destination

      @Stability(Stable) public void setS3Destination(@NotNull CfnHarvestJob.S3DestinationProperty value)
      Configuration parameters for where in an S3 bucket to place the harvested content.

    • getStartTime

      @Stability(Stable) @NotNull public String getStartTime()
      The start of the time-window which will be harvested.

    • setStartTime

      @Stability(Stable) public void setStartTime(@NotNull String value)
      The start of the time-window which will be harvested.