Class: AWSCDK::MediaConvert::CfnJobTemplate

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSMediaconvert::IJobTemplateRef
Defined in:
media_convert/cfn_job_template.rb

Overview

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 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 in the ** .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnJobTemplate

Create a new AWS::MediaConvert::JobTemplate.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::MediaConvert::CfnJobTemplateProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'media_convert/cfn_job_template.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::MediaConvert::CfnJobTemplateProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFjb252ZXJ0LkNmbkpvYlRlbXBsYXRlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_job_template(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'media_convert/cfn_job_template.rb', line 87

def self.arn_for_job_template(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWNvbnZlcnQuSUpvYlRlbXBsYXRlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconvert.CfnJobTemplate", "arnForJobTemplate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


220
221
222
 
# File 'media_convert/cfn_job_template.rb', line 220

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_mediaconvert.CfnJobTemplate", "CFN_RESOURCE_TYPE_NAME")
end

.from_job_template_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMediaconvert::IJobTemplateRef

Creates a new IJobTemplateRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



98
99
100
101
102
103
 
# File 'media_convert/cfn_job_template.rb', line 98

def self.from_job_template_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconvert.CfnJobTemplate", "fromJobTemplateArn", [scope, id, arn])
end

.from_job_template_name(scope, id, job_template_name) ⇒ AWSCDK::Interfaces::AWSMediaconvert::IJobTemplateRef

Creates a new IJobTemplateRef from a jobTemplateName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • job_template_name (String)

Returns:



111
112
113
114
115
116
 
# File 'media_convert/cfn_job_template.rb', line 111

def self.from_job_template_name(scope, id, job_template_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(job_template_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobTemplateName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconvert.CfnJobTemplate", "fromJobTemplateName", [scope, id, job_template_name])
end

.is_cfn_job_template(x) ⇒ Boolean

Checks whether the given object is a CfnJobTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


122
123
124
125
 
# File 'media_convert/cfn_job_template.rb', line 122

def self.is_cfn_job_template(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconvert.CfnJobTemplate", "isCfnJobTemplate", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'media_convert/cfn_job_template.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :job_template_ref => { kind: :property, name: "jobTemplateRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :settings_json => { kind: :property, name: "settingsJson", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :acceleration_settings => { kind: :property, name: "accelerationSettings", is_optional: true },
    :category => { kind: :property, name: "category", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :hop_destinations => { kind: :property, name: "hopDestinations", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :priority => { kind: :property, name: "priority", is_optional: true },
    :queue => { kind: :property, name: "queue", is_optional: true },
    :status_update_interval => { kind: :property, name: "statusUpdateInterval", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#acceleration_settings ⇒ AWSCDK::IResolvable, ...

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

Returns:



284
285
286
 
# File 'media_convert/cfn_job_template.rb', line 284

def acceleration_settings()
  jsii_get_property("accelerationSettings")
end

#acceleration_settings=(value) ⇒ Object 



288
289
290
291
292
 
# File 'media_convert/cfn_job_template.rb', line 288

def acceleration_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConvert::CfnJobTemplate::AccelerationSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbnZlcnQuQ2ZuSm9iVGVtcGxhdGUuQWNjZWxlcmF0aW9uU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "accelerationSettings") unless value.nil?
  jsii_set_property("accelerationSettings", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



414
415
416
417
 
# File 'media_convert/cfn_job_template.rb', line 414

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



426
427
428
429
 
# File 'media_convert/cfn_job_template.rb', line 426

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



436
437
438
439
 
# File 'media_convert/cfn_job_template.rb', line 436

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



447
448
449
450
451
 
# File 'media_convert/cfn_job_template.rb', line 447

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


504
505
506
507
508
 
# File 'media_convert/cfn_job_template.rb', line 504

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



514
515
516
517
 
# File 'media_convert/cfn_job_template.rb', line 514

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



526
527
528
529
530
 
# File 'media_convert/cfn_job_template.rb', line 526

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



539
540
541
542
 
# File 'media_convert/cfn_job_template.rb', line 539

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



561
562
563
564
565
566
 
# File 'media_convert/cfn_job_template.rb', line 561

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the job template, such as arn:aws:mediaconvert:us-west-2:123456789012 .

Returns:

  • (String) 


227
228
229
 
# File 'media_convert/cfn_job_template.rb', line 227

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

Returns:

  • (String) 


232
233
234
 
# File 'media_convert/cfn_job_template.rb', line 232

def attr_id()
  jsii_get_property("attrId")
end

#attr_name ⇒ String

The name of the job template, such as Streaming stack DASH .

Returns:

  • (String) 


239
240
241
 
# File 'media_convert/cfn_job_template.rb', line 239

def attr_name()
  jsii_get_property("attrName")
end

#category ⇒ String?

Optional.

Returns:

  • (String, nil) 


297
298
299
 
# File 'media_convert/cfn_job_template.rb', line 297

def category()
  jsii_get_property("category")
end

#category=(value) ⇒ Object 



301
302
303
304
 
# File 'media_convert/cfn_job_template.rb', line 301

def category=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "category") unless value.nil?
  jsii_set_property("category", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



173
174
175
 
# File 'media_convert/cfn_job_template.rb', line 173

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'media_convert/cfn_job_template.rb', line 178

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


570
571
572
573
 
# File 'media_convert/cfn_job_template.rb', line 570

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


183
184
185
 
# File 'media_convert/cfn_job_template.rb', line 183

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


190
191
192
 
# File 'media_convert/cfn_job_template.rb', line 190

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


135
136
137
 
# File 'media_convert/cfn_job_template.rb', line 135

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

Optional.

Returns:

  • (String, nil) 


309
310
311
 
# File 'media_convert/cfn_job_template.rb', line 309

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



313
314
315
316
 
# File 'media_convert/cfn_job_template.rb', line 313

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



195
196
197
 
# File 'media_convert/cfn_job_template.rb', line 195

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



583
584
585
586
587
 
# File 'media_convert/cfn_job_template.rb', line 583

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



594
595
596
597
 
# File 'media_convert/cfn_job_template.rb', line 594

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#hop_destinations ⇒ AWSCDK::IResolvable, ...

Optional.

Returns:



321
322
323
 
# File 'media_convert/cfn_job_template.rb', line 321

def hop_destinations()
  jsii_get_property("hopDestinations")
end

#hop_destinations=(value) ⇒ Object 



325
326
327
328
 
# File 'media_convert/cfn_job_template.rb', line 325

def hop_destinations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFjb252ZXJ0LkNmbkpvYlRlbXBsYXRlLkhvcERlc3RpbmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "hopDestinations") unless value.nil?
  jsii_set_property("hopDestinations", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



664
665
666
667
 
# File 'media_convert/cfn_job_template.rb', line 664

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#job_template_ref ⇒ AWSCDK::Interfaces::AWSMediaconvert::JobTemplateReference

A reference to a JobTemplate resource.

Returns:



246
247
248
 
# File 'media_convert/cfn_job_template.rb', line 246

def job_template_ref()
  jsii_get_property("jobTemplateRef")
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


147
148
149
 
# File 'media_convert/cfn_job_template.rb', line 147

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

Name of the output group.

Returns:

  • (String, nil) 


333
334
335
 
# File 'media_convert/cfn_job_template.rb', line 333

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



337
338
339
340
 
# File 'media_convert/cfn_job_template.rb', line 337

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


130
131
132
 
# File 'media_convert/cfn_job_template.rb', line 130

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



605
606
607
 
# File 'media_convert/cfn_job_template.rb', line 605

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



612
613
614
 
# File 'media_convert/cfn_job_template.rb', line 612

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



405
406
407
408
 
# File 'media_convert/cfn_job_template.rb', line 405

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#priority ⇒ Numeric?

Specify the relative priority for this job.

Returns:

  • (Numeric, nil) 


345
346
347
 
# File 'media_convert/cfn_job_template.rb', line 345

def priority()
  jsii_get_property("priority")
end

#priority=(value) ⇒ Object 



349
350
351
352
 
# File 'media_convert/cfn_job_template.rb', line 349

def priority=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless value.nil?
  jsii_set_property("priority", value)
end

#queue ⇒ String?

Optional.

Returns:

  • (String, nil) 


357
358
359
 
# File 'media_convert/cfn_job_template.rb', line 357

def queue()
  jsii_get_property("queue")
end

#queue=(value) ⇒ Object 



361
362
363
364
 
# File 'media_convert/cfn_job_template.rb', line 361

def queue=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queue") unless value.nil?
  jsii_set_property("queue", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


166
167
168
 
# File 'media_convert/cfn_job_template.rb', line 166

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



623
624
625
626
 
# File 'media_convert/cfn_job_template.rb', line 623

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


630
631
632
633
 
# File 'media_convert/cfn_job_template.rb', line 630

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



640
641
642
643
644
 
# File 'media_convert/cfn_job_template.rb', line 640

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#settings_json ⇒ Object

Specify, in JSON format, the transcoding job settings for this job template.

Returns:

  • (Object) 


260
261
262
 
# File 'media_convert/cfn_job_template.rb', line 260

def settings_json()
  jsii_get_property("settingsJson")
end

#settings_json=(value) ⇒ Object 



264
265
266
267
 
# File 'media_convert/cfn_job_template.rb', line 264

def settings_json=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "settingsJson")
  jsii_set_property("settingsJson", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



649
650
651
 
# File 'media_convert/cfn_job_template.rb', line 649

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



156
157
158
 
# File 'media_convert/cfn_job_template.rb', line 156

def stack()
  jsii_get_property("stack")
end

#status_update_interval ⇒ String?

Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

Returns:

  • (String, nil) 


369
370
371
 
# File 'media_convert/cfn_job_template.rb', line 369

def status_update_interval()
  jsii_get_property("statusUpdateInterval")
end

#status_update_interval=(value) ⇒ Object 



373
374
375
376
 
# File 'media_convert/cfn_job_template.rb', line 373

def status_update_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statusUpdateInterval") unless value.nil?
  jsii_set_property("statusUpdateInterval", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



253
254
255
 
# File 'media_convert/cfn_job_template.rb', line 253

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

An array of key-value pairs to apply to this resource.

Returns:

  • (Object) 


272
273
274
 
# File 'media_convert/cfn_job_template.rb', line 272

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



276
277
278
279
 
# File 'media_convert/cfn_job_template.rb', line 276

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



381
382
383
 
# File 'media_convert/cfn_job_template.rb', line 381

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


203
204
205
 
# File 'media_convert/cfn_job_template.rb', line 203

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


213
214
215
 
# File 'media_convert/cfn_job_template.rb', line 213

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


655
656
657
658
 
# File 'media_convert/cfn_job_template.rb', line 655

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


394
395
396
397
398
399
 
# File 'media_convert/cfn_job_template.rb', line 394

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end