Documentation ¶
Index ¶
- func CfnChannelGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannelGroup_IsCfnElement(x interface{}) *bool
- func CfnChannelGroup_IsCfnResource(x interface{}) *bool
- func CfnChannelGroup_IsConstruct(x interface{}) *bool
- func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannelPolicy_IsCfnElement(x interface{}) *bool
- func CfnChannelPolicy_IsCfnResource(x interface{}) *bool
- func CfnChannelPolicy_IsConstruct(x interface{}) *bool
- func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannel_IsCfnElement(x interface{}) *bool
- func CfnChannel_IsCfnResource(x interface{}) *bool
- func CfnChannel_IsConstruct(x interface{}) *bool
- func CfnOriginEndpointPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOriginEndpointPolicy_IsCfnElement(x interface{}) *bool
- func CfnOriginEndpointPolicy_IsCfnResource(x interface{}) *bool
- func CfnOriginEndpointPolicy_IsConstruct(x interface{}) *bool
- func CfnOriginEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOriginEndpoint_IsCfnElement(x interface{}) *bool
- func CfnOriginEndpoint_IsCfnResource(x interface{}) *bool
- func CfnOriginEndpoint_IsConstruct(x interface{}) *bool
- func NewCfnChannelGroup_Override(c CfnChannelGroup, scope constructs.Construct, id *string, ...)
- func NewCfnChannelPolicy_Override(c CfnChannelPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
- func NewCfnOriginEndpointPolicy_Override(c CfnOriginEndpointPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnOriginEndpoint_Override(c CfnOriginEndpoint, scope constructs.Construct, id *string, ...)
- type CfnChannel
- type CfnChannelGroup
- type CfnChannelGroupProps
- type CfnChannelPolicy
- type CfnChannelPolicyProps
- type CfnChannelProps
- type CfnChannel_IngestEndpointProperty
- type CfnOriginEndpoint
- type CfnOriginEndpointPolicy
- type CfnOriginEndpointPolicyProps
- type CfnOriginEndpointProps
- type CfnOriginEndpoint_DashManifestConfigurationProperty
- type CfnOriginEndpoint_DashUtcTimingProperty
- type CfnOriginEndpoint_EncryptionContractConfigurationProperty
- type CfnOriginEndpoint_EncryptionMethodProperty
- type CfnOriginEndpoint_EncryptionProperty
- type CfnOriginEndpoint_FilterConfigurationProperty
- type CfnOriginEndpoint_ForceEndpointErrorConfigurationProperty
- type CfnOriginEndpoint_HlsManifestConfigurationProperty
- type CfnOriginEndpoint_LowLatencyHlsManifestConfigurationProperty
- type CfnOriginEndpoint_ScteDashProperty
- type CfnOriginEndpoint_ScteHlsProperty
- type CfnOriginEndpoint_ScteProperty
- type CfnOriginEndpoint_SegmentProperty
- type CfnOriginEndpoint_SpekeKeyProviderProperty
- type CfnOriginEndpoint_StartTagProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnChannelGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnChannelGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnChannelGroup_IsCfnElement ¶
func CfnChannelGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnChannelGroup_IsCfnResource ¶
func CfnChannelGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnChannelGroup_IsConstruct ¶
func CfnChannelGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnChannelPolicy_IsCfnElement ¶
func CfnChannelPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnChannelPolicy_IsCfnResource ¶
func CfnChannelPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnChannelPolicy_IsConstruct ¶
func CfnChannelPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnChannel_CFN_RESOURCE_TYPE_NAME ¶
func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string
func CfnChannel_IsCfnElement ¶
func CfnChannel_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnChannel_IsCfnResource ¶
func CfnChannel_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnChannel_IsConstruct ¶
func CfnChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnOriginEndpointPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnOriginEndpointPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnOriginEndpointPolicy_IsCfnElement ¶
func CfnOriginEndpointPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnOriginEndpointPolicy_IsCfnResource ¶
func CfnOriginEndpointPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnOriginEndpointPolicy_IsConstruct ¶
func CfnOriginEndpointPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnOriginEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnOriginEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnOriginEndpoint_IsCfnElement ¶
func CfnOriginEndpoint_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnOriginEndpoint_IsCfnResource ¶
func CfnOriginEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnOriginEndpoint_IsConstruct ¶
func CfnOriginEndpoint_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnChannelGroup_Override ¶
func NewCfnChannelGroup_Override(c CfnChannelGroup, scope constructs.Construct, id *string, props *CfnChannelGroupProps)
func NewCfnChannelPolicy_Override ¶
func NewCfnChannelPolicy_Override(c CfnChannelPolicy, scope constructs.Construct, id *string, props *CfnChannelPolicyProps)
func NewCfnChannel_Override ¶
func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
func NewCfnOriginEndpointPolicy_Override ¶
func NewCfnOriginEndpointPolicy_Override(c CfnOriginEndpointPolicy, scope constructs.Construct, id *string, props *CfnOriginEndpointPolicyProps)
func NewCfnOriginEndpoint_Override ¶
func NewCfnOriginEndpoint_Override(c CfnOriginEndpoint, scope constructs.Construct, id *string, props *CfnOriginEndpointProps)
Types ¶
type CfnChannel ¶
type CfnChannel interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the channel. AttrArn() *string // The timestamp of the ccreation of the channel. AttrCreatedAt() *string // The ingest endpoints associated with the channel. AttrIngestEndpoints() awscdk.IResolvable AttrIngestEndpointUrls() *[]*string // The timestamp of the modification of the channel. AttrModifiedAt() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the channel group associated with the channel configuration. ChannelGroupName() *string SetChannelGroupName(val *string) // The name of the channel. ChannelName() *string SetChannelName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the channel. Description() *string SetDescription(val *string) // The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. InputType() *string SetInputType(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags associated with the channel. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a channel to receive content.
After it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnChannel := awscdk.Aws_mediapackagev2.NewCfnChannel(this, jsii.String("MyCfnChannel"), &CfnChannelProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), // the properties below are optional Description: jsii.String("description"), InputType: jsii.String("inputType"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnChannel ¶
func NewCfnChannel(scope constructs.Construct, id *string, props *CfnChannelProps) CfnChannel
type CfnChannelGroup ¶
type CfnChannelGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the channel group. AttrArn() *string // The timestamp of the creation of the channel group. AttrCreatedAt() *string // The egress domain of the channel group. AttrEgressDomain() *string // The timestamp of the modification of the channel group. AttrModifiedAt() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the channel group. ChannelGroupName() *string SetChannelGroupName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The configuration for a MediaPackage V2 channel group. Description() *string SetDescription(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags associated with the channel group. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Specifies the configuraiton for a MediaPackage V2 channel group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnChannelGroup := awscdk.Aws_mediapackagev2.NewCfnChannelGroup(this, jsii.String("MyCfnChannelGroup"), &CfnChannelGroupProps{ ChannelGroupName: jsii.String("channelGroupName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnChannelGroup ¶
func NewCfnChannelGroup(scope constructs.Construct, id *string, props *CfnChannelGroupProps) CfnChannelGroup
type CfnChannelGroupProps ¶
type CfnChannelGroupProps struct { // The name of the channel group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-channelgroupname // ChannelGroupName *string `field:"required" json:"channelGroupName" yaml:"channelGroupName"` // The configuration for a MediaPackage V2 channel group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags associated with the channel group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnChannelGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnChannelGroupProps := &CfnChannelGroupProps{ ChannelGroupName: jsii.String("channelGroupName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnChannelPolicy ¶
type CfnChannelPolicy interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the channel group associated with the channel policy. ChannelGroupName() *string SetChannelGroupName(val *string) // The name of the channel associated with the channel policy. ChannelName() *string SetChannelName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The policy associated with the channel. Policy() interface{} SetPolicy(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Specifies the configuration parameters of a MediaPackage V2 channel policy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policy interface{} cfnChannelPolicy := awscdk.Aws_mediapackagev2.NewCfnChannelPolicy(this, jsii.String("MyCfnChannelPolicy"), &CfnChannelPolicyProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), Policy: policy, })
func NewCfnChannelPolicy ¶
func NewCfnChannelPolicy(scope constructs.Construct, id *string, props *CfnChannelPolicyProps) CfnChannelPolicy
type CfnChannelPolicyProps ¶
type CfnChannelPolicyProps struct { // The name of the channel group associated with the channel policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-channelgroupname // ChannelGroupName *string `field:"required" json:"channelGroupName" yaml:"channelGroupName"` // The name of the channel associated with the channel policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-channelname // ChannelName *string `field:"required" json:"channelName" yaml:"channelName"` // The policy associated with the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-policy // Policy interface{} `field:"required" json:"policy" yaml:"policy"` }
Properties for defining a `CfnChannelPolicy`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policy interface{} cfnChannelPolicyProps := &CfnChannelPolicyProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), Policy: policy, }
type CfnChannelProps ¶
type CfnChannelProps struct { // The name of the channel group associated with the channel configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelgroupname // ChannelGroupName *string `field:"required" json:"channelGroupName" yaml:"channelGroupName"` // The name of the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelname // ChannelName *string `field:"required" json:"channelName" yaml:"channelName"` // The description of the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-description // Description *string `field:"optional" json:"description" yaml:"description"` // The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. // // If unprovided, it will default to HLS to preserve current behavior. // // The allowed values are: // // - `HLS` - The HLS streaming specification (which defines M3U8 manifests and TS segments). // - `CMAF` - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-inputtype // InputType *string `field:"optional" json:"inputType" yaml:"inputType"` // The tags associated with the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnChannelProps := &CfnChannelProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), // the properties below are optional Description: jsii.String("description"), InputType: jsii.String("inputType"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnChannel_IngestEndpointProperty ¶
type CfnChannel_IngestEndpointProperty struct { // The identifier associated with the ingest endpoint of the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-id // Id *string `field:"optional" json:"id" yaml:"id"` // The URL associated with the ingest endpoint of the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-url // Url *string `field:"optional" json:"url" yaml:"url"` }
The input URL where the source stream should be sent.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ingestEndpointProperty := &IngestEndpointProperty{ Id: jsii.String("id"), Url: jsii.String("url"), }
type CfnOriginEndpoint ¶
type CfnOriginEndpoint interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the origin endpoint. AttrArn() *string // The timestamp of the creation of the origin endpoint. AttrCreatedAt() *string AttrDashManifestUrls() *[]*string AttrHlsManifestUrls() *[]*string AttrLowLatencyHlsManifestUrls() *[]*string // The timestamp of the modification of the origin endpoint. AttrModifiedAt() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the channel group associated with the origin endpoint configuration. ChannelGroupName() *string SetChannelGroupName(val *string) // The channel name associated with the origin endpoint. ChannelName() *string SetChannelName(val *string) // The container type associated with the origin endpoint configuration. ContainerType() *string SetContainerType(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A DASH manifest configuration. DashManifests() interface{} SetDashManifests(val interface{}) // The description associated with the origin endpoint. Description() *string SetDescription(val *string) // The failover settings for the endpoint. ForceEndpointErrorConfiguration() interface{} SetForceEndpointErrorConfiguration(val interface{}) // The HLS manfiests associated with the origin endpoint configuration. HlsManifests() interface{} SetHlsManifests(val interface{}) // 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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The low-latency HLS (LL-HLS) manifests associated with the origin endpoint. LowLatencyHlsManifests() interface{} SetLowLatencyHlsManifests(val interface{}) // The tree node. Node() constructs.Node // The name of the origin endpoint associated with the origin endpoint configuration. OriginEndpointName() *string SetOriginEndpointName(val *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 })`. Ref() *string // The segment associated with the origin endpoint. Segment() interface{} SetSegment(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. StartoverWindowSeconds() *float64 SetStartoverWindowSeconds(val *float64) // The tags associated with the origin endpoint. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnOriginEndpoint := awscdk.Aws_mediapackagev2.NewCfnOriginEndpoint(this, jsii.String("MyCfnOriginEndpoint"), &CfnOriginEndpointProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), ContainerType: jsii.String("containerType"), OriginEndpointName: jsii.String("originEndpointName"), // the properties below are optional DashManifests: []interface{}{ &DashManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional DrmSignaling: jsii.String("drmSignaling"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), MinBufferTimeSeconds: jsii.Number(123), MinUpdatePeriodSeconds: jsii.Number(123), PeriodTriggers: []*string{ jsii.String("periodTriggers"), }, ScteDash: &ScteDashProperty{ AdMarkerDash: jsii.String("adMarkerDash"), }, SegmentTemplateFormat: jsii.String("segmentTemplateFormat"), SuggestedPresentationDelaySeconds: jsii.Number(123), UtcTiming: &DashUtcTimingProperty{ TimingMode: jsii.String("timingMode"), TimingSource: jsii.String("timingSource"), }, }, }, Description: jsii.String("description"), ForceEndpointErrorConfiguration: &ForceEndpointErrorConfigurationProperty{ EndpointErrorConditions: []*string{ jsii.String("endpointErrorConditions"), }, }, HlsManifests: []interface{}{ &HlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }, }, LowLatencyHlsManifests: []interface{}{ &LowLatencyHlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }, }, Segment: &SegmentProperty{ Encryption: &EncryptionProperty{ EncryptionMethod: &EncryptionMethodProperty{ CmafEncryptionMethod: jsii.String("cmafEncryptionMethod"), TsEncryptionMethod: jsii.String("tsEncryptionMethod"), }, SpekeKeyProvider: &SpekeKeyProviderProperty{ DrmSystems: []*string{ jsii.String("drmSystems"), }, EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }, ResourceId: jsii.String("resourceId"), RoleArn: jsii.String("roleArn"), Url: jsii.String("url"), }, // the properties below are optional ConstantInitializationVector: jsii.String("constantInitializationVector"), KeyRotationIntervalSeconds: jsii.Number(123), }, IncludeIframeOnlyStreams: jsii.Boolean(false), Scte: &ScteProperty{ ScteFilter: []*string{ jsii.String("scteFilter"), }, }, SegmentDurationSeconds: jsii.Number(123), SegmentName: jsii.String("segmentName"), TsIncludeDvbSubtitles: jsii.Boolean(false), TsUseAudioRenditionGroup: jsii.Boolean(false), }, StartoverWindowSeconds: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnOriginEndpoint ¶
func NewCfnOriginEndpoint(scope constructs.Construct, id *string, props *CfnOriginEndpointProps) CfnOriginEndpoint
type CfnOriginEndpointPolicy ¶
type CfnOriginEndpointPolicy interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the channel group associated with the origin endpoint policy. ChannelGroupName() *string SetChannelGroupName(val *string) // The channel name associated with the origin endpoint policy. ChannelName() *string SetChannelName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The name of the origin endpoint associated with the origin endpoint policy. OriginEndpointName() *string SetOriginEndpointName(val *string) // The policy associated with the origin endpoint. Policy() interface{} SetPolicy(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Specifies the configuration parameters of a policy associated with a MediaPackage V2 origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policy interface{} cfnOriginEndpointPolicy := awscdk.Aws_mediapackagev2.NewCfnOriginEndpointPolicy(this, jsii.String("MyCfnOriginEndpointPolicy"), &CfnOriginEndpointPolicyProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), OriginEndpointName: jsii.String("originEndpointName"), Policy: policy, })
func NewCfnOriginEndpointPolicy ¶
func NewCfnOriginEndpointPolicy(scope constructs.Construct, id *string, props *CfnOriginEndpointPolicyProps) CfnOriginEndpointPolicy
type CfnOriginEndpointPolicyProps ¶
type CfnOriginEndpointPolicyProps struct { // The name of the channel group associated with the origin endpoint policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-channelgroupname // ChannelGroupName *string `field:"required" json:"channelGroupName" yaml:"channelGroupName"` // The channel name associated with the origin endpoint policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-channelname // ChannelName *string `field:"required" json:"channelName" yaml:"channelName"` // The name of the origin endpoint associated with the origin endpoint policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-originendpointname // OriginEndpointName *string `field:"required" json:"originEndpointName" yaml:"originEndpointName"` // The policy associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-policy // Policy interface{} `field:"required" json:"policy" yaml:"policy"` }
Properties for defining a `CfnOriginEndpointPolicy`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policy interface{} cfnOriginEndpointPolicyProps := &CfnOriginEndpointPolicyProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), OriginEndpointName: jsii.String("originEndpointName"), Policy: policy, }
type CfnOriginEndpointProps ¶
type CfnOriginEndpointProps struct { // The name of the channel group associated with the origin endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelgroupname // ChannelGroupName *string `field:"required" json:"channelGroupName" yaml:"channelGroupName"` // The channel name associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelname // ChannelName *string `field:"required" json:"channelName" yaml:"channelName"` // The container type associated with the origin endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-containertype // ContainerType *string `field:"required" json:"containerType" yaml:"containerType"` // The name of the origin endpoint associated with the origin endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-originendpointname // OriginEndpointName *string `field:"required" json:"originEndpointName" yaml:"originEndpointName"` // A DASH manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-dashmanifests // DashManifests interface{} `field:"optional" json:"dashManifests" yaml:"dashManifests"` // The description associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-description // Description *string `field:"optional" json:"description" yaml:"description"` // The failover settings for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration // ForceEndpointErrorConfiguration interface{} `field:"optional" json:"forceEndpointErrorConfiguration" yaml:"forceEndpointErrorConfiguration"` // The HLS manfiests associated with the origin endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-hlsmanifests // HlsManifests interface{} `field:"optional" json:"hlsManifests" yaml:"hlsManifests"` // The low-latency HLS (LL-HLS) manifests associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifests // LowLatencyHlsManifests interface{} `field:"optional" json:"lowLatencyHlsManifests" yaml:"lowLatencyHlsManifests"` // The segment associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-segment // Segment interface{} `field:"optional" json:"segment" yaml:"segment"` // The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. // // Viewers can start-over or catch-up on content that falls within the window. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-startoverwindowseconds // StartoverWindowSeconds *float64 `field:"optional" json:"startoverWindowSeconds" yaml:"startoverWindowSeconds"` // The tags associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnOriginEndpoint`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnOriginEndpointProps := &CfnOriginEndpointProps{ ChannelGroupName: jsii.String("channelGroupName"), ChannelName: jsii.String("channelName"), ContainerType: jsii.String("containerType"), OriginEndpointName: jsii.String("originEndpointName"), // the properties below are optional DashManifests: []interface{}{ &DashManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional DrmSignaling: jsii.String("drmSignaling"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), MinBufferTimeSeconds: jsii.Number(123), MinUpdatePeriodSeconds: jsii.Number(123), PeriodTriggers: []*string{ jsii.String("periodTriggers"), }, ScteDash: &ScteDashProperty{ AdMarkerDash: jsii.String("adMarkerDash"), }, SegmentTemplateFormat: jsii.String("segmentTemplateFormat"), SuggestedPresentationDelaySeconds: jsii.Number(123), UtcTiming: &DashUtcTimingProperty{ TimingMode: jsii.String("timingMode"), TimingSource: jsii.String("timingSource"), }, }, }, Description: jsii.String("description"), ForceEndpointErrorConfiguration: &ForceEndpointErrorConfigurationProperty{ EndpointErrorConditions: []*string{ jsii.String("endpointErrorConditions"), }, }, HlsManifests: []interface{}{ &HlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }, }, LowLatencyHlsManifests: []interface{}{ &LowLatencyHlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }, }, Segment: &SegmentProperty{ Encryption: &EncryptionProperty{ EncryptionMethod: &EncryptionMethodProperty{ CmafEncryptionMethod: jsii.String("cmafEncryptionMethod"), TsEncryptionMethod: jsii.String("tsEncryptionMethod"), }, SpekeKeyProvider: &SpekeKeyProviderProperty{ DrmSystems: []*string{ jsii.String("drmSystems"), }, EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }, ResourceId: jsii.String("resourceId"), RoleArn: jsii.String("roleArn"), Url: jsii.String("url"), }, // the properties below are optional ConstantInitializationVector: jsii.String("constantInitializationVector"), KeyRotationIntervalSeconds: jsii.Number(123), }, IncludeIframeOnlyStreams: jsii.Boolean(false), Scte: &ScteProperty{ ScteFilter: []*string{ jsii.String("scteFilter"), }, }, SegmentDurationSeconds: jsii.Number(123), SegmentName: jsii.String("segmentName"), TsIncludeDvbSubtitles: jsii.Boolean(false), TsUseAudioRenditionGroup: jsii.Boolean(false), }, StartoverWindowSeconds: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnOriginEndpoint_DashManifestConfigurationProperty ¶ added in v2.145.0
type CfnOriginEndpoint_DashManifestConfigurationProperty struct { // <p>A short string that's appended to the endpoint URL. // // The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. </p> // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-manifestname // ManifestName *string `field:"required" json:"manifestName" yaml:"manifestName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-drmsignaling // DrmSignaling *string `field:"optional" json:"drmSignaling" yaml:"drmSignaling"` // <p>Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. // // </p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-filterconfiguration // FilterConfiguration interface{} `field:"optional" json:"filterConfiguration" yaml:"filterConfiguration"` // <p>The total duration (in seconds) of the manifest's content.</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-manifestwindowseconds // ManifestWindowSeconds *float64 `field:"optional" json:"manifestWindowSeconds" yaml:"manifestWindowSeconds"` // <p>Minimum amount of content (in seconds) that a player must keep available in the buffer.</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-minbuffertimeseconds // MinBufferTimeSeconds *float64 `field:"optional" json:"minBufferTimeSeconds" yaml:"minBufferTimeSeconds"` // <p>Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-minupdateperiodseconds // MinUpdatePeriodSeconds *float64 `field:"optional" json:"minUpdatePeriodSeconds" yaml:"minUpdatePeriodSeconds"` // <p>A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. // // Leave this value empty to indicate that the manifest is contained all in one period. // For more information about periods in the DASH manifest, see <a href="https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html">Multi-period DASH in AWS Elemental MediaPackage</a>.</p> // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-periodtriggers // PeriodTriggers *[]*string `field:"optional" json:"periodTriggers" yaml:"periodTriggers"` // <p>The SCTE configuration.</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-sctedash // ScteDash interface{} `field:"optional" json:"scteDash" yaml:"scteDash"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-segmenttemplateformat // SegmentTemplateFormat *string `field:"optional" json:"segmentTemplateFormat" yaml:"segmentTemplateFormat"` // <p>The amount of time (in seconds) that the player should be from the end of the manifest.</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-suggestedpresentationdelayseconds // SuggestedPresentationDelaySeconds *float64 `field:"optional" json:"suggestedPresentationDelaySeconds" yaml:"suggestedPresentationDelaySeconds"` // <p>Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).</p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-utctiming // UtcTiming interface{} `field:"optional" json:"utcTiming" yaml:"utcTiming"` }
<p>Retrieve the DASH manifest configuration.</p>.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dashManifestConfigurationProperty := &DashManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional DrmSignaling: jsii.String("drmSignaling"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), MinBufferTimeSeconds: jsii.Number(123), MinUpdatePeriodSeconds: jsii.Number(123), PeriodTriggers: []*string{ jsii.String("periodTriggers"), }, ScteDash: &ScteDashProperty{ AdMarkerDash: jsii.String("adMarkerDash"), }, SegmentTemplateFormat: jsii.String("segmentTemplateFormat"), SuggestedPresentationDelaySeconds: jsii.Number(123), UtcTiming: &DashUtcTimingProperty{ TimingMode: jsii.String("timingMode"), TimingSource: jsii.String("timingSource"), }, }
type CfnOriginEndpoint_DashUtcTimingProperty ¶ added in v2.145.0
type CfnOriginEndpoint_DashUtcTimingProperty struct { // The UTC timing mode. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashutctiming.html#cfn-mediapackagev2-originendpoint-dashutctiming-timingmode // TimingMode *string `field:"optional" json:"timingMode" yaml:"timingMode"` // The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashutctiming.html#cfn-mediapackagev2-originendpoint-dashutctiming-timingsource // TimingSource *string `field:"optional" json:"timingSource" yaml:"timingSource"` }
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dashUtcTimingProperty := &DashUtcTimingProperty{ TimingMode: jsii.String("timingMode"), TimingSource: jsii.String("timingSource"), }
type CfnOriginEndpoint_EncryptionContractConfigurationProperty ¶
type CfnOriginEndpoint_EncryptionContractConfigurationProperty struct { // A collection of audio encryption presets. // // Value description: // // - `PRESET-AUDIO-1` - Use one content key to encrypt all of the audio tracks in your stream. // - `PRESET-AUDIO-2` - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. // - `PRESET-AUDIO-3` - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. // - `SHARED` - Use the same content key for all of the audio and video tracks in your stream. // - `UNENCRYPTED` - Don't encrypt any of the audio tracks in your stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptioncontractconfiguration.html#cfn-mediapackagev2-originendpoint-encryptioncontractconfiguration-presetspeke20audio // PresetSpeke20Audio *string `field:"required" json:"presetSpeke20Audio" yaml:"presetSpeke20Audio"` // The SPEKE Version 2.0 preset video associated with the encryption contract configuration of the origin endpoint. // // A collection of video encryption presets. // // Value description: // // - `PRESET-VIDEO-1` - Use one content key to encrypt all of the video tracks in your stream. // - `PRESET-VIDEO-2` - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. // - `PRESET-VIDEO-3` - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. // - `PRESET-VIDEO-4` - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. // - `PRESET-VIDEO-5` - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. // - `PRESET-VIDEO-6` - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. // - `PRESET-VIDEO-7` - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. // - `PRESET-VIDEO-8` - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. // - `SHARED` - Use the same content key for all of the video and audio tracks in your stream. // - `UNENCRYPTED` - Don't encrypt any of the video tracks in your stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptioncontractconfiguration.html#cfn-mediapackagev2-originendpoint-encryptioncontractconfiguration-presetspeke20video // PresetSpeke20Video *string `field:"required" json:"presetSpeke20Video" yaml:"presetSpeke20Video"` }
Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" encryptionContractConfigurationProperty := &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }
type CfnOriginEndpoint_EncryptionMethodProperty ¶
type CfnOriginEndpoint_EncryptionMethodProperty struct { // The encryption method to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-cmafencryptionmethod // CmafEncryptionMethod *string `field:"optional" json:"cmafEncryptionMethod" yaml:"cmafEncryptionMethod"` // The encryption method to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-tsencryptionmethod // TsEncryptionMethod *string `field:"optional" json:"tsEncryptionMethod" yaml:"tsEncryptionMethod"` }
The encryption method associated with the origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" encryptionMethodProperty := &EncryptionMethodProperty{ CmafEncryptionMethod: jsii.String("cmafEncryptionMethod"), TsEncryptionMethod: jsii.String("tsEncryptionMethod"), }
type CfnOriginEndpoint_EncryptionProperty ¶
type CfnOriginEndpoint_EncryptionProperty struct { // The encryption method to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-encryptionmethod // EncryptionMethod interface{} `field:"required" json:"encryptionMethod" yaml:"encryptionMethod"` // The SPEKE key provider to use for encryption. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-spekekeyprovider // SpekeKeyProvider interface{} `field:"required" json:"spekeKeyProvider" yaml:"spekeKeyProvider"` // A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. // // If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-constantinitializationvector // ConstantInitializationVector *string `field:"optional" json:"constantInitializationVector" yaml:"constantInitializationVector"` // The interval, in seconds, to rotate encryption keys for the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-keyrotationintervalseconds // KeyRotationIntervalSeconds *float64 `field:"optional" json:"keyRotationIntervalSeconds" yaml:"keyRotationIntervalSeconds"` }
The parameters for encrypting content.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" encryptionProperty := &EncryptionProperty{ EncryptionMethod: &EncryptionMethodProperty{ CmafEncryptionMethod: jsii.String("cmafEncryptionMethod"), TsEncryptionMethod: jsii.String("tsEncryptionMethod"), }, SpekeKeyProvider: &SpekeKeyProviderProperty{ DrmSystems: []*string{ jsii.String("drmSystems"), }, EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }, ResourceId: jsii.String("resourceId"), RoleArn: jsii.String("roleArn"), Url: jsii.String("url"), }, // the properties below are optional ConstantInitializationVector: jsii.String("constantInitializationVector"), KeyRotationIntervalSeconds: jsii.Number(123), }
type CfnOriginEndpoint_FilterConfigurationProperty ¶ added in v2.109.0
type CfnOriginEndpoint_FilterConfigurationProperty struct { // Optionally specify the clip start time for all of your manifest egress requests. // // When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-clipstarttime // ClipStartTime *string `field:"optional" json:"clipStartTime" yaml:"clipStartTime"` // Optionally specify the end time for all of your manifest egress requests. // // When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-end // End *string `field:"optional" json:"end" yaml:"end"` // Optionally specify one or more manifest filters for all of your manifest egress requests. // // When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-manifestfilter // ManifestFilter *string `field:"optional" json:"manifestFilter" yaml:"manifestFilter"` // Optionally specify the start time for all of your manifest egress requests. // // When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-start // Start *string `field:"optional" json:"start" yaml:"start"` // Optionally specify the time delay for all of your manifest egress requests. // // Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-timedelayseconds // TimeDelaySeconds *float64 `field:"optional" json:"timeDelaySeconds" yaml:"timeDelaySeconds"` }
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" filterConfigurationProperty := &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }
type CfnOriginEndpoint_ForceEndpointErrorConfigurationProperty ¶ added in v2.154.0
type CfnOriginEndpoint_ForceEndpointErrorConfigurationProperty struct { // The failover conditions for the endpoint. The options are:. // // - `STALE_MANIFEST` - The manifest stalled and there are no new segments or parts. // - `INCOMPLETE_MANIFEST` - There is a gap in the manifest. // - `MISSING_DRM_KEY` - Key rotation is enabled but we're unable to fetch the key for the current key period. // - `SLATE_INPUT` - The segments which contain slate content are considered to be missing content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-forceendpointerrorconfiguration.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration-endpointerrorconditions // EndpointErrorConditions *[]*string `field:"optional" json:"endpointErrorConditions" yaml:"endpointErrorConditions"` }
The failover settings for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" forceEndpointErrorConfigurationProperty := &ForceEndpointErrorConfigurationProperty{ EndpointErrorConditions: []*string{ jsii.String("endpointErrorConditions"), }, }
type CfnOriginEndpoint_HlsManifestConfigurationProperty ¶
type CfnOriginEndpoint_HlsManifestConfigurationProperty struct { // The name of the manifest associated with the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-manifestname // ManifestName *string `field:"required" json:"manifestName" yaml:"manifestName"` // The name of the child manifest associated with the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-childmanifestname // ChildManifestName *string `field:"optional" json:"childManifestName" yaml:"childManifestName"` // <p>Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. // // </p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-filterconfiguration // FilterConfiguration interface{} `field:"optional" json:"filterConfiguration" yaml:"filterConfiguration"` // The duration of the manifest window, in seconds, for the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-manifestwindowseconds // ManifestWindowSeconds *float64 `field:"optional" json:"manifestWindowSeconds" yaml:"manifestWindowSeconds"` // The `EXT-X-PROGRAM-DATE-TIME` interval, in seconds, associated with the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-programdatetimeintervalseconds // ProgramDateTimeIntervalSeconds *float64 `field:"optional" json:"programDateTimeIntervalSeconds" yaml:"programDateTimeIntervalSeconds"` // THE SCTE-35 HLS configuration associated with the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-sctehls // ScteHls interface{} `field:"optional" json:"scteHls" yaml:"scteHls"` // <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. // // When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p> // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-starttag // StartTag interface{} `field:"optional" json:"startTag" yaml:"startTag"` // The URL of the HLS manifest configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-url // Url *string `field:"optional" json:"url" yaml:"url"` }
The HLS manfiest configuration associated with the origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" hlsManifestConfigurationProperty := &HlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }
type CfnOriginEndpoint_LowLatencyHlsManifestConfigurationProperty ¶
type CfnOriginEndpoint_LowLatencyHlsManifestConfigurationProperty struct { // A short short string that's appended to the endpoint URL. // // The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, `index` . MediaPackage automatically inserts the format extension, such as `.m3u8` . You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The `manifestName` on the `HLSManifest` object overrides the `manifestName` you provided on the `originEndpoint` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestname // ManifestName *string `field:"required" json:"manifestName" yaml:"manifestName"` // The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-childmanifestname // ChildManifestName *string `field:"optional" json:"childManifestName" yaml:"childManifestName"` // <p>Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. // // </p>. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-filterconfiguration // FilterConfiguration interface{} `field:"optional" json:"filterConfiguration" yaml:"filterConfiguration"` // The total duration (in seconds) of the manifest's content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestwindowseconds // ManifestWindowSeconds *float64 `field:"optional" json:"manifestWindowSeconds" yaml:"manifestWindowSeconds"` // Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify. // // If you don't enter an interval, `EXT-X-PROGRAM-DATE-TIME` tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. // // Irrespective of this parameter, if any `ID3Timed` metadata is in the HLS input, MediaPackage passes through that metadata to the HLS output. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-programdatetimeintervalseconds // ProgramDateTimeIntervalSeconds *float64 `field:"optional" json:"programDateTimeIntervalSeconds" yaml:"programDateTimeIntervalSeconds"` // The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-sctehls // ScteHls interface{} `field:"optional" json:"scteHls" yaml:"scteHls"` // <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. // // When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p> // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-starttag // StartTag interface{} `field:"optional" json:"startTag" yaml:"startTag"` // The URL of the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-url // Url *string `field:"optional" json:"url" yaml:"url"` }
Specify a low-latency HTTP live streaming (LL-HLS) manifest configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lowLatencyHlsManifestConfigurationProperty := &LowLatencyHlsManifestConfigurationProperty{ ManifestName: jsii.String("manifestName"), // the properties below are optional ChildManifestName: jsii.String("childManifestName"), FilterConfiguration: &FilterConfigurationProperty{ ClipStartTime: jsii.String("clipStartTime"), End: jsii.String("end"), ManifestFilter: jsii.String("manifestFilter"), Start: jsii.String("start"), TimeDelaySeconds: jsii.Number(123), }, ManifestWindowSeconds: jsii.Number(123), ProgramDateTimeIntervalSeconds: jsii.Number(123), ScteHls: &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }, StartTag: &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }, Url: jsii.String("url"), }
type CfnOriginEndpoint_ScteDashProperty ¶ added in v2.145.0
type CfnOriginEndpoint_ScteDashProperty struct { // Choose how ad markers are included in the packaged content. // // If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. // // Value description: // // - `Binary` - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML. // - `XML` - The SCTE marker is expressed fully in XML. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctedash.html#cfn-mediapackagev2-originendpoint-sctedash-admarkerdash // AdMarkerDash *string `field:"optional" json:"adMarkerDash" yaml:"adMarkerDash"` }
The SCTE configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scteDashProperty := &ScteDashProperty{ AdMarkerDash: jsii.String("adMarkerDash"), }
type CfnOriginEndpoint_ScteHlsProperty ¶
type CfnOriginEndpoint_ScteHlsProperty struct { // The SCTE-35 HLS ad-marker configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctehls.html#cfn-mediapackagev2-originendpoint-sctehls-admarkerhls // AdMarkerHls *string `field:"optional" json:"adMarkerHls" yaml:"adMarkerHls"` }
The SCTE-35 HLS configuration associated with the origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scteHlsProperty := &ScteHlsProperty{ AdMarkerHls: jsii.String("adMarkerHls"), }
type CfnOriginEndpoint_ScteProperty ¶
type CfnOriginEndpoint_ScteProperty struct { // The filter associated with the SCTE-35 configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-scte.html#cfn-mediapackagev2-originendpoint-scte-sctefilter // ScteFilter *[]*string `field:"optional" json:"scteFilter" yaml:"scteFilter"` }
The SCTE-35 configuration associated with the origin endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scteProperty := &ScteProperty{ ScteFilter: []*string{ jsii.String("scteFilter"), }, }
type CfnOriginEndpoint_SegmentProperty ¶
type CfnOriginEndpoint_SegmentProperty struct { // Whether to use encryption for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-encryption // Encryption interface{} `field:"optional" json:"encryption" yaml:"encryption"` // Whether the segment includes I-frame-only streams. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-includeiframeonlystreams // IncludeIframeOnlyStreams interface{} `field:"optional" json:"includeIframeOnlyStreams" yaml:"includeIframeOnlyStreams"` // The SCTE-35 configuration associated with the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-scte // Scte interface{} `field:"optional" json:"scte" yaml:"scte"` // The duration of the segment, in seconds. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-segmentdurationseconds // SegmentDurationSeconds *float64 `field:"optional" json:"segmentDurationSeconds" yaml:"segmentDurationSeconds"` // The name of the segment associated with the origin endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-segmentname // SegmentName *string `field:"optional" json:"segmentName" yaml:"segmentName"` // Whether the segment includes DVB subtitles. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-tsincludedvbsubtitles // TsIncludeDvbSubtitles interface{} `field:"optional" json:"tsIncludeDvbSubtitles" yaml:"tsIncludeDvbSubtitles"` // Whether the segment is an audio rendition group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-tsuseaudiorenditiongroup // TsUseAudioRenditionGroup interface{} `field:"optional" json:"tsUseAudioRenditionGroup" yaml:"tsUseAudioRenditionGroup"` }
The segment configuration, including the segment name, duration, and other configuration values.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" segmentProperty := &SegmentProperty{ Encryption: &EncryptionProperty{ EncryptionMethod: &EncryptionMethodProperty{ CmafEncryptionMethod: jsii.String("cmafEncryptionMethod"), TsEncryptionMethod: jsii.String("tsEncryptionMethod"), }, SpekeKeyProvider: &SpekeKeyProviderProperty{ DrmSystems: []*string{ jsii.String("drmSystems"), }, EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }, ResourceId: jsii.String("resourceId"), RoleArn: jsii.String("roleArn"), Url: jsii.String("url"), }, // the properties below are optional ConstantInitializationVector: jsii.String("constantInitializationVector"), KeyRotationIntervalSeconds: jsii.Number(123), }, IncludeIframeOnlyStreams: jsii.Boolean(false), Scte: &ScteProperty{ ScteFilter: []*string{ jsii.String("scteFilter"), }, }, SegmentDurationSeconds: jsii.Number(123), SegmentName: jsii.String("segmentName"), TsIncludeDvbSubtitles: jsii.Boolean(false), TsUseAudioRenditionGroup: jsii.Boolean(false), }
type CfnOriginEndpoint_SpekeKeyProviderProperty ¶
type CfnOriginEndpoint_SpekeKeyProviderProperty struct { // The DRM solution provider you're using to protect your content during distribution. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-drmsystems // DrmSystems *[]*string `field:"required" json:"drmSystems" yaml:"drmSystems"` // The encryption contract configuration associated with the SPEKE key provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-encryptioncontractconfiguration // EncryptionContractConfiguration interface{} `field:"required" json:"encryptionContractConfiguration" yaml:"encryptionContractConfiguration"` // The unique identifier for the content. // // The service sends this identifier to the key server to identify the current endpoint. How unique you make this identifier depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. // // The following example shows a resource ID: `MovieNight20171126093045`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-resourceid // ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"` // The ARN for the IAM role granted by the key provider that provides access to the key provider API. // // This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. // // Valid format: `arn:aws:iam::{accountID}:role/{name}` . The following example shows a role ARN: `arn:aws:iam::444455556666:role/SpekeAccess` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The URL of the SPEKE key provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-url // Url *string `field:"required" json:"url" yaml:"url"` }
The parameters for the SPEKE key provider.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spekeKeyProviderProperty := &SpekeKeyProviderProperty{ DrmSystems: []*string{ jsii.String("drmSystems"), }, EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{ PresetSpeke20Audio: jsii.String("presetSpeke20Audio"), PresetSpeke20Video: jsii.String("presetSpeke20Video"), }, ResourceId: jsii.String("resourceId"), RoleArn: jsii.String("roleArn"), Url: jsii.String("url"), }
type CfnOriginEndpoint_StartTagProperty ¶ added in v2.166.0
type CfnOriginEndpoint_StartTagProperty struct { // Specify the value for TIME-OFFSET within your EXT-X-START tag. // // Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-starttag.html#cfn-mediapackagev2-originendpoint-starttag-timeoffset // TimeOffset *float64 `field:"required" json:"timeOffset" yaml:"timeOffset"` // Specify the value for PRECISE within your EXT-X-START tag. // // Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-starttag.html#cfn-mediapackagev2-originendpoint-starttag-precise // Precise interface{} `field:"optional" json:"precise" yaml:"precise"` }
To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.
When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" startTagProperty := &StartTagProperty{ TimeOffset: jsii.Number(123), // the properties below are optional Precise: jsii.Boolean(false), }
Source Files ¶
- CfnChannel.go
- CfnChannelGroup.go
- CfnChannelGroupProps.go
- CfnChannelGroup__checks.go
- CfnChannelPolicy.go
- CfnChannelPolicyProps.go
- CfnChannelPolicy__checks.go
- CfnChannelProps.go
- CfnChannel_IngestEndpointProperty.go
- CfnChannel__checks.go
- CfnOriginEndpoint.go
- CfnOriginEndpointPolicy.go
- CfnOriginEndpointPolicyProps.go
- CfnOriginEndpointPolicy__checks.go
- CfnOriginEndpointProps.go
- CfnOriginEndpoint_DashManifestConfigurationProperty.go
- CfnOriginEndpoint_DashUtcTimingProperty.go
- CfnOriginEndpoint_EncryptionContractConfigurationProperty.go
- CfnOriginEndpoint_EncryptionMethodProperty.go
- CfnOriginEndpoint_EncryptionProperty.go
- CfnOriginEndpoint_FilterConfigurationProperty.go
- CfnOriginEndpoint_ForceEndpointErrorConfigurationProperty.go
- CfnOriginEndpoint_HlsManifestConfigurationProperty.go
- CfnOriginEndpoint_LowLatencyHlsManifestConfigurationProperty.go
- CfnOriginEndpoint_ScteDashProperty.go
- CfnOriginEndpoint_ScteHlsProperty.go
- CfnOriginEndpoint_ScteProperty.go
- CfnOriginEndpoint_SegmentProperty.go
- CfnOriginEndpoint_SpekeKeyProviderProperty.go
- CfnOriginEndpoint_StartTagProperty.go
- CfnOriginEndpoint__checks.go
- main.go