CfnHarvestJobProps

class aws_cdk.aws_mediapackage.CfnHarvestJobProps(*, end_time, id, origin_endpoint_id, s3_destination, start_time)

Bases: object

Properties for defining a CfnHarvestJob.

Parameters:
  • end_time (str) – The end of the time-window which will be harvested.

  • id (str) – The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

  • origin_endpoint_id (str) – The ID of the OriginEndpoint that the HarvestJob will harvest from.

  • s3_destination (Union[IResolvable, S3DestinationProperty, Dict[str, Any]]) – Configuration parameters for where in an S3 bucket to place the harvested content.

  • start_time (str) – The start of the time-window which will be harvested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

cfn_harvest_job_props = mediapackage.CfnHarvestJobProps(
    end_time="endTime",
    id="id",
    origin_endpoint_id="originEndpointId",
    s3_destination=mediapackage.CfnHarvestJob.S3DestinationProperty(
        bucket_name="bucketName",
        manifest_key="manifestKey",
        role_arn="roleArn"
    ),
    start_time="startTime"
)

Attributes

end_time

The end of the time-window which will be harvested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html#cfn-mediapackage-harvestjob-endtime

id

The ID of the HarvestJob.

The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html#cfn-mediapackage-harvestjob-id

origin_endpoint_id

The ID of the OriginEndpoint that the HarvestJob will harvest from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html#cfn-mediapackage-harvestjob-originendpointid

s3_destination

Configuration parameters for where in an S3 bucket to place the harvested content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html#cfn-mediapackage-harvestjob-s3destination

start_time

The start of the time-window which will be harvested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html#cfn-mediapackage-harvestjob-starttime