class SdiSource (construct)
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.MediaLive.Alpha.SdiSource |
Go | github.com/aws/aws-cdk-go/awsmedialivealpha/v2#SdiSource |
Java | software.amazon.awscdk.services.medialive.alpha.SdiSource |
Python | aws_cdk.aws_medialive_alpha.SdiSource |
TypeScript (source) | @aws-cdk/aws-medialive-alpha ยป SdiSource |
Implements
IConstruct, IDependable, IResource, IEnvironment, ISdi, ISdi
Defines an AWS Elemental MediaLive SDI Source.
Example
declare const stack: Stack;
const sdi = new medialive.SdiSource(stack, 'Sdi', {
sdiSourceName: 'camera-1',
type: medialive.SdiType.SINGLE,
});
Initializer
new SdiSource(scope: Construct, id: string, props: SdiSourceProps)
Parameters
- scope
Construct - id
string - props
SdiSource Props
Construct Props
| Name | Type | Description |
|---|---|---|
| type | Sdi | Type of SDI input. |
| mode? | Sdi | SDI Mode, only applicable for QUAD type. |
| sdi | string | The name of the SDI source. |
| tags? | { [string]: string } | Tags to add to the SDI source. |
type
Type:
Sdi
Type of SDI input.
mode?
Type:
Sdi
(optional, default: no mode)
SDI Mode, only applicable for QUAD type.
sdiSourceName?
Type:
string
(optional, default: auto-generated name)
The name of the SDI source.
tags?
Type:
{ [string]: string }
(optional, default: no tagging)
Tags to add to the SDI source.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| sdi | string | The SDI Source ARN. |
| sdi | string | The SDI Source ID. |
| sdi | Sdi | A reference to this SDI Source resource. |
| stack | Stack | The stack in which this resource is defined. |
| sdi | string[] | The list of inputs currently using this SDI source. |
| sdi | string | The current state of the SDI source. |
| static PROPERTY_INJECTION_ID | string | Uniquely identifies this class. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be
different than the stack they were imported into.
node
Type:
Node
The tree node.
sdiSourceArn
Type:
string
The SDI Source ARN.
sdiSourceId
Type:
string
The SDI Source ID.
sdiSourceRef
Type:
Sdi
A reference to this SDI Source resource.
stack
Type:
Stack
The stack in which this resource is defined.
sdiSourceInputs?
Type:
string[]
(optional)
The list of inputs currently using this SDI source.
sdiSourceState?
Type:
string
(optional)
The current state of the SDI source.
static PROPERTY_INJECTION_ID
Type:
string
Uniquely identifies this class.
Methods
| Name | Description |
|---|---|
| apply | Override the cross-stack reference strength for this resource. |
| apply | Apply the given removal policy to this resource. |
| to | Returns a string representation of this construct. |
| with(...mixins) | Applies one or more mixins to this construct. |
| static from | Import an existing SDI source by its attributes. |
applyCrossStackReferenceStrength(strength)
public applyCrossStackReferenceStrength(strength: ReferenceStrength): void
Parameters
- strength
Referenceโ - The reference strength to use for this resource.Strength
Override the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified
mechanism instead of the global default determined by the
@aws-cdk/core:defaultCrossStackReferences context key. This is useful for
selectively weakening specific references to avoid the "deadly embrace" problem
without changing the app-wide default.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
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).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
Parameters
- mixins
IMixin
Returns
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
static fromSdiSourceAttributes(scope, id, attrs)
public static fromSdiSourceAttributes(scope: Construct, id: string, attrs: SdiSourceAttributes): ISdiSource
Parameters
- scope
Construct - id
string - attrs
SdiSource Attributes
Returns
Import an existing SDI source by its attributes.

.NET
Go
Java
Python
TypeScript (