Class: AWSCDK::MediaPackage::CfnOriginEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSMediapackage::IOriginEndpointRef
Defined in:
media_package/cfn_origin_endpoint.rb

Overview

Create an endpoint on an AWS Elemental MediaPackage channel.

An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.

After it's created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnOriginEndpoint

Create a new AWS::MediaPackage::OriginEndpoint.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::MediaPackage::CfnOriginEndpointProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'media_package/cfn_origin_endpoint.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpointProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdlLkNmbk9yaWdpbkVuZHBvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_origin_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'media_package/cfn_origin_endpoint.rb', line 90

def self.arn_for_origin_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYXBhY2thZ2UuSU9yaWdpbkVuZHBvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediapackage.CfnOriginEndpoint", "arnForOriginEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'media_package/cfn_origin_endpoint.rb', line 197

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

.is_cfn_origin_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnOriginEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'media_package/cfn_origin_endpoint.rb', line 99

def self.is_cfn_origin_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediapackage.CfnOriginEndpoint", "isCfnOriginEndpoint", [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
84
85
86
 
# File 'media_package/cfn_origin_endpoint.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_url => { kind: :property, name: "attrUrl", is_optional: false },
    :origin_endpoint_ref => { kind: :property, name: "originEndpointRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :channel_id => { kind: :property, name: "channelId", is_optional: false },
    :id => { kind: :property, name: "id", is_optional: false },
    :authorization => { kind: :property, name: "authorization", is_optional: true },
    :cmaf_package => { kind: :property, name: "cmafPackage", is_optional: true },
    :dash_package => { kind: :property, name: "dashPackage", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :hls_package => { kind: :property, name: "hlsPackage", is_optional: true },
    :manifest_name => { kind: :property, name: "manifestName", is_optional: true },
    :mss_package => { kind: :property, name: "mssPackage", is_optional: true },
    :origination => { kind: :property, name: "origination", is_optional: true },
    :startover_window_seconds => { kind: :property, name: "startoverWindowSeconds", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :time_delay_seconds => { kind: :property, name: "timeDelaySeconds", is_optional: true },
    :whitelist => { kind: :property, name: "whitelist", 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

#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.



441
442
443
444
 
# File 'media_package/cfn_origin_endpoint.rb', line 441

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:



453
454
455
456
 
# File 'media_package/cfn_origin_endpoint.rb', line 453

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:



463
464
465
466
 
# File 'media_package/cfn_origin_endpoint.rb', line 463

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:



474
475
476
477
478
 
# File 'media_package/cfn_origin_endpoint.rb', line 474

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.


531
532
533
534
535
 
# File 'media_package/cfn_origin_endpoint.rb', line 531

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.



541
542
543
544
 
# File 'media_package/cfn_origin_endpoint.rb', line 541

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.



553
554
555
556
557
 
# File 'media_package/cfn_origin_endpoint.rb', line 553

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:



566
567
568
569
 
# File 'media_package/cfn_origin_endpoint.rb', line 566

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:



588
589
590
591
592
593
 
# File 'media_package/cfn_origin_endpoint.rb', line 588

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 endpoint's unique system-generated resource name, based on the AWS record.

Returns:

  • (String) 


204
205
206
 
# File 'media_package/cfn_origin_endpoint.rb', line 204

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_url ⇒ String

URL for the key provider’s key retrieval API endpoint.

Must start with https://.

Returns:

  • (String) 


213
214
215
 
# File 'media_package/cfn_origin_endpoint.rb', line 213

def attr_url()
  jsii_get_property("attrUrl")
end

#authorization ⇒ AWSCDK::IResolvable, ...

Parameters for CDN authorization.

Returns:



258
259
260
 
# File 'media_package/cfn_origin_endpoint.rb', line 258

def authorization()
  jsii_get_property("authorization")
end

#authorization=(value) ⇒ Object 



262
263
264
265
266
 
# File 'media_package/cfn_origin_endpoint.rb', line 262

def authorization=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpoint::AuthorizationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2UuQ2ZuT3JpZ2luRW5kcG9pbnQuQXV0aG9yaXphdGlvblByb3BlcnR5In1dfX0=")), "authorization") unless value.nil?
  jsii_set_property("authorization", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



150
151
152
 
# File 'media_package/cfn_origin_endpoint.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'media_package/cfn_origin_endpoint.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


597
598
599
600
 
# File 'media_package/cfn_origin_endpoint.rb', line 597

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}) 


160
161
162
 
# File 'media_package/cfn_origin_endpoint.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'media_package/cfn_origin_endpoint.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#channel_id ⇒ String

The ID of the channel associated with this endpoint.

Returns:

  • (String) 


234
235
236
 
# File 'media_package/cfn_origin_endpoint.rb', line 234

def channel_id()
  jsii_get_property("channelId")
end

#channel_id=(value) ⇒ Object 



238
239
240
241
 
# File 'media_package/cfn_origin_endpoint.rb', line 238

def channel_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelId")
  jsii_set_property("channelId", value)
end

#cmaf_package ⇒ AWSCDK::IResolvable, ...

Parameters for Common Media Application Format (CMAF) packaging.

Returns:



271
272
273
 
# File 'media_package/cfn_origin_endpoint.rb', line 271

def cmaf_package()
  jsii_get_property("cmafPackage")
end

#cmaf_package=(value) ⇒ Object 



275
276
277
278
279
 
# File 'media_package/cfn_origin_endpoint.rb', line 275

def cmaf_package=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpoint::CmafPackageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2UuQ2ZuT3JpZ2luRW5kcG9pbnQuQ21hZlBhY2thZ2VQcm9wZXJ0eSJ9XX19")), "cmafPackage") unless value.nil?
  jsii_set_property("cmafPackage", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'media_package/cfn_origin_endpoint.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#dash_package ⇒ AWSCDK::IResolvable, ...

Parameters for DASH packaging.

Returns:



284
285
286
 
# File 'media_package/cfn_origin_endpoint.rb', line 284

def dash_package()
  jsii_get_property("dashPackage")
end

#dash_package=(value) ⇒ Object 



288
289
290
291
292
 
# File 'media_package/cfn_origin_endpoint.rb', line 288

def dash_package=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpoint::DashPackageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2UuQ2ZuT3JpZ2luRW5kcG9pbnQuRGFzaFBhY2thZ2VQcm9wZXJ0eSJ9XX19")), "dashPackage") unless value.nil?
  jsii_set_property("dashPackage", value)
end

#description ⇒ String?

Any descriptive information that you want to add to the endpoint for future identification purposes.

Returns:

  • (String, nil) 


297
298
299
 
# File 'media_package/cfn_origin_endpoint.rb', line 297

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



301
302
303
304
 
# File 'media_package/cfn_origin_endpoint.rb', line 301

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:



172
173
174
 
# File 'media_package/cfn_origin_endpoint.rb', line 172

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:



610
611
612
613
614
 
# File 'media_package/cfn_origin_endpoint.rb', line 610

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:



621
622
623
624
 
# File 'media_package/cfn_origin_endpoint.rb', line 621

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

#hls_package ⇒ AWSCDK::IResolvable, ...

Parameters for Apple HLS packaging.

Returns:



309
310
311
 
# File 'media_package/cfn_origin_endpoint.rb', line 309

def hls_package()
  jsii_get_property("hlsPackage")
end

#hls_package=(value) ⇒ Object 



313
314
315
316
317
 
# File 'media_package/cfn_origin_endpoint.rb', line 313

def hls_package=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpoint::HlsPackageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2UuQ2ZuT3JpZ2luRW5kcG9pbnQuSGxzUGFja2FnZVByb3BlcnR5In1dfX0=")), "hlsPackage") unless value.nil?
  jsii_set_property("hlsPackage", value)
end

#id ⇒ String

The manifest ID is required and must be unique within the OriginEndpoint.

Returns:

  • (String) 


246
247
248
 
# File 'media_package/cfn_origin_endpoint.rb', line 246

def id()
  jsii_get_property("id")
end

#id=(value) ⇒ Object 



250
251
252
253
 
# File 'media_package/cfn_origin_endpoint.rb', line 250

def id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  jsii_set_property("id", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



691
692
693
694
 
# File 'media_package/cfn_origin_endpoint.rb', line 691

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


124
125
126
 
# File 'media_package/cfn_origin_endpoint.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#manifest_name ⇒ String?

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

Returns:

  • (String, nil) 


322
323
324
 
# File 'media_package/cfn_origin_endpoint.rb', line 322

def manifest_name()
  jsii_get_property("manifestName")
end

#manifest_name=(value) ⇒ Object 



326
327
328
329
 
# File 'media_package/cfn_origin_endpoint.rb', line 326

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

#mss_package ⇒ AWSCDK::IResolvable, ...

Parameters for Microsoft Smooth Streaming packaging.

Returns:



334
335
336
 
# File 'media_package/cfn_origin_endpoint.rb', line 334

def mss_package()
  jsii_get_property("mssPackage")
end

#mss_package=(value) ⇒ Object 



338
339
340
341
342
 
# File 'media_package/cfn_origin_endpoint.rb', line 338

def mss_package=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackage::CfnOriginEndpoint::MssPackageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2UuQ2ZuT3JpZ2luRW5kcG9pbnQuTXNzUGFja2FnZVByb3BlcnR5In1dfX0=")), "mssPackage") unless value.nil?
  jsii_set_property("mssPackage", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


107
108
109
 
# File 'media_package/cfn_origin_endpoint.rb', line 107

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:



632
633
634
 
# File 'media_package/cfn_origin_endpoint.rb', line 632

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:



639
640
641
 
# File 'media_package/cfn_origin_endpoint.rb', line 639

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

#origin_endpoint_ref ⇒ AWSCDK::Interfaces::AWSMediapackage::OriginEndpointReference

A reference to a OriginEndpoint resource.

Returns:



220
221
222
 
# File 'media_package/cfn_origin_endpoint.rb', line 220

def origin_endpoint_ref()
  jsii_get_property("originEndpointRef")
end

#origination ⇒ String?

Controls video origination from this endpoint.

Returns:

  • (String, nil) 


347
348
349
 
# File 'media_package/cfn_origin_endpoint.rb', line 347

def origination()
  jsii_get_property("origination")
end

#origination=(value) ⇒ Object 



351
352
353
354
 
# File 'media_package/cfn_origin_endpoint.rb', line 351

def origination=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "origination") unless value.nil?
  jsii_set_property("origination", value)
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.



432
433
434
435
 
# File 'media_package/cfn_origin_endpoint.rb', line 432

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

#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) 


143
144
145
 
# File 'media_package/cfn_origin_endpoint.rb', line 143

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:



650
651
652
653
 
# File 'media_package/cfn_origin_endpoint.rb', line 650

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}) 


657
658
659
660
 
# File 'media_package/cfn_origin_endpoint.rb', line 657

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:



667
668
669
670
671
 
# File 'media_package/cfn_origin_endpoint.rb', line 667

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

#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.



676
677
678
 
# File 'media_package/cfn_origin_endpoint.rb', line 676

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:



133
134
135
 
# File 'media_package/cfn_origin_endpoint.rb', line 133

def stack()
  jsii_get_property("stack")
end

#startover_window_seconds ⇒ Numeric?

Maximum duration (seconds) of content to retain for startover playback.

Returns:

  • (Numeric, nil) 


359
360
361
 
# File 'media_package/cfn_origin_endpoint.rb', line 359

def startover_window_seconds()
  jsii_get_property("startoverWindowSeconds")
end

#startover_window_seconds=(value) ⇒ Object 



363
364
365
366
 
# File 'media_package/cfn_origin_endpoint.rb', line 363

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



227
228
229
 
# File 'media_package/cfn_origin_endpoint.rb', line 227

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to assign to the endpoint.

Returns:



371
372
373
 
# File 'media_package/cfn_origin_endpoint.rb', line 371

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



375
376
377
378
379
 
# File 'media_package/cfn_origin_endpoint.rb', line 375

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#time_delay_seconds ⇒ Numeric?

Minimum duration (seconds) of delay to enforce on the playback of live content.

Returns:

  • (Numeric, nil) 


384
385
386
 
# File 'media_package/cfn_origin_endpoint.rb', line 384

def time_delay_seconds()
  jsii_get_property("timeDelaySeconds")
end

#time_delay_seconds=(value) ⇒ Object 



388
389
390
391
 
# File 'media_package/cfn_origin_endpoint.rb', line 388

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



408
409
410
 
# File 'media_package/cfn_origin_endpoint.rb', line 408

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}) 


180
181
182
 
# File 'media_package/cfn_origin_endpoint.rb', line 180

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}) 


190
191
192
 
# File 'media_package/cfn_origin_endpoint.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


682
683
684
685
 
# File 'media_package/cfn_origin_endpoint.rb', line 682

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

#whitelist ⇒ Array<String>?

The IP addresses that can access this endpoint.

Returns:

  • (Array<String>, nil) 


396
397
398
 
# File 'media_package/cfn_origin_endpoint.rb', line 396

def whitelist()
  jsii_get_property("whitelist")
end

#whitelist=(value) ⇒ Object 



400
401
402
403
 
# File 'media_package/cfn_origin_endpoint.rb', line 400

def whitelist=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "whitelist") unless value.nil?
  jsii_set_property("whitelist", value)
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) 


421
422
423
424
425
426
 
# File 'media_package/cfn_origin_endpoint.rb', line 421

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