AWS::MediaConnect::Gateway - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::MediaConnect::Gateway

The AWS::MediaConnect::Gateway resource is used to create a new gateway. AWS Elemental MediaConnect Gateway is a feature of MediaConnect that allows the deployment of on-premises resources for transporting live video to and from the AWS Cloud. MediaConnect Gateway allows you to contribute live video to the AWS Cloud from on-premises hardware, as well as distribute live video from the AWS Cloud to your local data center.

Syntax

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

JSON

{
  "Type" : "AWS::MediaConnect::Gateway",
  "Properties" : {
      "EgressCidrBlocks" : [ String, ... ],
      "Name" : String,
      "Networks" : [ GatewayNetwork, ... ]
    }
}

YAML

Type: AWS::MediaConnect::Gateway
Properties:
  EgressCidrBlocks: 
    - String
  Name: String
  Networks: 
    - GatewayNetwork

Properties

EgressCidrBlocks

The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Required: Yes

Type: Array of String

Update requires: Replacement

Name

The name of the network. This name is used to reference the network and must be unique among networks in this gateway.

Required: Yes

Type: String

Update requires: Replacement

Networks

The list of networks that you want to add.

Required: Yes

Type: Array of GatewayNetwork

Minimum: 1

Maximum: 4

Update requires: Replacement

Return values

Ref

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

{ "Ref": "arn:aws:mediaconnect:us-east-1:111122223333:gateway:1-23aBC45dEF67hiJ8-12AbC34DE5fG:WestOffice" }

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.

GatewayArn

The Amazon Resource Name (ARN) of the gateway.

GatewayState

The current state of the gateway. Possible values are: CREATING, ACTIVE, UPDATING, ERROR, DELETING, DELETED.