Class: AWSCDK::MediaPackagev2::CfnOriginEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSMediapackagev2::IOriginEndpointRef
Defined in:
media_packagev2/cfn_origin_endpoint.rb

Overview

Specifies the configuration parameters for a MediaPackage V2 origin endpoint.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnOriginEndpoint

Create a new AWS::MediaPackageV2::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::MediaPackagev2::CfnOriginEndpointProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdldjIuQ2ZuT3JpZ2luRW5kcG9pbnRQcm9wcyJ9")), "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) 


91
92
93
94
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 91

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 198

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_mediapackagev2.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) 


100
101
102
103
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 100

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_mediapackagev2.CfnOriginEndpoint", "isCfnOriginEndpoint", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
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
87
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 26

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_dash_manifest_urls => { kind: :property, name: "attrDashManifestUrls", is_optional: false },
    :attr_hls_manifest_urls => { kind: :property, name: "attrHlsManifestUrls", is_optional: false },
    :attr_low_latency_hls_manifest_urls => { kind: :property, name: "attrLowLatencyHlsManifestUrls", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_mss_manifest_urls => { kind: :property, name: "attrMssManifestUrls", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :origin_endpoint_ref => { kind: :property, name: "originEndpointRef", is_optional: false },
    :channel_group_name => { kind: :property, name: "channelGroupName", is_optional: false },
    :channel_name => { kind: :property, name: "channelName", is_optional: false },
    :container_type => { kind: :property, name: "containerType", is_optional: false },
    :origin_endpoint_name => { kind: :property, name: "originEndpointName", is_optional: false },
    :dash_manifests => { kind: :property, name: "dashManifests", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :force_endpoint_error_configuration => { kind: :property, name: "forceEndpointErrorConfiguration", is_optional: true },
    :hls_manifests => { kind: :property, name: "hlsManifests", is_optional: true },
    :low_latency_hls_manifests => { kind: :property, name: "lowLatencyHlsManifests", is_optional: true },
    :mss_manifests => { kind: :property, name: "mssManifests", is_optional: true },
    :segment => { kind: :property, name: "segment", is_optional: true },
    :startover_window_seconds => { kind: :property, name: "startoverWindowSeconds", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :uri_separator => { kind: :property, name: "uriSeparator", 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.



468
469
470
471
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 468

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:



480
481
482
483
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 480

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:



490
491
492
493
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 490

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:



501
502
503
504
505
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 501

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.


558
559
560
561
562
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 558

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.



568
569
570
571
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 568

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.



580
581
582
583
584
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 580

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:



593
594
595
596
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 593

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:



615
616
617
618
619
620
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 615

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 origin endpoint.

Returns:

  • (String) 


205
206
207
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 205

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The timestamp of the creation of the origin endpoint.

Returns:

  • (String) 


212
213
214
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 212

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_dash_manifest_urls ⇒ Array<String>

The egress domain URL for stream delivery from MediaPackage.

Returns:

  • (Array<String>) 


219
220
221
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 219

def attr_dash_manifest_urls()
  jsii_get_property("attrDashManifestUrls")
end

#attr_hls_manifest_urls ⇒ Array<String>

The egress domain URL for stream delivery from MediaPackage.

Returns:

  • (Array<String>) 


226
227
228
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 226

def attr_hls_manifest_urls()
  jsii_get_property("attrHlsManifestUrls")
end

#attr_low_latency_hls_manifest_urls ⇒ Array<String>

The egress domain URL for stream delivery from MediaPackage.

Returns:

  • (Array<String>) 


233
234
235
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 233

def attr_low_latency_hls_manifest_urls()
  jsii_get_property("attrLowLatencyHlsManifestUrls")
end

#attr_modified_at ⇒ String

The timestamp of the modification of the origin endpoint.

Returns:

  • (String) 


240
241
242
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 240

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_mss_manifest_urls ⇒ Array<String>

Returns:

  • (Array<String>) 


245
246
247
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 245

def attr_mss_manifest_urls()
  jsii_get_property("attrMssManifestUrls")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



252
253
254
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 252

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



151
152
153
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


624
625
626
627
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 624

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


161
162
163
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#channel_group_name ⇒ String

The name of the channel group associated with the origin endpoint configuration.

Returns:

  • (String) 


266
267
268
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 266

def channel_group_name()
  jsii_get_property("channelGroupName")
end

#channel_group_name=(value) ⇒ Object 



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

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

#channel_name ⇒ String

The channel name associated with the origin endpoint.

Returns:

  • (String) 


278
279
280
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 278

def channel_name()
  jsii_get_property("channelName")
end

#channel_name=(value) ⇒ Object 



282
283
284
285
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 282

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

#container_type ⇒ String

The container type associated with the origin endpoint configuration.

Returns:

  • (String) 


290
291
292
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 290

def container_type()
  jsii_get_property("containerType")
end

#container_type=(value) ⇒ Object 



294
295
296
297
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 294

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#dash_manifests ⇒ AWSCDK::IResolvable, ...

A DASH manifest configuration.

Returns:



314
315
316
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 314

def dash_manifests()
  jsii_get_property("dashManifests")
end

#dash_manifests=(value) ⇒ Object 



318
319
320
321
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 318

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

#description ⇒ String?

The description associated with the origin endpoint.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



330
331
332
333
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 330

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:



173
174
175
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 173

def env()
  jsii_get_property("env")
end

#force_endpoint_error_configuration ⇒ AWSCDK::IResolvable, ...

The failover settings for the endpoint.

Returns:



338
339
340
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 338

def force_endpoint_error_configuration()
  jsii_get_property("forceEndpointErrorConfiguration")
end

#force_endpoint_error_configuration=(value) ⇒ Object 



342
343
344
345
346
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 342

def force_endpoint_error_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::ForceEndpointErrorConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5Gb3JjZUVuZHBvaW50RXJyb3JDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "forceEndpointErrorConfiguration") unless value.nil?
  jsii_set_property("forceEndpointErrorConfiguration", value)
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:



637
638
639
640
641
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 637

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:



648
649
650
651
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 648

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

#hls_manifests ⇒ AWSCDK::IResolvable, ...

The HLS manifests associated with the origin endpoint configuration.

Returns:



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

def hls_manifests()
  jsii_get_property("hlsManifests")
end

#hls_manifests=(value) ⇒ Object 



355
356
357
358
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 355

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



718
719
720
721
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 718

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) 


125
126
127
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#low_latency_hls_manifests ⇒ AWSCDK::IResolvable, ...

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

Returns:



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

def low_latency_hls_manifests()
  jsii_get_property("lowLatencyHlsManifests")
end

#low_latency_hls_manifests=(value) ⇒ Object 



367
368
369
370
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 367

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

#mss_manifests ⇒ AWSCDK::IResolvable, ...

A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.

Returns:



375
376
377
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 375

def mss_manifests()
  jsii_get_property("mssManifests")
end

#mss_manifests=(value) ⇒ Object 



379
380
381
382
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 379

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 108

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:



659
660
661
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 659

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:



666
667
668
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 666

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

#origin_endpoint_name ⇒ String

The name of the origin endpoint associated with the origin endpoint configuration.

Returns:

  • (String) 


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

def origin_endpoint_name()
  jsii_get_property("originEndpointName")
end

#origin_endpoint_name=(value) ⇒ Object 



306
307
308
309
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 306

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

#origin_endpoint_ref ⇒ AWSCDK::Interfaces::AWSMediapackagev2::OriginEndpointReference

A reference to a OriginEndpoint resource.

Returns:



259
260
261
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 259

def origin_endpoint_ref()
  jsii_get_property("originEndpointRef")
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.



459
460
461
462
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 459

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) 


144
145
146
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 144

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:



677
678
679
680
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 677

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


684
685
686
687
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 684

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:



694
695
696
697
698
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 694

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

#segment ⇒ AWSCDK::IResolvable, ...

The segment associated with the origin endpoint.

Returns:



387
388
389
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 387

def segment()
  jsii_get_property("segment")
end

#segment=(value) ⇒ Object 



391
392
393
394
395
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 391

def segment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::SegmentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5TZWdtZW50UHJvcGVydHkifV19fQ==")), "segment") unless value.nil?
  jsii_set_property("segment", 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.



703
704
705
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 703

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:



134
135
136
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 134

def stack()
  jsii_get_property("stack")
end

#startover_window_seconds ⇒ Numeric?

The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.

Returns:

  • (Numeric, nil) 


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

def startover_window_seconds()
  jsii_get_property("startoverWindowSeconds")
end

#startover_window_seconds=(value) ⇒ Object 



404
405
406
407
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 404

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 ⇒ Array<AWSCDK::CfnTag>?

The tags associated with the origin endpoint.

Returns:



412
413
414
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 412

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



416
417
418
419
420
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 416

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



435
436
437
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 435

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


181
182
183
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 181

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


191
192
193
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#uri_separator ⇒ String?

Returns:

  • (String, nil) 


423
424
425
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 423

def uri_separator()
  jsii_get_property("uriSeparator")
end

#uri_separator=(value) ⇒ Object 



427
428
429
430
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 427

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


709
710
711
712
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 709

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) 


448
449
450
451
452
453
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 448

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