Documentation
¶
Index ¶
- func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannelPolicy_IsCfnElement(x interface{}) *bool
- func CfnChannelPolicy_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnChannelPolicy_IsConstruct(x interface{}) *bool
- func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnChannel_IsCfnElement(x interface{}) *bool
- func CfnChannel_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnChannel_IsConstruct(x interface{}) *bool
- func CfnLiveSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLiveSource_IsCfnElement(x interface{}) *bool
- func CfnLiveSource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLiveSource_IsConstruct(x interface{}) *bool
- func CfnPlaybackConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPlaybackConfiguration_IsCfnElement(x interface{}) *bool
- func CfnPlaybackConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPlaybackConfiguration_IsConstruct(x interface{}) *bool
- func CfnSourceLocation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSourceLocation_IsCfnElement(x interface{}) *bool
- func CfnSourceLocation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSourceLocation_IsConstruct(x interface{}) *bool
- func CfnVodSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVodSource_IsCfnElement(x interface{}) *bool
- func CfnVodSource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVodSource_IsConstruct(x interface{}) *bool
- func NewCfnChannelPolicy_Override(c CfnChannelPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
- func NewCfnLiveSource_Override(c CfnLiveSource, scope constructs.Construct, id *string, ...)
- func NewCfnPlaybackConfiguration_Override(c CfnPlaybackConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnSourceLocation_Override(c CfnSourceLocation, scope constructs.Construct, id *string, ...)
- func NewCfnVodSource_Override(c CfnVodSource, scope constructs.Construct, id *string, ...)
- type CfnChannel
- type CfnChannelPolicy
- type CfnChannelPolicyProps
- type CfnChannelProps
- type CfnChannel_DashPlaylistSettingsProperty
- type CfnChannel_HlsPlaylistSettingsProperty
- type CfnChannel_LogConfigurationForChannelProperty
- type CfnChannel_RequestOutputItemProperty
- type CfnChannel_SlateSourceProperty
- type CfnLiveSource
- type CfnLiveSourceProps
- type CfnLiveSource_HttpPackageConfigurationProperty
- type CfnPlaybackConfiguration
- type CfnPlaybackConfigurationProps
- type CfnPlaybackConfiguration_AdMarkerPassthroughProperty
- type CfnPlaybackConfiguration_AvailSuppressionProperty
- type CfnPlaybackConfiguration_BumperProperty
- type CfnPlaybackConfiguration_CdnConfigurationProperty
- type CfnPlaybackConfiguration_DashConfigurationProperty
- type CfnPlaybackConfiguration_HlsConfigurationProperty
- type CfnPlaybackConfiguration_LivePreRollConfigurationProperty
- type CfnPlaybackConfiguration_ManifestProcessingRulesProperty
- type CfnSourceLocation
- type CfnSourceLocationProps
- type CfnSourceLocation_AccessConfigurationProperty
- type CfnSourceLocation_DefaultSegmentDeliveryConfigurationProperty
- type CfnSourceLocation_HttpConfigurationProperty
- type CfnSourceLocation_SecretsManagerAccessTokenConfigurationProperty
- type CfnSourceLocation_SegmentDeliveryConfigurationProperty
- type CfnVodSource
- type CfnVodSourceProps
- type CfnVodSource_HttpPackageConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME ¶ added in v2.91.0
func CfnChannelPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnChannelPolicy_IsCfnElement ¶ added in v2.91.0
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 ¶ added in v2.91.0
func CfnChannelPolicy_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnChannelPolicy_IsConstruct ¶ added in v2.91.0
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 ¶ added in v2.91.0
func CfnChannel_CFN_RESOURCE_TYPE_NAME() *string
func CfnChannel_IsCfnElement ¶ added in v2.91.0
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 ¶ added in v2.91.0
func CfnChannel_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnChannel_IsConstruct ¶ added in v2.91.0
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 CfnLiveSource_CFN_RESOURCE_TYPE_NAME ¶ added in v2.93.0
func CfnLiveSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnLiveSource_IsCfnElement ¶ added in v2.93.0
func CfnLiveSource_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 CfnLiveSource_IsCfnResource ¶ added in v2.93.0
func CfnLiveSource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLiveSource_IsConstruct ¶ added in v2.93.0
func CfnLiveSource_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 CfnPlaybackConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnPlaybackConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnPlaybackConfiguration_IsCfnElement ¶
func CfnPlaybackConfiguration_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 CfnPlaybackConfiguration_IsCfnResource ¶
func CfnPlaybackConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPlaybackConfiguration_IsConstruct ¶
func CfnPlaybackConfiguration_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 CfnSourceLocation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.91.0
func CfnSourceLocation_CFN_RESOURCE_TYPE_NAME() *string
func CfnSourceLocation_IsCfnElement ¶ added in v2.91.0
func CfnSourceLocation_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 CfnSourceLocation_IsCfnResource ¶ added in v2.91.0
func CfnSourceLocation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSourceLocation_IsConstruct ¶ added in v2.91.0
func CfnSourceLocation_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 CfnVodSource_CFN_RESOURCE_TYPE_NAME ¶ added in v2.93.0
func CfnVodSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnVodSource_IsCfnElement ¶ added in v2.93.0
func CfnVodSource_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 CfnVodSource_IsCfnResource ¶ added in v2.93.0
func CfnVodSource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnVodSource_IsConstruct ¶ added in v2.93.0
func CfnVodSource_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 NewCfnChannelPolicy_Override ¶ added in v2.91.0
func NewCfnChannelPolicy_Override(c CfnChannelPolicy, scope constructs.Construct, id *string, props *CfnChannelPolicyProps)
func NewCfnChannel_Override ¶ added in v2.91.0
func NewCfnChannel_Override(c CfnChannel, scope constructs.Construct, id *string, props *CfnChannelProps)
func NewCfnLiveSource_Override ¶ added in v2.93.0
func NewCfnLiveSource_Override(c CfnLiveSource, scope constructs.Construct, id *string, props *CfnLiveSourceProps)
func NewCfnPlaybackConfiguration_Override ¶
func NewCfnPlaybackConfiguration_Override(c CfnPlaybackConfiguration, scope constructs.Construct, id *string, props *CfnPlaybackConfigurationProps)
func NewCfnSourceLocation_Override ¶ added in v2.91.0
func NewCfnSourceLocation_Override(c CfnSourceLocation, scope constructs.Construct, id *string, props *CfnSourceLocationProps)
func NewCfnVodSource_Override ¶ added in v2.93.0
func NewCfnVodSource_Override(c CfnVodSource, scope constructs.Construct, id *string, props *CfnVodSourceProps)
Types ¶
type CfnChannel ¶ added in v2.91.0
type CfnChannel interface {
awscdk.CfnResource
awscdk.IInspectable
// <p>The ARN of the channel.</p>.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
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
// <p>Slate VOD source configuration.</p>.
FillerSlate() interface{}
SetFillerSlate(val interface{})
// <p>The log configuration for the channel.</p>.
LogConfiguration() interface{}
SetLogConfiguration(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 tree node.
Node() constructs.Node
// <p>The channel's output properties.</p>.
Outputs() interface{}
SetOutputs(val interface{})
PlaybackMode() *string
SetPlaybackMode(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags to assign to the channel.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
Tier() *string
SetTier(val *string)
// 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{})
}
Definition of AWS::MediaTailor::Channel Resource Type.
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_mediatailor.NewCfnChannel(this, jsii.String("MyCfnChannel"), &CfnChannelProps{
ChannelName: jsii.String("channelName"),
Outputs: []interface{}{
&RequestOutputItemProperty{
ManifestName: jsii.String("manifestName"),
SourceGroup: jsii.String("sourceGroup"),
// the properties below are optional
DashPlaylistSettings: &DashPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
MinBufferTimeSeconds: jsii.Number(123),
MinUpdatePeriodSeconds: jsii.Number(123),
SuggestedPresentationDelaySeconds: jsii.Number(123),
},
HlsPlaylistSettings: &HlsPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
},
},
},
PlaybackMode: jsii.String("playbackMode"),
// the properties below are optional
FillerSlate: &SlateSourceProperty{
SourceLocationName: jsii.String("sourceLocationName"),
VodSourceName: jsii.String("vodSourceName"),
},
LogConfiguration: &LogConfigurationForChannelProperty{
LogTypes: []*string{
jsii.String("logTypes"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tier: jsii.String("tier"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html
func NewCfnChannel ¶ added in v2.91.0
func NewCfnChannel(scope constructs.Construct, id *string, props *CfnChannelProps) CfnChannel
type CfnChannelPolicy ¶ added in v2.91.0
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
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
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{})
}
Definition of AWS::MediaTailor::ChannelPolicy Resource Type.
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_mediatailor.NewCfnChannelPolicy(this, jsii.String("MyCfnChannelPolicy"), &CfnChannelPolicyProps{
ChannelName: jsii.String("channelName"),
Policy: policy,
})
func NewCfnChannelPolicy ¶ added in v2.91.0
func NewCfnChannelPolicy(scope constructs.Construct, id *string, props *CfnChannelPolicyProps) CfnChannelPolicy
type CfnChannelPolicyProps ¶ added in v2.91.0
type CfnChannelPolicyProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-channelpolicy-channelname
//
ChannelName *string `field:"required" json:"channelName" yaml:"channelName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-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{
ChannelName: jsii.String("channelName"),
Policy: policy,
}
type CfnChannelProps ¶ added in v2.91.0
type CfnChannelProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-channelname
//
ChannelName *string `field:"required" json:"channelName" yaml:"channelName"`
// <p>The channel's output properties.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-outputs
//
Outputs interface{} `field:"required" json:"outputs" yaml:"outputs"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-playbackmode
//
PlaybackMode *string `field:"required" json:"playbackMode" yaml:"playbackMode"`
// <p>Slate VOD source configuration.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-fillerslate
//
FillerSlate interface{} `field:"optional" json:"fillerSlate" yaml:"fillerSlate"`
// <p>The log configuration for the channel.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-logconfiguration
//
LogConfiguration interface{} `field:"optional" json:"logConfiguration" yaml:"logConfiguration"`
// The tags to assign to the channel.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tier
//
Tier *string `field:"optional" json:"tier" yaml:"tier"`
}
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{
ChannelName: jsii.String("channelName"),
Outputs: []interface{}{
&RequestOutputItemProperty{
ManifestName: jsii.String("manifestName"),
SourceGroup: jsii.String("sourceGroup"),
// the properties below are optional
DashPlaylistSettings: &DashPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
MinBufferTimeSeconds: jsii.Number(123),
MinUpdatePeriodSeconds: jsii.Number(123),
SuggestedPresentationDelaySeconds: jsii.Number(123),
},
HlsPlaylistSettings: &HlsPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
},
},
},
PlaybackMode: jsii.String("playbackMode"),
// the properties below are optional
FillerSlate: &SlateSourceProperty{
SourceLocationName: jsii.String("sourceLocationName"),
VodSourceName: jsii.String("vodSourceName"),
},
LogConfiguration: &LogConfigurationForChannelProperty{
LogTypes: []*string{
jsii.String("logTypes"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tier: jsii.String("tier"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html
type CfnChannel_DashPlaylistSettingsProperty ¶ added in v2.91.0
type CfnChannel_DashPlaylistSettingsProperty struct {
// <p>The total duration (in seconds) of each manifest.
//
// Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-manifestwindowseconds
//
// Default: - 0.
//
ManifestWindowSeconds *float64 `field:"optional" json:"manifestWindowSeconds" yaml:"manifestWindowSeconds"`
// <p>Minimum amount of content (measured in seconds) that a player must keep available in the buffer.
//
// Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minbuffertimeseconds
//
// Default: - 0.
//
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.
//
// Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minupdateperiodseconds
//
// Default: - 0.
//
MinUpdatePeriodSeconds *float64 `field:"optional" json:"minUpdatePeriodSeconds" yaml:"minUpdatePeriodSeconds"`
// <p>Amount of time (in seconds) that the player should be from the live point at the end of the manifest.
//
// Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-suggestedpresentationdelayseconds
//
// Default: - 0.
//
SuggestedPresentationDelaySeconds *float64 `field:"optional" json:"suggestedPresentationDelaySeconds" yaml:"suggestedPresentationDelaySeconds"`
}
<p>Dash manifest configuration parameters.</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"
dashPlaylistSettingsProperty := &DashPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
MinBufferTimeSeconds: jsii.Number(123),
MinUpdatePeriodSeconds: jsii.Number(123),
SuggestedPresentationDelaySeconds: jsii.Number(123),
}
type CfnChannel_HlsPlaylistSettingsProperty ¶ added in v2.91.0
type CfnChannel_HlsPlaylistSettingsProperty struct {
// <p>The total duration (in seconds) of each manifest.
//
// Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-manifestwindowseconds
//
// Default: - 0.
//
ManifestWindowSeconds *float64 `field:"optional" json:"manifestWindowSeconds" yaml:"manifestWindowSeconds"`
}
<p>HLS playlist configuration parameters.</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"
hlsPlaylistSettingsProperty := &HlsPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
}
type CfnChannel_LogConfigurationForChannelProperty ¶ added in v2.91.0
type CfnChannel_LogConfigurationForChannelProperty struct {
// <p>The log types.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html#cfn-mediatailor-channel-logconfigurationforchannel-logtypes
//
LogTypes *[]*string `field:"optional" json:"logTypes" yaml:"logTypes"`
}
<p>The log configuration for the channel.</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"
logConfigurationForChannelProperty := &LogConfigurationForChannelProperty{
LogTypes: []*string{
jsii.String("logTypes"),
},
}
type CfnChannel_RequestOutputItemProperty ¶ added in v2.91.0
type CfnChannel_RequestOutputItemProperty struct {
// <p>The name of the manifest for the channel.
//
// The name appears in the <code>PlaybackUrl</code>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-manifestname
//
ManifestName *string `field:"required" json:"manifestName" yaml:"manifestName"`
// <p>A string used to match which <code>HttpPackageConfiguration</code> is used for each <code>VodSource</code>.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-sourcegroup
//
SourceGroup *string `field:"required" json:"sourceGroup" yaml:"sourceGroup"`
// <p>Dash manifest configuration parameters.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-dashplaylistsettings
//
DashPlaylistSettings interface{} `field:"optional" json:"dashPlaylistSettings" yaml:"dashPlaylistSettings"`
// <p>HLS playlist configuration parameters.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-hlsplaylistsettings
//
HlsPlaylistSettings interface{} `field:"optional" json:"hlsPlaylistSettings" yaml:"hlsPlaylistSettings"`
}
<p>The output configuration for this channel.</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"
requestOutputItemProperty := &RequestOutputItemProperty{
ManifestName: jsii.String("manifestName"),
SourceGroup: jsii.String("sourceGroup"),
// the properties below are optional
DashPlaylistSettings: &DashPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
MinBufferTimeSeconds: jsii.Number(123),
MinUpdatePeriodSeconds: jsii.Number(123),
SuggestedPresentationDelaySeconds: jsii.Number(123),
},
HlsPlaylistSettings: &HlsPlaylistSettingsProperty{
ManifestWindowSeconds: jsii.Number(123),
},
}
type CfnChannel_SlateSourceProperty ¶ added in v2.91.0
type CfnChannel_SlateSourceProperty struct {
// <p>The name of the source location where the slate VOD source is stored.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-sourcelocationname
//
SourceLocationName *string `field:"optional" json:"sourceLocationName" yaml:"sourceLocationName"`
// <p>The slate VOD source name.
//
// The VOD source must already exist in a source location before it can be used for slate.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-vodsourcename
//
VodSourceName *string `field:"optional" json:"vodSourceName" yaml:"vodSourceName"`
}
<p>Slate VOD source 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"
slateSourceProperty := &SlateSourceProperty{
SourceLocationName: jsii.String("sourceLocationName"),
VodSourceName: jsii.String("vodSourceName"),
}
type CfnLiveSource ¶ added in v2.93.0
type CfnLiveSource interface {
awscdk.CfnResource
awscdk.IInspectable
// <p>The ARN of the live source.</p>.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *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
// <p>A list of HTTP package configuration parameters for this live source.</p>.
HttpPackageConfigurations() interface{}
SetHttpPackageConfigurations(val interface{})
LiveSourceName() *string
SetLiveSourceName(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
SourceLocationName() *string
SetSourceLocationName(val *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 to assign to the live source.
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{})
}
Definition of AWS::MediaTailor::LiveSource Resource Type.
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"
cfnLiveSource := awscdk.Aws_mediatailor.NewCfnLiveSource(this, jsii.String("MyCfnLiveSource"), &CfnLiveSourceProps{
HttpPackageConfigurations: []interface{}{
&HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
},
},
LiveSourceName: jsii.String("liveSourceName"),
SourceLocationName: jsii.String("sourceLocationName"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnLiveSource ¶ added in v2.93.0
func NewCfnLiveSource(scope constructs.Construct, id *string, props *CfnLiveSourceProps) CfnLiveSource
type CfnLiveSourceProps ¶ added in v2.93.0
type CfnLiveSourceProps struct {
// <p>A list of HTTP package configuration parameters for this live source.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-httppackageconfigurations
//
HttpPackageConfigurations interface{} `field:"required" json:"httpPackageConfigurations" yaml:"httpPackageConfigurations"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-livesourcename
//
LiveSourceName *string `field:"required" json:"liveSourceName" yaml:"liveSourceName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-sourcelocationname
//
SourceLocationName *string `field:"required" json:"sourceLocationName" yaml:"sourceLocationName"`
// The tags to assign to the live source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLiveSource`.
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"
cfnLiveSourceProps := &CfnLiveSourceProps{
HttpPackageConfigurations: []interface{}{
&HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
},
},
LiveSourceName: jsii.String("liveSourceName"),
SourceLocationName: jsii.String("sourceLocationName"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLiveSource_HttpPackageConfigurationProperty ¶ added in v2.93.0
type CfnLiveSource_HttpPackageConfigurationProperty struct {
// <p>The relative path to the URL for this VOD source.
//
// This is combined with <code>SourceLocation::HttpConfiguration::BaseUrl</code> to form a valid URL.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-path
//
Path *string `field:"required" json:"path" yaml:"path"`
// <p>The name of the source group.
//
// This has to match one of the <code>Channel::Outputs::SourceGroup</code>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-sourcegroup
//
SourceGroup *string `field:"required" json:"sourceGroup" yaml:"sourceGroup"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
<p>The HTTP package configuration properties for the requested VOD source.</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"
httpPackageConfigurationProperty := &HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
}
type CfnPlaybackConfiguration ¶
type CfnPlaybackConfiguration interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The URL for the ad decision server (ADS).
AdDecisionServerUrl() *string
SetAdDecisionServerUrl(val *string)
// The URL generated by MediaTailor to initiate a playback session.
//
// The session uses server-side reporting. This setting is ignored in PUT operations.
AttrDashConfigurationManifestEndpointPrefix() *string
// The URL that is used to initiate a playback session for devices that support Apple HLS.
//
// The session uses server-side reporting.
AttrHlsConfigurationManifestEndpointPrefix() *string
// The Amazon Resource Name (ARN) for the playback configuration.
AttrPlaybackConfigurationArn() *string
// The URL that the player accesses to get a manifest from MediaTailor .
//
// This session will use server-side reporting.
AttrPlaybackEndpointPrefix() *string
// The URL that the player uses to initialize a session that uses client-side reporting.
AttrSessionInitializationEndpointPrefix() *string
// The configuration for avail suppression, also known as ad suppression.
AvailSuppression() interface{}
SetAvailSuppression(val interface{})
// The configuration for bumpers.
Bumper() interface{}
SetBumper(val interface{})
// The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
CdnConfiguration() interface{}
SetCdnConfiguration(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The player parameters and aliases used as dynamic variables during session initialization.
ConfigurationAliases() interface{}
SetConfigurationAliases(val interface{})
// 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 DASH PUT operations.
DashConfiguration() interface{}
SetDashConfiguration(val interface{})
// The configuration for HLS content.
HlsConfiguration() interface{}
SetHlsConfiguration(val interface{})
// The configuration for pre-roll ad insertion.
LivePreRollConfiguration() interface{}
SetLivePreRollConfiguration(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 configuration for manifest processing rules.
ManifestProcessingRules() interface{}
SetManifestProcessingRules(val interface{})
// The identifier for the playback configuration.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
PersonalizationThresholdSeconds() *float64
SetPersonalizationThresholdSeconds(val *float64)
// 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 URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
SlateAdUrl() *string
SetSlateAdUrl(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to assign to the playback configuration.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The name that is used to associate this playback configuration with a custom transcode profile.
TranscodeProfileName() *string
SetTranscodeProfileName(val *string)
// 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{}
// The URL prefix for the parent manifest for the stream, minus the asset ID.
VideoContentSourceUrl() *string
SetVideoContentSourceUrl(val *string)
// 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{})
}
Adds a new playback configuration to AWS Elemental MediaTailor .
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 configurationAliases interface{}
cfnPlaybackConfiguration := awscdk.Aws_mediatailor.NewCfnPlaybackConfiguration(this, jsii.String("MyCfnPlaybackConfiguration"), &CfnPlaybackConfigurationProps{
AdDecisionServerUrl: jsii.String("adDecisionServerUrl"),
Name: jsii.String("name"),
VideoContentSourceUrl: jsii.String("videoContentSourceUrl"),
// the properties below are optional
AvailSuppression: &AvailSuppressionProperty{
Mode: jsii.String("mode"),
Value: jsii.String("value"),
},
Bumper: &BumperProperty{
EndUrl: jsii.String("endUrl"),
StartUrl: jsii.String("startUrl"),
},
CdnConfiguration: &CdnConfigurationProperty{
AdSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
ContentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
},
ConfigurationAliases: map[string]interface{}{
"configurationAliasesKey": configurationAliases,
},
DashConfiguration: &DashConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
MpdLocation: jsii.String("mpdLocation"),
OriginManifestType: jsii.String("originManifestType"),
},
HlsConfiguration: &HlsConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
},
LivePreRollConfiguration: &LivePreRollConfigurationProperty{
AdDecisionServerUrl: jsii.String("adDecisionServerUrl"),
MaxDurationSeconds: jsii.Number(123),
},
ManifestProcessingRules: &ManifestProcessingRulesProperty{
AdMarkerPassthrough: &AdMarkerPassthroughProperty{
Enabled: jsii.Boolean(false),
},
},
PersonalizationThresholdSeconds: jsii.Number(123),
SlateAdUrl: jsii.String("slateAdUrl"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TranscodeProfileName: jsii.String("transcodeProfileName"),
})
func NewCfnPlaybackConfiguration ¶
func NewCfnPlaybackConfiguration(scope constructs.Construct, id *string, props *CfnPlaybackConfigurationProps) CfnPlaybackConfiguration
type CfnPlaybackConfigurationProps ¶
type CfnPlaybackConfigurationProps struct {
// The URL for the ad decision server (ADS).
//
// This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverurl
//
AdDecisionServerUrl *string `field:"required" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"`
// The identifier for the playback configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The URL prefix for the parent manifest for the stream, minus the asset ID.
//
// The maximum length is 512 characters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-videocontentsourceurl
//
VideoContentSourceUrl *string `field:"required" json:"videoContentSourceUrl" yaml:"videoContentSourceUrl"`
// The configuration for avail suppression, also known as ad suppression.
//
// For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-availsuppression
//
AvailSuppression interface{} `field:"optional" json:"availSuppression" yaml:"availSuppression"`
// The configuration for bumpers.
//
// Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-bumper
//
Bumper interface{} `field:"optional" json:"bumper" yaml:"bumper"`
// The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration
//
CdnConfiguration interface{} `field:"optional" json:"cdnConfiguration" yaml:"cdnConfiguration"`
// The player parameters and aliases used as dynamic variables during session initialization.
//
// For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-configurationaliases
//
ConfigurationAliases interface{} `field:"optional" json:"configurationAliases" yaml:"configurationAliases"`
// The configuration for DASH PUT operations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration
//
DashConfiguration interface{} `field:"optional" json:"dashConfiguration" yaml:"dashConfiguration"`
// The configuration for HLS content.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration
//
HlsConfiguration interface{} `field:"optional" json:"hlsConfiguration" yaml:"hlsConfiguration"`
// The configuration for pre-roll ad insertion.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration
//
LivePreRollConfiguration interface{} `field:"optional" json:"livePreRollConfiguration" yaml:"livePreRollConfiguration"`
// The configuration for manifest processing rules.
//
// Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules
//
ManifestProcessingRules interface{} `field:"optional" json:"manifestProcessingRules" yaml:"manifestProcessingRules"`
// Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
//
// If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-personalizationthresholdseconds
//
PersonalizationThresholdSeconds *float64 `field:"optional" json:"personalizationThresholdSeconds" yaml:"personalizationThresholdSeconds"`
// The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
//
// AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-slateadurl
//
SlateAdUrl *string `field:"optional" json:"slateAdUrl" yaml:"slateAdUrl"`
// The tags to assign to the playback configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The name that is used to associate this playback configuration with a custom transcode profile.
//
// This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-transcodeprofilename
//
TranscodeProfileName *string `field:"optional" json:"transcodeProfileName" yaml:"transcodeProfileName"`
}
Properties for defining a `CfnPlaybackConfiguration`.
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 configurationAliases interface{}
cfnPlaybackConfigurationProps := &CfnPlaybackConfigurationProps{
AdDecisionServerUrl: jsii.String("adDecisionServerUrl"),
Name: jsii.String("name"),
VideoContentSourceUrl: jsii.String("videoContentSourceUrl"),
// the properties below are optional
AvailSuppression: &AvailSuppressionProperty{
Mode: jsii.String("mode"),
Value: jsii.String("value"),
},
Bumper: &BumperProperty{
EndUrl: jsii.String("endUrl"),
StartUrl: jsii.String("startUrl"),
},
CdnConfiguration: &CdnConfigurationProperty{
AdSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
ContentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
},
ConfigurationAliases: map[string]interface{}{
"configurationAliasesKey": configurationAliases,
},
DashConfiguration: &DashConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
MpdLocation: jsii.String("mpdLocation"),
OriginManifestType: jsii.String("originManifestType"),
},
HlsConfiguration: &HlsConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
},
LivePreRollConfiguration: &LivePreRollConfigurationProperty{
AdDecisionServerUrl: jsii.String("adDecisionServerUrl"),
MaxDurationSeconds: jsii.Number(123),
},
ManifestProcessingRules: &ManifestProcessingRulesProperty{
AdMarkerPassthrough: &AdMarkerPassthroughProperty{
Enabled: jsii.Boolean(false),
},
},
PersonalizationThresholdSeconds: jsii.Number(123),
SlateAdUrl: jsii.String("slateAdUrl"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TranscodeProfileName: jsii.String("transcodeProfileName"),
}
type CfnPlaybackConfiguration_AdMarkerPassthroughProperty ¶
type CfnPlaybackConfiguration_AdMarkerPassthroughProperty struct {
// Enables ad marker passthrough for your configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html#cfn-mediatailor-playbackconfiguration-admarkerpassthrough-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
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"
adMarkerPassthroughProperty := &AdMarkerPassthroughProperty{
Enabled: jsii.Boolean(false),
}
type CfnPlaybackConfiguration_AvailSuppressionProperty ¶
type CfnPlaybackConfiguration_AvailSuppressionProperty struct {
// Sets the ad suppression mode.
//
// By default, ad suppression is set to OFF and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-mode
//
Mode *string `field:"optional" json:"mode" yaml:"mode"`
// A live edge offset time in HH:MM:SS.
//
// MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
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"
availSuppressionProperty := &AvailSuppressionProperty{
Mode: jsii.String("mode"),
Value: jsii.String("value"),
}
type CfnPlaybackConfiguration_BumperProperty ¶
type CfnPlaybackConfiguration_BumperProperty struct {
// The URL for the end bumper asset.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-endurl
//
EndUrl *string `field:"optional" json:"endUrl" yaml:"endUrl"`
// The URL for the start bumper asset.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-starturl
//
StartUrl *string `field:"optional" json:"startUrl" yaml:"startUrl"`
}
The configuration for bumpers.
Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
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"
bumperProperty := &BumperProperty{
EndUrl: jsii.String("endUrl"),
StartUrl: jsii.String("startUrl"),
}
type CfnPlaybackConfiguration_CdnConfigurationProperty ¶
type CfnPlaybackConfiguration_CdnConfigurationProperty struct {
// A non-default content delivery network (CDN) to serve ad segments.
//
// By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-adsegmenturlprefix
//
AdSegmentUrlPrefix *string `field:"optional" json:"adSegmentUrlPrefix" yaml:"adSegmentUrlPrefix"`
// A content delivery network (CDN) to cache content segments, so that content requests don't always have to go to the origin server.
//
// First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-contentsegmenturlprefix
//
ContentSegmentUrlPrefix *string `field:"optional" json:"contentSegmentUrlPrefix" yaml:"contentSegmentUrlPrefix"`
}
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
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"
cdnConfigurationProperty := &CdnConfigurationProperty{
AdSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
ContentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
}
type CfnPlaybackConfiguration_DashConfigurationProperty ¶ added in v2.25.0
type CfnPlaybackConfiguration_DashConfigurationProperty struct {
// The URL generated by MediaTailor to initiate a playback session.
//
// The session uses server-side reporting. This setting is ignored in PUT operations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-manifestendpointprefix
//
ManifestEndpointPrefix *string `field:"optional" json:"manifestEndpointPrefix" yaml:"manifestEndpointPrefix"`
// The setting that controls whether MediaTailor includes the Location tag in DASH manifests.
//
// MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are `DISABLED` and `EMT_DEFAULT` . The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-mpdlocation
//
MpdLocation *string `field:"optional" json:"mpdLocation" yaml:"mpdLocation"`
// The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests.
//
// If your origin server produces single-period manifests, set this to `SINGLE_PERIOD` . The default setting is `MULTI_PERIOD` . For multi-period manifests, omit this setting or set it to `MULTI_PERIOD` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-originmanifesttype
//
OriginManifestType *string `field:"optional" json:"originManifestType" yaml:"originManifestType"`
}
The configuration for DASH 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"
dashConfigurationProperty := &DashConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
MpdLocation: jsii.String("mpdLocation"),
OriginManifestType: jsii.String("originManifestType"),
}
type CfnPlaybackConfiguration_HlsConfigurationProperty ¶ added in v2.25.0
type CfnPlaybackConfiguration_HlsConfigurationProperty struct {
// The URL that is used to initiate a playback session for devices that support Apple HLS.
//
// The session uses server-side reporting.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration-manifestendpointprefix
//
ManifestEndpointPrefix *string `field:"optional" json:"manifestEndpointPrefix" yaml:"manifestEndpointPrefix"`
}
The configuration for HLS 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"
hlsConfigurationProperty := &HlsConfigurationProperty{
ManifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
}
type CfnPlaybackConfiguration_LivePreRollConfigurationProperty ¶
type CfnPlaybackConfiguration_LivePreRollConfigurationProperty struct {
// The URL for the ad decision server (ADS) for pre-roll ads.
//
// This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-addecisionserverurl
//
AdDecisionServerUrl *string `field:"optional" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"`
// The maximum allowed duration for the pre-roll ad avail.
//
// AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-maxdurationseconds
//
MaxDurationSeconds *float64 `field:"optional" json:"maxDurationSeconds" yaml:"maxDurationSeconds"`
}
The configuration for pre-roll ad insertion.
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"
livePreRollConfigurationProperty := &LivePreRollConfigurationProperty{
AdDecisionServerUrl: jsii.String("adDecisionServerUrl"),
MaxDurationSeconds: jsii.Number(123),
}
type CfnPlaybackConfiguration_ManifestProcessingRulesProperty ¶
type CfnPlaybackConfiguration_ManifestProcessingRulesProperty struct {
// For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
//
// No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules-admarkerpassthrough
//
AdMarkerPassthrough interface{} `field:"optional" json:"adMarkerPassthrough" yaml:"adMarkerPassthrough"`
}
The configuration for manifest processing rules.
Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
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"
manifestProcessingRulesProperty := &ManifestProcessingRulesProperty{
AdMarkerPassthrough: &AdMarkerPassthroughProperty{
Enabled: jsii.Boolean(false),
},
}
type CfnSourceLocation ¶ added in v2.91.0
type CfnSourceLocation interface {
awscdk.CfnResource
awscdk.IInspectable
// <p>Access configuration parameters.</p>.
AccessConfiguration() interface{}
SetAccessConfiguration(val interface{})
// <p>The ARN of the source location.</p>.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *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
// <p>The optional configuration for a server that serves segments.
DefaultSegmentDeliveryConfiguration() interface{}
SetDefaultSegmentDeliveryConfiguration(val interface{})
// <p>The HTTP configuration for the source location.</p>.
HttpConfiguration() interface{}
SetHttpConfiguration(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 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
// <p>A list of the segment delivery configurations associated with this resource.</p>.
SegmentDeliveryConfigurations() interface{}
SetSegmentDeliveryConfigurations(val interface{})
SourceLocationName() *string
SetSourceLocationName(val *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 to assign to the source location.
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{})
}
Definition of AWS::MediaTailor::SourceLocation Resource Type.
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"
cfnSourceLocation := awscdk.Aws_mediatailor.NewCfnSourceLocation(this, jsii.String("MyCfnSourceLocation"), &CfnSourceLocationProps{
HttpConfiguration: &HttpConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
},
SourceLocationName: jsii.String("sourceLocationName"),
// the properties below are optional
AccessConfiguration: &AccessConfigurationProperty{
AccessType: jsii.String("accessType"),
SecretsManagerAccessTokenConfiguration: &SecretsManagerAccessTokenConfigurationProperty{
HeaderName: jsii.String("headerName"),
SecretArn: jsii.String("secretArn"),
SecretStringKey: jsii.String("secretStringKey"),
},
},
DefaultSegmentDeliveryConfiguration: &DefaultSegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
},
SegmentDeliveryConfigurations: []interface{}{
&SegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
Name: jsii.String("name"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnSourceLocation ¶ added in v2.91.0
func NewCfnSourceLocation(scope constructs.Construct, id *string, props *CfnSourceLocationProps) CfnSourceLocation
type CfnSourceLocationProps ¶ added in v2.91.0
type CfnSourceLocationProps struct {
// <p>The HTTP configuration for the source location.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-httpconfiguration
//
HttpConfiguration interface{} `field:"required" json:"httpConfiguration" yaml:"httpConfiguration"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-sourcelocationname
//
SourceLocationName *string `field:"required" json:"sourceLocationName" yaml:"sourceLocationName"`
// <p>Access configuration parameters.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-accessconfiguration
//
AccessConfiguration interface{} `field:"optional" json:"accessConfiguration" yaml:"accessConfiguration"`
// <p>The optional configuration for a server that serves segments.
//
// Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration
//
DefaultSegmentDeliveryConfiguration interface{} `field:"optional" json:"defaultSegmentDeliveryConfiguration" yaml:"defaultSegmentDeliveryConfiguration"`
// <p>A list of the segment delivery configurations associated with this resource.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfigurations
//
SegmentDeliveryConfigurations interface{} `field:"optional" json:"segmentDeliveryConfigurations" yaml:"segmentDeliveryConfigurations"`
// The tags to assign to the source location.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSourceLocation`.
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"
cfnSourceLocationProps := &CfnSourceLocationProps{
HttpConfiguration: &HttpConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
},
SourceLocationName: jsii.String("sourceLocationName"),
// the properties below are optional
AccessConfiguration: &AccessConfigurationProperty{
AccessType: jsii.String("accessType"),
SecretsManagerAccessTokenConfiguration: &SecretsManagerAccessTokenConfigurationProperty{
HeaderName: jsii.String("headerName"),
SecretArn: jsii.String("secretArn"),
SecretStringKey: jsii.String("secretStringKey"),
},
},
DefaultSegmentDeliveryConfiguration: &DefaultSegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
},
SegmentDeliveryConfigurations: []interface{}{
&SegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
Name: jsii.String("name"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnSourceLocation_AccessConfigurationProperty ¶ added in v2.91.0
type CfnSourceLocation_AccessConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-accesstype
//
AccessType *string `field:"optional" json:"accessType" yaml:"accessType"`
// <p>AWS Secrets Manager access token configuration parameters.
//
// For information about Secrets Manager access token authentication, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html">Working with AWS Secrets Manager access token authentication</a>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-secretsmanageraccesstokenconfiguration
//
SecretsManagerAccessTokenConfiguration interface{} `field:"optional" json:"secretsManagerAccessTokenConfiguration" yaml:"secretsManagerAccessTokenConfiguration"`
}
<p>Access configuration parameters.</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"
accessConfigurationProperty := &AccessConfigurationProperty{
AccessType: jsii.String("accessType"),
SecretsManagerAccessTokenConfiguration: &SecretsManagerAccessTokenConfigurationProperty{
HeaderName: jsii.String("headerName"),
SecretArn: jsii.String("secretArn"),
SecretStringKey: jsii.String("secretStringKey"),
},
}
type CfnSourceLocation_DefaultSegmentDeliveryConfigurationProperty ¶ added in v2.91.0
type CfnSourceLocation_DefaultSegmentDeliveryConfigurationProperty struct {
// <p>The hostname of the server that will be used to serve segments.
//
// This string must include the protocol, such as <b>https://</b>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration-baseurl
//
BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
}
<p>The optional configuration for a server that serves segments.
Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.</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"
defaultSegmentDeliveryConfigurationProperty := &DefaultSegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
}
type CfnSourceLocation_HttpConfigurationProperty ¶ added in v2.91.0
type CfnSourceLocation_HttpConfigurationProperty struct {
// <p>The base URL for the source location host server.
//
// This string must include the protocol, such as <b>https://</b>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html#cfn-mediatailor-sourcelocation-httpconfiguration-baseurl
//
BaseUrl *string `field:"required" json:"baseUrl" yaml:"baseUrl"`
}
<p>The HTTP configuration for the source location.</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"
httpConfigurationProperty := &HttpConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
}
type CfnSourceLocation_SecretsManagerAccessTokenConfigurationProperty ¶ added in v2.91.0
type CfnSourceLocation_SecretsManagerAccessTokenConfigurationProperty struct {
// <p>The name of the HTTP header used to supply the access token in requests to the source location.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-headername
//
HeaderName *string `field:"optional" json:"headerName" yaml:"headerName"`
// <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretarn
//
SecretArn *string `field:"optional" json:"secretArn" yaml:"secretArn"`
// <p>The AWS Secrets Manager <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html">SecretString</a> key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretstringkey
//
SecretStringKey *string `field:"optional" json:"secretStringKey" yaml:"secretStringKey"`
}
<p>AWS Secrets Manager access token configuration parameters.
For information about Secrets Manager access token authentication, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html">Working with AWS Secrets Manager access token authentication</a>.</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"
secretsManagerAccessTokenConfigurationProperty := &SecretsManagerAccessTokenConfigurationProperty{
HeaderName: jsii.String("headerName"),
SecretArn: jsii.String("secretArn"),
SecretStringKey: jsii.String("secretStringKey"),
}
type CfnSourceLocation_SegmentDeliveryConfigurationProperty ¶ added in v2.91.0
type CfnSourceLocation_SegmentDeliveryConfigurationProperty struct {
// <p>The base URL of the host or path of the segment delivery server that you're using to serve segments.
//
// This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as <code>https://example.com/some/path</code>. To use a relative URL specify the relative path, such as <code>/some/path*</code>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-baseurl
//
BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
// <p>A unique identifier used to distinguish between multiple segment delivery configurations in a source location.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
}
<p>The segment delivery configuration settings.</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"
segmentDeliveryConfigurationProperty := &SegmentDeliveryConfigurationProperty{
BaseUrl: jsii.String("baseUrl"),
Name: jsii.String("name"),
}
type CfnVodSource ¶ added in v2.93.0
type CfnVodSource interface {
awscdk.CfnResource
awscdk.IInspectable
// <p>The ARN of the VOD source.</p>.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *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
// <p>A list of HTTP package configuration parameters for this VOD source.</p>.
HttpPackageConfigurations() interface{}
SetHttpPackageConfigurations(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 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
SourceLocationName() *string
SetSourceLocationName(val *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 to assign to the VOD source.
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{}
VodSourceName() *string
SetVodSourceName(val *string)
// 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{})
}
Definition of AWS::MediaTailor::VodSource Resource Type.
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"
cfnVodSource := awscdk.Aws_mediatailor.NewCfnVodSource(this, jsii.String("MyCfnVodSource"), &CfnVodSourceProps{
HttpPackageConfigurations: []interface{}{
&HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
},
},
SourceLocationName: jsii.String("sourceLocationName"),
VodSourceName: jsii.String("vodSourceName"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnVodSource ¶ added in v2.93.0
func NewCfnVodSource(scope constructs.Construct, id *string, props *CfnVodSourceProps) CfnVodSource
type CfnVodSourceProps ¶ added in v2.93.0
type CfnVodSourceProps struct {
// <p>A list of HTTP package configuration parameters for this VOD source.</p>.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-httppackageconfigurations
//
HttpPackageConfigurations interface{} `field:"required" json:"httpPackageConfigurations" yaml:"httpPackageConfigurations"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-sourcelocationname
//
SourceLocationName *string `field:"required" json:"sourceLocationName" yaml:"sourceLocationName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-vodsourcename
//
VodSourceName *string `field:"required" json:"vodSourceName" yaml:"vodSourceName"`
// The tags to assign to the VOD source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVodSource`.
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"
cfnVodSourceProps := &CfnVodSourceProps{
HttpPackageConfigurations: []interface{}{
&HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
},
},
SourceLocationName: jsii.String("sourceLocationName"),
VodSourceName: jsii.String("vodSourceName"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnVodSource_HttpPackageConfigurationProperty ¶ added in v2.93.0
type CfnVodSource_HttpPackageConfigurationProperty struct {
// <p>The relative path to the URL for this VOD source.
//
// This is combined with <code>SourceLocation::HttpConfiguration::BaseUrl</code> to form a valid URL.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-path
//
Path *string `field:"required" json:"path" yaml:"path"`
// <p>The name of the source group.
//
// This has to match one of the <code>Channel::Outputs::SourceGroup</code>.</p>
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-sourcegroup
//
SourceGroup *string `field:"required" json:"sourceGroup" yaml:"sourceGroup"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
<p>The HTTP package configuration properties for the requested VOD source.</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"
httpPackageConfigurationProperty := &HttpPackageConfigurationProperty{
Path: jsii.String("path"),
SourceGroup: jsii.String("sourceGroup"),
Type: jsii.String("type"),
}
Source Files
¶
- CfnChannel.go
- CfnChannelPolicy.go
- CfnChannelPolicyProps.go
- CfnChannelPolicy__checks.go
- CfnChannelProps.go
- CfnChannel_DashPlaylistSettingsProperty.go
- CfnChannel_HlsPlaylistSettingsProperty.go
- CfnChannel_LogConfigurationForChannelProperty.go
- CfnChannel_RequestOutputItemProperty.go
- CfnChannel_SlateSourceProperty.go
- CfnChannel__checks.go
- CfnLiveSource.go
- CfnLiveSourceProps.go
- CfnLiveSource_HttpPackageConfigurationProperty.go
- CfnLiveSource__checks.go
- CfnPlaybackConfiguration.go
- CfnPlaybackConfigurationProps.go
- CfnPlaybackConfiguration_AdMarkerPassthroughProperty.go
- CfnPlaybackConfiguration_AvailSuppressionProperty.go
- CfnPlaybackConfiguration_BumperProperty.go
- CfnPlaybackConfiguration_CdnConfigurationProperty.go
- CfnPlaybackConfiguration_DashConfigurationProperty.go
- CfnPlaybackConfiguration_HlsConfigurationProperty.go
- CfnPlaybackConfiguration_LivePreRollConfigurationProperty.go
- CfnPlaybackConfiguration_ManifestProcessingRulesProperty.go
- CfnPlaybackConfiguration__checks.go
- CfnSourceLocation.go
- CfnSourceLocationProps.go
- CfnSourceLocation_AccessConfigurationProperty.go
- CfnSourceLocation_DefaultSegmentDeliveryConfigurationProperty.go
- CfnSourceLocation_HttpConfigurationProperty.go
- CfnSourceLocation_SecretsManagerAccessTokenConfigurationProperty.go
- CfnSourceLocation_SegmentDeliveryConfigurationProperty.go
- CfnSourceLocation__checks.go
- CfnVodSource.go
- CfnVodSourceProps.go
- CfnVodSource_HttpPackageConfigurationProperty.go
- CfnVodSource__checks.go
- main.go