CfnHarvestJobPropsMixin

class aws_cdk.cfn_property_mixins.aws_mediapackage.CfnHarvestJobPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource schema for AWS::MediaPackage::HarvestJob.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-harvestjob.html
CloudformationResource:: AWS::MediaPackage::HarvestJob
Mixin:: true
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.cfn_property_mixins import aws_mediapackage as mediapackage
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_harvest_job_props_mixin = mediapackage.CfnHarvestJobPropsMixin(mediapackage.CfnHarvestJobMixinProps(
    end_time="endTime",
    id="id",
    origin_endpoint_id="originEndpointId",
    s3_destination=mediapackage.CfnHarvestJobPropsMixin.S3DestinationProperty(
        bucket_name="bucketName",
        manifest_key="manifestKey",
        role_arn="roleArn"
    ),
    start_time="startTime"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::MediaPackage::HarvestJob.

Parameters:

props (Union[CfnHarvestJobMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['endTime', 'id', 'originEndpointId', 's3Destination', 'startTime']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

S3DestinationProperty

class CfnHarvestJobPropsMixin.S3DestinationProperty(*, bucket_name=None, manifest_key=None, role_arn=None)

Bases: object

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

Parameters:

bucket_name (Optional[str]) – The name of an S3 bucket within which harvested content will be exported.
manifest_key (Optional[str]) – The key in the specified S3 bucket where the harvested top-level manifest will be placed.
role_arn (Optional[str]) – The IAM role used to write to the specified S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-harvestjob-s3destination.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.cfn_property_mixins import aws_mediapackage as mediapackage

s3_destination_property = mediapackage.CfnHarvestJobPropsMixin.S3DestinationProperty(
    bucket_name="bucketName",
    manifest_key="manifestKey",
    role_arn="roleArn"
)

Attributes

bucket_name

The name of an S3 bucket within which harvested content will be exported.

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

manifest_key

The key in the specified S3 bucket where the harvested top-level manifest will be placed.

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

role_arn

The IAM role used to write to the specified S3 bucket.

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