Documentation ¶
Index ¶
- 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 NewCfnPlaybackConfiguration_Override(c CfnPlaybackConfiguration, scope constructs.Construct, id *string, ...)
- type CfnPlaybackConfiguration
- type CfnPlaybackConfigurationProps
- type CfnPlaybackConfiguration_AdMarkerPassthroughProperty
- type CfnPlaybackConfiguration_AvailSuppressionProperty
- type CfnPlaybackConfiguration_BumperProperty
- type CfnPlaybackConfiguration_CdnConfigurationProperty
- type CfnPlaybackConfiguration_DashConfigurationForPutProperty
- type CfnPlaybackConfiguration_LivePreRollConfigurationProperty
- type CfnPlaybackConfiguration_ManifestProcessingRulesProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func NewCfnPlaybackConfiguration_Override ¶
func NewCfnPlaybackConfiguration_Override(c CfnPlaybackConfiguration, scope constructs.Construct, id *string, props *CfnPlaybackConfigurationProps)
Create a new `AWS::MediaTailor::PlaybackConfiguration`.
Types ¶
type CfnPlaybackConfiguration ¶
type CfnPlaybackConfiguration interface { awscdk.CfnResource awscdk.IInspectable // `AWS::MediaTailor::PlaybackConfiguration.AdDecisionServerUrl`. AdDecisionServerUrl() *string SetAdDecisionServerUrl(val *string) // `AWS::MediaTailor::PlaybackConfiguration.AvailSuppression`. AvailSuppression() interface{} SetAvailSuppression(val interface{}) // `AWS::MediaTailor::PlaybackConfiguration.Bumper`. Bumper() interface{} SetBumper(val interface{}) // `AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration`. 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 // `AWS::MediaTailor::PlaybackConfiguration.ConfigurationAliases`. 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 // `AWS::MediaTailor::PlaybackConfiguration.DashConfiguration`. DashConfiguration() interface{} SetDashConfiguration(val interface{}) // `AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration`. 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 // `AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules`. ManifestProcessingRules() interface{} SetManifestProcessingRules(val interface{}) // `AWS::MediaTailor::PlaybackConfiguration.Name`. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // `AWS::MediaTailor::PlaybackConfiguration.PersonalizationThresholdSeconds`. 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 // `AWS::MediaTailor::PlaybackConfiguration.SessionInitializationEndpointPrefix`. SessionInitializationEndpointPrefix() *string SetSessionInitializationEndpointPrefix(val *string) // `AWS::MediaTailor::PlaybackConfiguration.SlateAdUrl`. 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 // `AWS::MediaTailor::PlaybackConfiguration.Tags`. Tags() awscdk.TagManager // `AWS::MediaTailor::PlaybackConfiguration.TranscodeProfileName`. TranscodeProfileName() *string SetTranscodeProfileName(val *string) // 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{} // `AWS::MediaTailor::PlaybackConfiguration.VideoContentSourceUrl`. 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. 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`). 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) 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) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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{}) }
A CloudFormation `AWS::MediaTailor::PlaybackConfiguration`.
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: &dashConfigurationForPutProperty{ mpdLocation: jsii.String("mpdLocation"), originManifestType: jsii.String("originManifestType"), }, livePreRollConfiguration: &livePreRollConfigurationProperty{ adDecisionServerUrl: jsii.String("adDecisionServerUrl"), maxDurationSeconds: jsii.Number(123), }, manifestProcessingRules: &manifestProcessingRulesProperty{ adMarkerPassthrough: &adMarkerPassthroughProperty{ enabled: jsii.Boolean(false), }, }, personalizationThresholdSeconds: jsii.Number(123), sessionInitializationEndpointPrefix: jsii.String("sessionInitializationEndpointPrefix"), 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
Create a new `AWS::MediaTailor::PlaybackConfiguration`.
type CfnPlaybackConfigurationProps ¶
type CfnPlaybackConfigurationProps struct { // `AWS::MediaTailor::PlaybackConfiguration.AdDecisionServerUrl`. AdDecisionServerUrl *string `field:"required" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"` // `AWS::MediaTailor::PlaybackConfiguration.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::MediaTailor::PlaybackConfiguration.VideoContentSourceUrl`. VideoContentSourceUrl *string `field:"required" json:"videoContentSourceUrl" yaml:"videoContentSourceUrl"` // `AWS::MediaTailor::PlaybackConfiguration.AvailSuppression`. AvailSuppression interface{} `field:"optional" json:"availSuppression" yaml:"availSuppression"` // `AWS::MediaTailor::PlaybackConfiguration.Bumper`. Bumper interface{} `field:"optional" json:"bumper" yaml:"bumper"` // `AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration`. CdnConfiguration interface{} `field:"optional" json:"cdnConfiguration" yaml:"cdnConfiguration"` // `AWS::MediaTailor::PlaybackConfiguration.ConfigurationAliases`. ConfigurationAliases interface{} `field:"optional" json:"configurationAliases" yaml:"configurationAliases"` // `AWS::MediaTailor::PlaybackConfiguration.DashConfiguration`. DashConfiguration interface{} `field:"optional" json:"dashConfiguration" yaml:"dashConfiguration"` // `AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration`. LivePreRollConfiguration interface{} `field:"optional" json:"livePreRollConfiguration" yaml:"livePreRollConfiguration"` // `AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules`. ManifestProcessingRules interface{} `field:"optional" json:"manifestProcessingRules" yaml:"manifestProcessingRules"` // `AWS::MediaTailor::PlaybackConfiguration.PersonalizationThresholdSeconds`. PersonalizationThresholdSeconds *float64 `field:"optional" json:"personalizationThresholdSeconds" yaml:"personalizationThresholdSeconds"` // `AWS::MediaTailor::PlaybackConfiguration.SessionInitializationEndpointPrefix`. SessionInitializationEndpointPrefix *string `field:"optional" json:"sessionInitializationEndpointPrefix" yaml:"sessionInitializationEndpointPrefix"` // `AWS::MediaTailor::PlaybackConfiguration.SlateAdUrl`. SlateAdUrl *string `field:"optional" json:"slateAdUrl" yaml:"slateAdUrl"` // `AWS::MediaTailor::PlaybackConfiguration.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // `AWS::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: &dashConfigurationForPutProperty{ mpdLocation: jsii.String("mpdLocation"), originManifestType: jsii.String("originManifestType"), }, livePreRollConfiguration: &livePreRollConfigurationProperty{ adDecisionServerUrl: jsii.String("adDecisionServerUrl"), maxDurationSeconds: jsii.Number(123), }, manifestProcessingRules: &manifestProcessingRulesProperty{ adMarkerPassthrough: &adMarkerPassthroughProperty{ enabled: jsii.Boolean(false), }, }, personalizationThresholdSeconds: jsii.Number(123), sessionInitializationEndpointPrefix: jsii.String("sessionInitializationEndpointPrefix"), 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 {
// `CfnPlaybackConfiguration.AdMarkerPassthroughProperty.Enabled`.
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
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 { // `CfnPlaybackConfiguration.AvailSuppressionProperty.Mode`. Mode *string `field:"optional" json:"mode" yaml:"mode"` // `CfnPlaybackConfiguration.AvailSuppressionProperty.Value`. Value *string `field:"optional" json:"value" yaml:"value"` }
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 { // `CfnPlaybackConfiguration.BumperProperty.EndUrl`. EndUrl *string `field:"optional" json:"endUrl" yaml:"endUrl"` // `CfnPlaybackConfiguration.BumperProperty.StartUrl`. StartUrl *string `field:"optional" json:"startUrl" yaml:"startUrl"` }
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 { // `CfnPlaybackConfiguration.CdnConfigurationProperty.AdSegmentUrlPrefix`. AdSegmentUrlPrefix *string `field:"optional" json:"adSegmentUrlPrefix" yaml:"adSegmentUrlPrefix"` // `CfnPlaybackConfiguration.CdnConfigurationProperty.ContentSegmentUrlPrefix`. ContentSegmentUrlPrefix *string `field:"optional" json:"contentSegmentUrlPrefix" yaml:"contentSegmentUrlPrefix"` }
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_DashConfigurationForPutProperty ¶
type CfnPlaybackConfiguration_DashConfigurationForPutProperty struct { // `CfnPlaybackConfiguration.DashConfigurationForPutProperty.MpdLocation`. MpdLocation *string `field:"optional" json:"mpdLocation" yaml:"mpdLocation"` // `CfnPlaybackConfiguration.DashConfigurationForPutProperty.OriginManifestType`. OriginManifestType *string `field:"optional" json:"originManifestType" yaml:"originManifestType"` }
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" dashConfigurationForPutProperty := &dashConfigurationForPutProperty{ mpdLocation: jsii.String("mpdLocation"), originManifestType: jsii.String("originManifestType"), }
type CfnPlaybackConfiguration_LivePreRollConfigurationProperty ¶
type CfnPlaybackConfiguration_LivePreRollConfigurationProperty struct { // `CfnPlaybackConfiguration.LivePreRollConfigurationProperty.AdDecisionServerUrl`. AdDecisionServerUrl *string `field:"optional" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"` // `CfnPlaybackConfiguration.LivePreRollConfigurationProperty.MaxDurationSeconds`. MaxDurationSeconds *float64 `field:"optional" json:"maxDurationSeconds" yaml:"maxDurationSeconds"` }
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 {
// `CfnPlaybackConfiguration.ManifestProcessingRulesProperty.AdMarkerPassthrough`.
AdMarkerPassthrough interface{} `field:"optional" json:"adMarkerPassthrough" yaml:"adMarkerPassthrough"`
}
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), }, }