AWS::MediaConnect::RouterNetworkInterface - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaConnect::RouterNetworkInterface

The AWS::MediaConnect::RouterNetworkInterface resource defines how the router communicates with the outside world. Each router I/O needs a network interface, which determines how the router I/O connects to other resources and what security measures protect the connection.

You can work with two types of router network interface:

  • Public network interfaces - allow communication over the public internet.

  • VPC network interfaces - allow communication within your Amazon Virtual Private Cloud (VPC).

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::MediaConnect::RouterNetworkInterface", "Properties" : { "Configuration" : RouterNetworkInterfaceConfiguration, "Name" : String, "RegionName" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::MediaConnect::RouterNetworkInterface Properties: Configuration: RouterNetworkInterfaceConfiguration Name: String RegionName: String Tags: - Tag

Properties

Configuration

The configuration settings for a router network interface.

Required: Yes

Type: RouterNetworkInterfaceConfiguration

Update requires: No interruption

Name

The name of the router network interface.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

RegionName

The AWS Region where the router network interface is located.

Required: No

Type: String

Update requires: Replacement

Tags

Key-value pairs that can be used to tag and organize this router network interface.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the router network interface ARN. For example:

{ "Ref": "arn:aws:mediaconnect:us-west-2:111122223333:routerNetworkInterface:00e8efe67aa3" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the router network interface.

AssociatedInputCount

The number of router inputs associated with the network interface.

AssociatedOutputCount

The number of router outputs associated with the network interface.

CreatedAt

The timestamp when the router network interface was created.

Id

The unique identifier of the router network interface.

NetworkInterfaceType

The type of the router network interface.

State

The current state of the router network interface.

UpdatedAt

The timestamp when the router network interface was last updated.