class RouterNetworkInterface (construct)
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.MediaConnect.Alpha.RouterNetworkInterface |
Go | github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#RouterNetworkInterface |
Java | software.amazon.awscdk.services.mediaconnect.alpha.RouterNetworkInterface |
Python | aws_cdk.aws_mediaconnect_alpha.RouterNetworkInterface |
TypeScript (source) | @aws-cdk/aws-mediaconnect-alpha ยป RouterNetworkInterface |
Implements
IConstruct, IDependable, IResource, IEnvironment, IRouter, IRouter
Defines a AWS Elemental MediaConnect Router Network Interface.
Example
declare const stack: Stack;
declare const securityGroup: ec2.ISecurityGroup;
declare const subnet: ec2.ISubnet;
const privateInterface = new RouterNetworkInterface(stack, 'PrivateInterface', {
routerNetworkInterfaceName: 'private-interface',
configuration: RouterNetworkConfiguration.vpc({
securityGroups: [securityGroup],
subnet: subnet,
}),
});
Initializer
new RouterNetworkInterface(scope: Construct, id: string, props: RouterNetworkInterfaceProps)
Parameters
- scope
Construct - id
string - props
RouterNetwork Interface Props
Construct Props
| Name | Type | Description |
|---|---|---|
| configuration | Router | Network configuration for the router network interface. |
| region | string | The AWS Region where the router network interface will be created. |
| router | string | The name of the router network interface. |
| tags? | { [string]: string } | Tags to add to the network interface. |
configuration
Type:
Router
Network configuration for the router network interface.
regionName?
Type:
string
(optional, default: Same region as the stack)
The AWS Region where the router network interface will be created.
routerNetworkInterfaceName?
Type:
string
(optional, default: Generated automatically)
The name of the router network interface.
tags?
Type:
{ [string]: string }
(optional, default: No tagging)
Tags to add to the network interface.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| router | string | The Amazon Resource Name (ARN) of the router network interface. |
| router | string | The unique identifier of the router network interface. |
| router | Router | A reference to a RouterNetworkInterface resource. |
| stack | Stack | The stack in which this resource is defined. |
| created | string | The date and time the router network interface was created. |
| updated | string | The date and time the router network interface was last updated. |
| 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.
routerNetworkInterfaceArn
Type:
string
The Amazon Resource Name (ARN) of the router network interface.
routerNetworkInterfaceId
Type:
string
The unique identifier of the router network interface.
routerNetworkInterfaceRef
Type:
Router
A reference to a RouterNetworkInterface resource.
stack
Type:
Stack
The stack in which this resource is defined.
createdAt?
Type:
string
(optional)
The date and time the router network interface was created.
updatedAt?
Type:
string
(optional)
The date and time the router network interface was last updated.
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 Router Network Interface from its ARN. |
| static from | Import an existing Router Network Interface from 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 fromRouterNetworkInterfaceArn(scope, id, routerNetworkInterfaceArn)
public static fromRouterNetworkInterfaceArn(scope: Construct, id: string, routerNetworkInterfaceArn: string): IRouterNetworkInterface
Parameters
- scope
Constructโ The parent construct. - id
stringโ The construct id. - routerNetworkInterfaceArn
stringโ The ARN of the Router Network Interface.
Returns
Import an existing Router Network Interface from its ARN.
static fromRouterNetworkInterfaceAttributes(scope, id, attrs)
public static fromRouterNetworkInterfaceAttributes(scope: Construct, id: string, attrs: RouterNetworkInterfaceAttributes): IRouterNetworkInterface
Parameters
- scope
Constructโ The parent construct. - id
stringโ The construct id. - attrs
Routerโ The Router Network Interface attributes.Network Interface Attributes
Returns
Import an existing Router Network Interface from its attributes.
Provide routerNetworkInterfaceId when importing an interface that was deployed
externally โ otherwise accessing it on the imported construct will throw.

.NET
Go
Java
Python
TypeScript (