awscdk-mediatailor-cloudfront-construct
Version:
CDK Construct to associate MediaTailor config with CloudFront distribution
588 lines (354 loc) • 21.4 kB
Markdown
# API Reference <a name="API Reference" id="api-reference"></a>
## Constructs <a name="Constructs" id="Constructs"></a>
### CloudFront <a name="CloudFront" id="awscdk-mediatailor-cloudfront-construct.CloudFront"></a>
#### Initializers <a name="Initializers" id="awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer"></a>
```typescript
import { CloudFront } from 'awscdk-mediatailor-cloudfront-construct'
new CloudFront(scope: Construct, id: string, __2: CloudFrontProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.__2">__2</a></code> | <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFrontProps">CloudFrontProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.id"></a>
- *Type:* string
---
##### `__2`<sup>Required</sup> <a name="__2" id="awscdk-mediatailor-cloudfront-construct.CloudFront.Initializer.parameter.__2"></a>
- *Type:* <a href="#awscdk-mediatailor-cloudfront-construct.CloudFrontProps">CloudFrontProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.toString">toString</a></code> | Returns a string representation of this construct. |
---
##### `toString` <a name="toString" id="awscdk-mediatailor-cloudfront-construct.CloudFront.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="awscdk-mediatailor-cloudfront-construct.CloudFront.isConstruct"></a>
```typescript
import { CloudFront } from 'awscdk-mediatailor-cloudfront-construct'
CloudFront.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="awscdk-mediatailor-cloudfront-construct.CloudFront.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront.property.distribution">distribution</a></code> | <code>aws-cdk-lib.aws_cloudfront.Distribution</code> | *No description.* |
---
##### `node`<sup>Required</sup> <a name="node" id="awscdk-mediatailor-cloudfront-construct.CloudFront.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `distribution`<sup>Required</sup> <a name="distribution" id="awscdk-mediatailor-cloudfront-construct.CloudFront.property.distribution"></a>
```typescript
public readonly distribution: Distribution;
```
- *Type:* aws-cdk-lib.aws_cloudfront.Distribution
---
### MediaTailor <a name="MediaTailor" id="awscdk-mediatailor-cloudfront-construct.MediaTailor"></a>
#### Initializers <a name="Initializers" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer"></a>
```typescript
import { MediaTailor } from 'awscdk-mediatailor-cloudfront-construct'
new MediaTailor(scope: Construct, id: string, __2: MediaTailorProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.__2">__2</a></code> | <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps">MediaTailorProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.id"></a>
- *Type:* string
---
##### `__2`<sup>Required</sup> <a name="__2" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.Initializer.parameter.__2"></a>
- *Type:* <a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps">MediaTailorProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.toString">toString</a></code> | Returns a string representation of this construct. |
---
##### `toString` <a name="toString" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.isConstruct"></a>
```typescript
import { MediaTailor } from 'awscdk-mediatailor-cloudfront-construct'
MediaTailor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor.property.config">config</a></code> | <code>aws-cdk-lib.aws_mediatailor.CfnPlaybackConfiguration</code> | *No description.* |
---
##### `node`<sup>Required</sup> <a name="node" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `config`<sup>Required</sup> <a name="config" id="awscdk-mediatailor-cloudfront-construct.MediaTailor.property.config"></a>
```typescript
public readonly config: CfnPlaybackConfiguration;
```
- *Type:* aws-cdk-lib.aws_mediatailor.CfnPlaybackConfiguration
---
### MediaTailorWithCloudFront <a name="MediaTailorWithCloudFront" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront"></a>
#### Initializers <a name="Initializers" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer"></a>
```typescript
import { MediaTailorWithCloudFront } from 'awscdk-mediatailor-cloudfront-construct'
new MediaTailorWithCloudFront(scope: Construct, id: string, __2: MediaTailorWithCloudFrontProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.__2">__2</a></code> | <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps">MediaTailorWithCloudFrontProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.id"></a>
- *Type:* string
---
##### `__2`<sup>Required</sup> <a name="__2" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.Initializer.parameter.__2"></a>
- *Type:* <a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps">MediaTailorWithCloudFrontProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.toString">toString</a></code> | Returns a string representation of this construct. |
---
##### `toString` <a name="toString" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.isConstruct"></a>
```typescript
import { MediaTailorWithCloudFront } from 'awscdk-mediatailor-cloudfront-construct'
MediaTailorWithCloudFront.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.emt">emt</a></code> | <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor">MediaTailor</a></code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.cf">cf</a></code> | <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFront">CloudFront</a></code> | *No description.* |
---
##### `node`<sup>Required</sup> <a name="node" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `emt`<sup>Required</sup> <a name="emt" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.emt"></a>
```typescript
public readonly emt: MediaTailor;
```
- *Type:* <a href="#awscdk-mediatailor-cloudfront-construct.MediaTailor">MediaTailor</a>
---
##### `cf`<sup>Optional</sup> <a name="cf" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFront.property.cf"></a>
```typescript
public readonly cf: CloudFront;
```
- *Type:* <a href="#awscdk-mediatailor-cloudfront-construct.CloudFront">CloudFront</a>
---
## Structs <a name="Structs" id="Structs"></a>
### CloudFrontProps <a name="CloudFrontProps" id="awscdk-mediatailor-cloudfront-construct.CloudFrontProps"></a>
#### Initializer <a name="Initializer" id="awscdk-mediatailor-cloudfront-construct.CloudFrontProps.Initializer"></a>
```typescript
import { CloudFrontProps } from 'awscdk-mediatailor-cloudfront-construct'
const cloudFrontProps: CloudFrontProps = { ... }
```
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.mediaTailorEndpointUrl">mediaTailorEndpointUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.videoContentSourceUrl">videoContentSourceUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.adSegmentSourceUrl">adSegmentSourceUrl</a></code> | <code>string</code> | *No description.* |
---
##### `mediaTailorEndpointUrl`<sup>Required</sup> <a name="mediaTailorEndpointUrl" id="awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.mediaTailorEndpointUrl"></a>
```typescript
public readonly mediaTailorEndpointUrl: string;
```
- *Type:* string
---
##### `videoContentSourceUrl`<sup>Required</sup> <a name="videoContentSourceUrl" id="awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.videoContentSourceUrl"></a>
```typescript
public readonly videoContentSourceUrl: string;
```
- *Type:* string
---
##### `adSegmentSourceUrl`<sup>Optional</sup> <a name="adSegmentSourceUrl" id="awscdk-mediatailor-cloudfront-construct.CloudFrontProps.property.adSegmentSourceUrl"></a>
```typescript
public readonly adSegmentSourceUrl: string;
```
- *Type:* string
---
### MediaTailorProps <a name="MediaTailorProps" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps"></a>
#### Initializer <a name="Initializer" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.Initializer"></a>
```typescript
import { MediaTailorProps } from 'awscdk-mediatailor-cloudfront-construct'
const mediaTailorProps: MediaTailorProps = { ... }
```
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.adDecisionServerUrl">adDecisionServerUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.videoContentSourceUrl">videoContentSourceUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.configurationAliases">configurationAliases</a></code> | <code>object</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.prerollAdUrl">prerollAdUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.slateAdUrl">slateAdUrl</a></code> | <code>string</code> | *No description.* |
---
##### `adDecisionServerUrl`<sup>Required</sup> <a name="adDecisionServerUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.adDecisionServerUrl"></a>
```typescript
public readonly adDecisionServerUrl: string;
```
- *Type:* string
---
##### `videoContentSourceUrl`<sup>Required</sup> <a name="videoContentSourceUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.videoContentSourceUrl"></a>
```typescript
public readonly videoContentSourceUrl: string;
```
- *Type:* string
---
##### `configurationAliases`<sup>Optional</sup> <a name="configurationAliases" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.configurationAliases"></a>
```typescript
public readonly configurationAliases: object;
```
- *Type:* object
---
##### `prerollAdUrl`<sup>Optional</sup> <a name="prerollAdUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.prerollAdUrl"></a>
```typescript
public readonly prerollAdUrl: string;
```
- *Type:* string
---
##### `slateAdUrl`<sup>Optional</sup> <a name="slateAdUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorProps.property.slateAdUrl"></a>
```typescript
public readonly slateAdUrl: string;
```
- *Type:* string
---
### MediaTailorWithCloudFrontProps <a name="MediaTailorWithCloudFrontProps" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps"></a>
#### Initializer <a name="Initializer" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.Initializer"></a>
```typescript
import { MediaTailorWithCloudFrontProps } from 'awscdk-mediatailor-cloudfront-construct'
const mediaTailorWithCloudFrontProps: MediaTailorWithCloudFrontProps = { ... }
```
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.videoContentSourceUrl">videoContentSourceUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionFunction">adDecisionFunction</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionFunctionApiPath">adDecisionFunctionApiPath</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionServerUrl">adDecisionServerUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adInsertionMode">adInsertionMode</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.configurationAliases">configurationAliases</a></code> | <code>object</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.prerollAdUrl">prerollAdUrl</a></code> | <code>string</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.skipCloudFront">skipCloudFront</a></code> | <code>boolean</code> | *No description.* |
| <code><a href="#awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.slateAdUrl">slateAdUrl</a></code> | <code>string</code> | *No description.* |
---
##### `videoContentSourceUrl`<sup>Required</sup> <a name="videoContentSourceUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.videoContentSourceUrl"></a>
```typescript
public readonly videoContentSourceUrl: string;
```
- *Type:* string
---
##### `adDecisionFunction`<sup>Optional</sup> <a name="adDecisionFunction" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionFunction"></a>
```typescript
public readonly adDecisionFunction: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
---
##### `adDecisionFunctionApiPath`<sup>Optional</sup> <a name="adDecisionFunctionApiPath" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionFunctionApiPath"></a>
```typescript
public readonly adDecisionFunctionApiPath: string;
```
- *Type:* string
---
##### `adDecisionServerUrl`<sup>Optional</sup> <a name="adDecisionServerUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adDecisionServerUrl"></a>
```typescript
public readonly adDecisionServerUrl: string;
```
- *Type:* string
---
##### `adInsertionMode`<sup>Optional</sup> <a name="adInsertionMode" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.adInsertionMode"></a>
```typescript
public readonly adInsertionMode: string;
```
- *Type:* string
---
##### `configurationAliases`<sup>Optional</sup> <a name="configurationAliases" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.configurationAliases"></a>
```typescript
public readonly configurationAliases: object;
```
- *Type:* object
---
##### `prerollAdUrl`<sup>Optional</sup> <a name="prerollAdUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.prerollAdUrl"></a>
```typescript
public readonly prerollAdUrl: string;
```
- *Type:* string
---
##### `skipCloudFront`<sup>Optional</sup> <a name="skipCloudFront" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.skipCloudFront"></a>
```typescript
public readonly skipCloudFront: boolean;
```
- *Type:* boolean
---
##### `slateAdUrl`<sup>Optional</sup> <a name="slateAdUrl" id="awscdk-mediatailor-cloudfront-construct.MediaTailorWithCloudFrontProps.property.slateAdUrl"></a>
```typescript
public readonly slateAdUrl: string;
```
- *Type:* string
---