awsmediaconvert

package
v1.140.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 20, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnJobTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnJobTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnJobTemplate_IsCfnElement 

func CfnJobTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnJobTemplate_IsCfnResource 

func CfnJobTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnJobTemplate_IsConstruct 

func CfnJobTemplate_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPreset_CFN_RESOURCE_TYPE_NAME 

func CfnPreset_CFN_RESOURCE_TYPE_NAME() *string

func CfnPreset_IsCfnElement 

func CfnPreset_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPreset_IsCfnResource 

func CfnPreset_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPreset_IsConstruct 

func CfnPreset_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnQueue_CFN_RESOURCE_TYPE_NAME 

func CfnQueue_CFN_RESOURCE_TYPE_NAME() *string

func CfnQueue_IsCfnElement 

func CfnQueue_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnQueue_IsCfnResource 

func CfnQueue_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnQueue_IsConstruct 

func CfnQueue_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnJobTemplate_Override 

func NewCfnJobTemplate_Override(c CfnJobTemplate, scope awscdk.Construct, id *string, props *CfnJobTemplateProps)

Create a new `AWS::MediaConvert::JobTemplate`.

func NewCfnPreset_Override 

func NewCfnPreset_Override(c CfnPreset, scope awscdk.Construct, id *string, props *CfnPresetProps)

Create a new `AWS::MediaConvert::Preset`.

func NewCfnQueue_Override 

func NewCfnQueue_Override(c CfnQueue, scope awscdk.Construct, id *string, props *CfnQueueProps)

Create a new `AWS::MediaConvert::Queue`.

Types

type CfnJobTemplate 

type CfnJobTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccelerationSettings() interface{}
	SetAccelerationSettings(val interface{})
	AttrArn() *string
	AttrName() *string
	Category() *string
	SetCategory(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	HopDestinations() interface{}
	SetHopDestinations(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Priority() *float64
	SetPriority(val *float64)
	Queue() *string
	SetQueue(val *string)
	Ref() *string
	SettingsJson() interface{}
	SetSettingsJson(val interface{})
	Stack() awscdk.Stack
	StatusUpdateInterval() *string
	SetStatusUpdateInterval(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConvert::JobTemplate`.

The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.

When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating a job template model for the `SettingsJson` property, see the Remarks section later in this topic.

For information about job templates, see [Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) in the ** .

TODO: EXAMPLE

func NewCfnJobTemplate 

func NewCfnJobTemplate(scope awscdk.Construct, id *string, props *CfnJobTemplateProps) CfnJobTemplate

Create a new `AWS::MediaConvert::JobTemplate`.

type CfnJobTemplateProps 

type CfnJobTemplateProps struct {
	// Specify, in JSON format, the transcoding job settings for this job template.
	//
	// This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic.
	//
	// For more information about MediaConvert job templates, see [Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) in the ** .
	SettingsJson interface{} `json:"settingsJson" yaml:"settingsJson"`
	// Accelerated transcoding can significantly speed up jobs with long, visually complex content.
	//
	// Outputs that use this feature incur pro-tier pricing. For information about feature limitations, For more information, see [Job Limitations for Accelerated Transcoding in AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/job-requirements.html) in the *AWS Elemental MediaConvert User Guide* .
	AccelerationSettings interface{} `json:"accelerationSettings" yaml:"accelerationSettings"`
	// Optional.
	//
	// A category for the job template you are creating
	Category *string `json:"category" yaml:"category"`
	// Optional.
	//
	// A description of the job template you are creating.
	Description *string `json:"description" yaml:"description"`
	// Optional.
	//
	// Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed. For more information, see [Setting Up Queue Hopping to Avoid Long Waits](https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-queue-hopping-to-avoid-long-waits.html) in the *AWS Elemental MediaConvert User Guide* .
	HopDestinations interface{} `json:"hopDestinations" yaml:"hopDestinations"`
	// The name of the job template you are creating.
	Name *string `json:"name" yaml:"name"`
	// Specify the relative priority for this job.
	//
	// In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. Minimum: -50 Maximum: 50
	Priority *float64 `json:"priority" yaml:"priority"`
	// Optional.
	//
	// The queue that jobs created from this template are assigned to. Specify the Amazon Resource Name (ARN) of the queue. For example, arn:aws:mediaconvert:us-west-2:505474453218:queues/Default. If you don't specify this, jobs will go to the default queue.
	Queue *string `json:"queue" yaml:"queue"`
	// Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
	//
	// Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
	//
	// Specify one of the following enums:
	//
	// SECONDS_10
	//
	// SECONDS_12
	//
	// SECONDS_15
	//
	// SECONDS_20
	//
	// SECONDS_30
	//
	// SECONDS_60
	//
	// SECONDS_120
	//
	// SECONDS_180
	//
	// SECONDS_240
	//
	// SECONDS_300
	//
	// SECONDS_360
	//
	// SECONDS_420
	//
	// SECONDS_480
	//
	// SECONDS_540
	//
	// SECONDS_600
	StatusUpdateInterval *string `json:"statusUpdateInterval" yaml:"statusUpdateInterval"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnJobTemplate`.

TODO: EXAMPLE

type CfnJobTemplate_AccelerationSettingsProperty 

type CfnJobTemplate_AccelerationSettingsProperty struct {
	// Specify the conditions when the service will run your job with accelerated transcoding.
	Mode *string `json:"mode" yaml:"mode"`
}

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

Outputs that use this feature incur pro-tier pricing. For information about feature limitations, For more information, see [Job Limitations for Accelerated Transcoding in AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/job-requirements.html) in the *AWS Elemental MediaConvert User Guide* .

TODO: EXAMPLE

type CfnJobTemplate_HopDestinationProperty 

type CfnJobTemplate_HopDestinationProperty struct {
	// Optional.
	//
	// When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.
	Priority *float64 `json:"priority" yaml:"priority"`
	// Optional unless the job is submitted on the default queue.
	//
	// When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue.
	Queue *string `json:"queue" yaml:"queue"`
	// Required for setting up a job to use queue hopping.
	//
	// Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive.
	WaitMinutes *float64 `json:"waitMinutes" yaml:"waitMinutes"`
}

Optional.

Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed. For more information, see [Setting Up Queue Hopping to Avoid Long Waits](https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-queue-hopping-to-avoid-long-waits.html) in the *AWS Elemental MediaConvert User Guide* .

TODO: EXAMPLE

type CfnPreset 

type CfnPreset interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrName() *string
	Category() *string
	SetCategory(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	SettingsJson() interface{}
	SetSettingsJson(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConvert::Preset`.

The AWS::MediaConvert::Preset resource is an AWS Elemental MediaConvert resource type that you can use to specify encoding settings for a single output in a transcoding job.

When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating an output preset model for the `SettingsJson` property, see the Remarks section later in this topic.

For more information about output MediaConvert presets, see [Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) in the ** .

TODO: EXAMPLE

func NewCfnPreset 

func NewCfnPreset(scope awscdk.Construct, id *string, props *CfnPresetProps) CfnPreset

Create a new `AWS::MediaConvert::Preset`.

type CfnPresetProps 

type CfnPresetProps struct {
	// Specify, in JSON format, the transcoding job settings for this output preset.
	//
	// This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic.
	//
	// For more information about MediaConvert output presets, see [Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) in the ** .
	SettingsJson interface{} `json:"settingsJson" yaml:"settingsJson"`
	// The new category for the preset, if you are changing it.
	Category *string `json:"category" yaml:"category"`
	// The new description for the preset, if you are changing it.
	Description *string `json:"description" yaml:"description"`
	// The name of the preset that you are modifying.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnPreset`.

TODO: EXAMPLE

type CfnQueue 

type CfnQueue interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	PricingPlan() *string
	SetPricingPlan(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConvert::Queue`.

The AWS::MediaConvert::Queue resource is an AWS Elemental MediaConvert resource type that you can use to manage the resources that are available to your account for parallel processing of jobs. For more information about queues, see [Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) in the ** .

TODO: EXAMPLE

func NewCfnQueue 

func NewCfnQueue(scope awscdk.Construct, id *string, props *CfnQueueProps) CfnQueue

Create a new `AWS::MediaConvert::Queue`.

type CfnQueueProps 

type CfnQueueProps struct {
	// Optional.
	//
	// A description of the queue that you are creating.
	Description *string `json:"description" yaml:"description"`
	// The name of the queue that you are creating.
	Name *string `json:"name" yaml:"name"`
	// When you use AWS CloudFormation , you can create only on-demand queues.
	//
	// Therefore, always set `PricingPlan` to the value "ON_DEMAND" when declaring an AWS::MediaConvert::Queue in your AWS CloudFormation template.
	//
	// To create a reserved queue, use the AWS Elemental MediaConvert console at https://console.aws.amazon.com/mediaconvert to set up a contract. For more information, see [Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) in the ** .
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
	// Initial state of the queue.
	//
	// Queues can be either ACTIVE or PAUSED. If you create a paused queue, then jobs that you send to that queue won't begin.
	Status *string `json:"status" yaml:"status"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnQueue`.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.