This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::MediaPackageV2::HarvestJob
Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::MediaPackageV2::HarvestJob", "Properties" : { "ChannelGroupName" :String, "ChannelName" :String, "Description" :String, "Destination" :Destination, "HarvestedManifests" :HarvestedManifests, "HarvestJobName" :String, "OriginEndpointName" :String, "ScheduleConfiguration" :HarvesterScheduleConfiguration, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::MediaPackageV2::HarvestJob Properties: ChannelGroupName:StringChannelName:StringDescription:StringDestination:DestinationHarvestedManifests:HarvestedManifestsHarvestJobName:StringOriginEndpointName:StringScheduleConfiguration:HarvesterScheduleConfigurationTags:- Tag
Properties
ChannelGroupName-
The name of the channel group containing the channel associated with the harvest job.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_-]+$Minimum:
1Maximum:
256Update requires: Replacement
ChannelName-
The name of the channel associated with the harvest job.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_-]+$Minimum:
1Maximum:
256Update requires: Replacement
Description-
The description of the harvest job, if provided.
Required: No
Type: String
Minimum:
0Maximum:
1024Update requires: Replacement
Destination-
The S3 destination where the harvested content is being placed.
Required: Yes
Type: Destination
Update requires: Replacement
HarvestedManifests-
A list of manifests that are being or have been harvested.
Required: Yes
Type: HarvestedManifests
Update requires: Replacement
HarvestJobName-
The name of the harvest job.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9_-]+$Minimum:
1Maximum:
256Update requires: Replacement
OriginEndpointName-
The name of the origin endpoint associated with the harvest job.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_-]+$Minimum:
1Maximum:
256Update requires: Replacement
ScheduleConfiguration-
The configuration for when the harvest job is scheduled to run, including start and end times.
Required: Yes
Type: HarvesterScheduleConfiguration
Update requires: Replacement
-
A collection of tags associated with the harvest job.
Required: No
Type: Array of Tag
Update requires: Replacement
Return values
Ref
Fn::GetAtt
Arn-
The Amazon Resource Name (ARN) of the harvest job.
CreatedAt-
The date and time when the harvest job was created.
ModifiedAt-
The date and time when the harvest job was last modified.
Status-
The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
